search

iqm-finland / KQCircuits

KLayout Python library for integrated quantum circuit design.
GNU General Public License v3.0
128 stars 71 forks source link

Unable to cite repo #5

Closed HermanniH closed 2 years ago

HermanniH commented 2 years ago

It would be great if there was a citation.cff file such as described here: https://academia.stackexchange.com/a/172780 to be abel to cite the repo in academic texts.

jkotilahti commented 2 years ago

There is already a way to cite KQCircuits, done using Zenodo, see https://iqm-finland.github.io/KQCircuits/citing.html. There is also this badge in the Readme

image

which links to https://zenodo.org/record/5024144.

Let me know if this works for you, and this issue can be closed if so.

alelandra commented 2 years ago

I think he would like some a bibtex and maybe also instructions in the README already made, do you agree @HermanniH ?

nikosavola commented 2 years ago

There is a Citing section in the documentation but of course using the GitHub citation.cff as well would be best. Unfortunately, it would have to be in the root of the repo, as docs/citation.cff or something similar doesn't seem to be allowed (yet), see About CITATION files - Other citation files.

Maybe a Citation section in the README that links to the documentation could be added.

jkotilahti commented 2 years ago

Link to citation instructions was added to README in 76bc0194bd5b766a56d3d5a122f4944e4ff553b2, so closing this now.