Adding references to the DOI record

[castelao]

This file informs Zenodo to add TEOS-10 (Manual & Getting started) as references within the DOI record. This is equivalent to the references list in a regular paper.

It will take effect on the next release.

For more information and options: https://github.com/castelao/inception.

[efiring]

@ocefpaf, @DocOtak I suspect you are familiar with this sort of thing, so perhaps one of you could comment on it.

[DocOtak]

I haven't (yet) done the Zenodo thing with any of my groups documentation, but it looks like Zenodo tries to get most of the information about a repository from the github api. This can be made explicit by adding a .zenodo.json file. @castelao is one of the people I tend reach out to when I see he has done something I'm having trouble figuring out, I suspect he knows what he is doing on this matter.

What I couldn't find is documentation on the zenodo website talking about this. The few references I could find said this json file is described on a page only the zenodo account holder can see when they are adding a repository. This seems odd given the mission of Zenodo, though perhaps it is a json representation of another metadata standard?

[castelao]

I'm not aware of any documentation on this trick of using.zenodo.json other than my repo 'inception'.

Zenodo usually figures out everything pretty well, but one thing it misses is references. If you think it is important to add the references, one could add them manually at Zenodo every time there is a new release. An alternative is to add the zenodo.json with that info, so every new release Zenodo uses that automatically.

The DOI is not just a URL, but more like a database unique id. There are several fields stored. A scientific paper will have in its record the references, funding agencies, publisher, etc. From these fields, all scientific production can be connected.

This PR is an automatic solution to link this code to the TEOS-10 references, as we would do with a bibliography list in a traditional scientific paper. Just a suggestion.

[efiring]

@castelao Is this still a good idea? Nothing major has changed in the interim? I will merge it if you still recommend it.

[castelao]

@efiring , think it is still a good idea to merge it. In summary, for every new release, Zenodo will create a new DOI that will be linked to the references.

It looks like CITATION.cff will be the standard one day, but its schema doesn't cover everything yet, so I've been using both. I actually would recommend creating a DOI for GSW-C and including that one in the references here.

In the future, you might as well be interested in defining 'creators' and 'contributors', using this json file.