UCL-ARC / python-tooling

Python package template for new research software projects
http://github-pages.arc.ucl.ac.uk/python-tooling/
MIT License
43 stars 2 forks source link

Task: Make this repository citeable #330

Closed matt-graham closed 5 months ago

matt-graham commented 8 months ago

What needs to be done?

We should add a CITATION.cff file to make it clear how to cite this repository itself, particularly as we're starting to think about advertising more widely. Relatedly we may also want to set up the Zenodo integration for the repository if we haven't already done so we get DOIs when we make a release.

### Tasks
- [x] Enable Zenodo integration
- [x] Add `CITATION.cff` file
paddyroddy commented 8 months ago

I had wondered about this recently 🤔 prompted by the Code for Thought podcast recently

matt-graham commented 8 months ago

Now that GitHub allows linking ORCIDs to profiles it feels like there should be a way to automate keeping the author list on a CITATION.cff up to date (assuming this is based on contributor list, potentially with some filtering) 🤔

paddyroddy commented 8 months ago

I'm still a bit confused what the ORCiD bit is doing in CITATION.cff. Like it doesn't appear in the output Roddy, P. J. (2023). SLEPLET: Slepian Scale-Discretised Wavelets in Python. Journal of Open Source Software, 8(84), 5221. https://doi.org/10.21105/joss.05221 image

matt-graham commented 8 months ago

The Zenodo integration automatically picks up ORCIDs from the CITATION.cff file I think for example (e.g. https://zenodo.org/records/10144016). I think the purpose of the file is more general than the GitHub usage.

paddyroddy commented 8 months ago

Maybe you're right. I know mine has picked up the ORCiD here doi.org/10.5281/zenodo.7268074, but that could have easily been from my Zenodo account (like I wouldn't need CITATION.cff to achieve the same). But maybe for co-authors it is necessary...

paddyroddy commented 8 months ago

Related zenodo/zenodo#596

samcunliffe commented 8 months ago

I guess we want a DOI for the pages too?

matt-graham commented 5 months ago

I've created a separate issue for the remain task (#411) but I think the main points here have been resolved by #340 so closing.