Skip to content

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

Merged
merged 1 commit into from
Mar 22, 2021
Merged

Conversation

michaelosthege
Copy link
Member

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.

Copy link
Member

@OriolAbril OriolAbril left a 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

https://docs.pymc.io/about.html#citing-pymc3

@castelao
Copy link

Zenodo DOIs are now created automatically.

@fonnesbeck I think you can log in there to specify further metadata

@michaelosthege & @fonnesbeck, you indeed can log in there to specify further metadata, or you can add a descriptor here as .zenodo.json. Check this https://github.com/castelao/inception for more details.

@michaelosthege
Copy link
Member Author

Thanks for the info @castelao !
In my opinion we have too many files at the root level of the repo already. Therefore I would prefer to set the metadata in Zenodo. @fonnesbeck how do you want to proceed?

@fonnesbeck
Copy link
Member

fonnesbeck commented Mar 16, 2021

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.

@fonnesbeck
Copy link
Member

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.

@castelao
Copy link

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.

@michaelosthege
Copy link
Member Author

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.

@fonnesbeck fonnesbeck merged commit 1d1a371 into master Mar 22, 2021
@michaelosthege michaelosthege deleted the add-dois branch March 22, 2021 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants