search

irfu / irfu-matlab

Matlab routines to work with space data, particularly with MMS and Cluster/CAA data. Also some general plasma routines.
59 stars 46 forks source link

Add Zenodo and DOI support for released versions of irfu-matlab #144

Closed thomas-nilsson-irfu closed 3 months ago

thomas-nilsson-irfu commented 3 months ago

The question came up on the correct way of referencing irfu-matlab in various papers, and it appears there are some "proper" way of doing this.

The following message was sent on IRF Slack (by PhD student Ida 2024-05-27T11:06 CEST)

I used the link above in my first paper and it was not approved in the initial quality check:

Although GitHub is acceptable for the peer review process, since GitHub does not comply with FAIR guidelines as it is not a permanent storage option, your data will need to be deposited to a FAIR compliant repository if your article is eventually accepted. GitHub has partnered with Zenodo, which is FAIR compliant, and allows users to link their GitHub data to Zenodo (https://guides.github.com/activities/citable-code/). Please link the GitHub data now to Zenodo and provide the link, DOI, and data citation in your data statement. https://www.agu.org/Publish-with-AGU/Publish/Author-Resources/Data-for-Authors.

In which the "link above" is simply our statement regarding acknowledgement in the README.

The proper way would be to simply add Zenodo to our release process, and ensure we keep our CITATION file updated.

Zenodo: https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content CITATION file: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files (our current devel CITATION: https://github.com/irfu/irfu-matlab/blob/5fba5f7bc4ae14c5d70c7b4631b47cddf587664e/CITATION.cff)

thomas-nilsson-irfu commented 3 months ago

Now we do have an "official" DOI https://zenodo.org/doi/10.5281/zenodo.11550090 (always pointing to latest release), and https://zenodo.org/doi/10.5281/zenodo.11550091 (pointing to the previous v1.16.3 release).

One thing which is not 100% clear to me is from where Zenodo fetched "affiliation" information for the github Authors section but that is perhaps a minor issue to be solved in the future.. For now, this DOI appears to work so I'm closing this issue here.