Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CITATION.cff file #213

Open
willynilly opened this issue Apr 1, 2024 · 6 comments
Open

Add CITATION.cff file #213

willynilly opened this issue Apr 1, 2024 · 6 comments

Comments

@willynilly
Copy link
Contributor

Github support CITATION.cff files. I was thinking it would be good to add one: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

@willynilly willynilly changed the title Add CITATION file Add CITATION.cff file Apr 1, 2024
@wshanks
Copy link
Collaborator

wshanks commented Apr 1, 2024

Note how the original author asked for the package to be cited. I am not sure if or how this should ever change since he has handed over maintenance to the lmfit team:

uncertainties/doc/index.rst

Lines 385 to 392 in e9b82f0

How to cite this package
========================
If you use this package for a publication (in a journal, on the web,
etc.), please cite it by including as much information as possible
from the following: *Uncertainties: a Python package for calculations
with uncertainties*, Eric O. LEBIGOT. Adding the version
number is optional.

@newville
Copy link
Member

newville commented Apr 1, 2024

Adding a Zenodo citation for this project would be nice. Certainly, @lebigot E. O. Lebigot would be the lead author of that. I would suggest even having E. O. Lebigot as the sole author -- the commit history is pretty clear.

@lebigot
Copy link
Collaborator

lebigot commented Apr 2, 2024

Honestly, I'm not against having all the contributors listed, but I'm sensitive to the commiters argument: a single author would represent the commit history (and the creation effort) more clearly indeed. Thanks!

@wshanks
Copy link
Collaborator

wshanks commented Apr 2, 2024

Indeed, I see no reason to change the citation at this time. What I was not sure about was how we would agree on changing it in the future if there are further contributions, but that is a question for a later date 🙂

@newville
Copy link
Member

newville commented Apr 2, 2024

@wshanks @lebigot I enabled the Zenodo webhook so that, on the next release, a DOI will be created that can be used as the citation. Still slowly working on the docs, and hope to have more time for this next week.

@lebigot
Copy link
Collaborator

lebigot commented Apr 2, 2024

Thanks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants