-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add Zenodo DOI badges and citation instructions #4544
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good so far, we should also update the documentation home page and the "about pymc3" page.
https://github.com/pymc-devs/pymc3/blob/master/docs/source/index.rst#citing-pymc3
b3057af
to
798cf35
Compare
@michaelosthege & @fonnesbeck, you indeed can log in there to specify further metadata, or you can add a descriptor here as |
Thanks for the info @castelao ! |
If the metadata is something that gets updated regularly (e.g. releases), then its best to have it in the repo, but if it is completely static then I agree it should be set on Zenodo. I did notice that you can keep track of citations in the metadata; if we wanted to do that, then it should be in the repo. |
It looks like a pretty static file, except for contributors, which I doubt we want to try and keep up to date in the DOI metadata. |
I believe that every release Zenodo creates a new DOI and fills only the basic metadata that it can guess. If that is correct, whatever metadata you edit manually at Zenodo would require to repeat that on every release. If there is interest, it might be worth recording references (linking papers' DOIs) with related_identifiers[{"relation": "references", ...}], and contributors[{"type": "Sponsor", ...}] if any. |
In my experience Zenodo associates the metadata with the whole project and replicates it for new releases. Only the list of contributors is gathered from the git history. |
Zenodo DOIs are now created automatically.
@fonnesbeck I think you can log in there to specify further metadata
This PR adds the DOIs to the main readme. I'm not great with restructured text formatting; please just add/commit changes as you see fit.