docs: add repository citation guidance and metadata#146
docs: add repository citation guidance and metadata#146jake-arkinstall merged 3 commits intomainfrom
Conversation
CITATION.cff
Outdated
| message: "If you use Selene in your work, please cite it using the metadata from this file." | ||
| title: "Selene" | ||
| type: software | ||
| abstract: "Quantinuum's open source emulator for hybrid quantum computation." |
There was a problem hiding this comment.
I believe we are deprecating the use of the word 'hybrid' for this purpose as it is in conflict with the use of the same phrase for HPC-Quantum.
There was a problem hiding this comment.
It was copied over from pyproject.toml, I will update that as well. Though you may need to edit it in the About section of the repo.
There was a problem hiding this comment.
Updated in both places: I changed the CFF abstract and the pyproject description to use "quantum computation" rather than "hybrid quantum computation" so the metadata stays aligned and does not regress.
| @software{selene, | ||
| title = {Selene}, | ||
| author = {Arkinstall, Jake and {TKET development team}}, | ||
| year = {2025}, | ||
| organization = {Quantinuum}, | ||
| url = {https://github.com/Quantinuum/selene}, | ||
| license = {Apache-2.0}, | ||
| } |
There was a problem hiding this comment.
the backwards-compatible version would be:
@misc{selene,
title = {Selene},
author = {Arkinstall, Jake and {TKET development team}},
year = {2025},
howpublished = {\url{https://github.com/Quantinuum/selene}},
}but I prefer the modern version.
qartik
changed the title
|
@jake-arkinstall I believe this is ready to merge, the CI failures are unrelated to this PR. |
2 participants
Summary
CITATION.cfffor GitHub citation supportCitationsection toREADME.mdwith a BibTeX example for repository-level citationpyproject.tomlwith the citation metadataResolves #145