search

EUREC4A-UK / lagtraj

Python trajectory code for Lagrangian simulations
MIT License
11 stars 9 forks source link

add zenodo doi badge and citation file #195

Closed leifdenby closed 1 year ago

leifdenby commented 1 year ago

I've set up the zenodo integration for our github organisation which ensures the future releases on github area automatically uploaded to zenodo and given a DOI. I've also made sure that our existing releases on github have been pushed to zenodo (using https://github.com/imcf/zenodo-doi-for-existing-release). I've added a zenodo doi badge to the README and created a CITATION.cff file as zenodo recommend you do (https://citation-file-format.github.io/).

Could you have a look @sjboeing and let me know if this looks ok to you?

sjboeing commented 1 year ago

@leifdenby: the idea of automatically creating a DOI sounds excellent. I was wondering whether these new files need to be updated manually (apologies, the zenodo-thing is a bit new to me).

leifdenby commented 1 year ago

I was wondering whether these new files need to be updated manually (apologies, the zenodo-thing is a bit new to me).

It is all automatic :) Every release created on github is automatically uploaded to zenodo and given a doi. And the link in the README will always point to the most recent release

sjboeing commented 1 year ago

Happy for you to merge this @leifdenby.

leifdenby commented 1 year ago

Happy for you to merge this @leifdenby.

Great, thanks! I've just updated the changelog and once the tests pass I will merge this in.