Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Use "Qiskit contributors" as authors in bibtex file #1693

Merged
merged 4 commits into from
Mar 22, 2023

Conversation

Cryoris
Copy link
Collaborator

@Cryoris Cryoris commented Mar 15, 2023

Summary

Replace the author list in the Qiskit.bib file by "Qiskit contributors". Previously discussed in #934.

Details

Note that if this is merged we have to update Qiskit/qiskit-bot to not overwrite the bibfile upon release.

Current status

To cite Qiskit we currently provide the Qiskit.bib file, which has an autogenerated author list including all account names appearing in any commit to one of Qiskit Terra, Aer, Ignis, IBMQ Provider, the applications or the meta package.

This approach has several shortcomings:

  1. Including the bibfile of Qiskit in a paper easily takes up more than a page and includes GitHub usernames. For example, the current first author is A-tA-v, so even if the journal would automatically truncate, we would be cited as A-tA-v et al. Qiskit: ..... There are a lot of these cases in the full list.
  2. Qiskit is a community effort; using Qiskit contributors as author would reflect that explicitly.
  3. Qiskit is a dynamic ecosystem, some central repositories, like Qiskit IBM Runtime or Qiskit Experiments, are not included.
  4. In practice, many (most?) papers manually truncate the author list anyways to avoid taking up 1 page for one citation.

Proposal

By using Qiskit contributors as author name, which is a commonly used approach for large software projects or collaborations (e.g. CERN), we could resolve all of the above issues. On zenodo, we can still reference the author list or just reference GitHub's contributor list.

One concern raised in #934 is that by using Qiskit contributors, contributors would not get credit if Qiskit is cited. However, as long as the proper zenodo link is included (as per our bib file), the citation is correctly detected. To have Qiskit appear in e.g. Google Scholar, the article can always be added manually -- instead of the current opt-out we would move towards an opt-in. Given that many contributors don't have Qiskit in their Google scholar account anyways, this seems like a small drawback while gaining a lot of advantages.

In a nutshell

Pro

  • clean and concise citation (which many papers currently do manually)
  • no problem with usernames as authors
  • reflects the community effort and independent of changes/renamings in the Qiskit ecosystem

Con

  • opt-in for the citation on citation trackers (like Google Scholar) instead of opt-out

Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can also delete the authors list and the corresponding script to generate that file. There isn't really anything useful it provides anymore without the bibtex file

@mrossinek
Copy link
Member

I think we can also delete the authors list and the corresponding script to generate that file. There isn't really anything useful it provides anymore without the bibtex file

I agree with this 👍 Instead of linking to this file as suggsted in the PR description, we could do it similar to how rustworkx does it and refer to the Contributors graph page on Github. Yes, this would currently limit the scope to the core Qiskit repo (i.e. https://github.com/Qiskit/qiskit-terra/graphs/contributors) but more and more Qiskit ecosystem components are setting up their own DOIs via Zenodo (e.g. rustworkx, qiskit-metal) so I do not see this as a big drawback (plus it helps with the "what is Qiskit" question if we encourage submodules to be cited explicitly, too, as Qiskit would only refer to core also in terms of citation purposes)

@Cryoris Cryoris changed the title Use "Qiskit contributors" as bibtex author Use "Qiskit contributors" as authors in bibtex file Mar 15, 2023
@nonhermitian
Copy link
Collaborator

To see why this is most helpful see Ref. 49 of this paper: https://arxiv.org/abs/2303.07660

@jakelishman jakelishman linked an issue Mar 20, 2023 that may be closed by this pull request
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other place you need to update is the https://github.com/Qiskit/qiskit#authors-and-citation which refers to the AUTHORS file still

@Cryoris
Copy link
Collaborator Author

Cryoris commented Mar 21, 2023

The other place you need to update is the https://github.com/Qiskit/qiskit#authors-and-citation which refers to the AUTHORS file still

Removed in 67449be

mtreinish referenced this pull request in Qiskit/qiskit-bot Mar 22, 2023
Part of Qiskit/qiskit#1693: With the change to using Qiskit contributors as author in the Qiskit.bib file,
the author list no longer needs to be regenerated and the bib file shouldn't be overwritten in the
release process. This PR also removes the according tests
@Cryoris Cryoris force-pushed the qiskit-contributors branch from 67449be to 2fd541d Compare March 22, 2023 14:18
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, cleaning this up will make citing qiskit a lot easier for people.

@Cryoris Cryoris merged commit a4728b1 into Qiskit:master Mar 22, 2023
@Cryoris Cryoris deleted the qiskit-contributors branch March 22, 2023 16:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Short version of Qiskit's bibfile
4 participants