uncertainties icon indicating copy to clipboard operation
uncertainties copied to clipboard

Add CITATION.cff file

Open willynilly opened this issue 10 months ago • 6 comments

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 avatar Apr 01 '24 06:04 willynilly

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:

https://github.com/lmfit/uncertainties/blob/e9b82f045f423452cfaeddc0b776905c05187e28/doc/index.rst?plain=1#L385-L392

wshanks avatar Apr 01 '24 15:04 wshanks

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.

newville avatar Apr 01 '24 15:04 newville

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!

lebigot avatar Apr 02 '24 10:04 lebigot

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 :slightly_smiling_face:

wshanks avatar Apr 02 '24 13:04 wshanks

@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.

newville avatar Apr 02 '24 17:04 newville

Thanks!!

lebigot avatar Apr 02 '24 18:04 lebigot