Skip to content
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

Add a "How to cite" section to README? #19

Open
jchodera opened this issue Apr 14, 2022 · 2 comments
Open

Add a "How to cite" section to README? #19

jchodera opened this issue Apr 14, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jchodera
Copy link
Member

Now that there is data that can be downloaded and used, it would be helpful to add a section to the README.md on "How to cite the Spice dataset" with information on how to cite this dataset so that the folks who have put in a lot of effort (@pavankum @peastman @dotsdl) can get credit for their work.

This could be something similar to what MDTraj uses.

We could also activate the Zenodo github integration and have Zenodo mint a DOI acknowledging the contributors when a new GitHub release is cut, and then we can add the badge to this repo's README.md.

@peastman
Copy link
Member

I guess that citing this repository is the best we have right now. We should aim to get a paper submitted as soon as possible after the dataset is complete. That's still a few months away, but I can start writing it up.

@jchodera
Copy link
Member Author

@peastman : Can you add both the arXiv citation and the Zenodo DOI (and badge) to the README?

@jchodera jchodera added the documentation Improvements or additions to documentation label Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants