Add CITATION.bib file to make citing RMG easier #2346
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation or Problem
RMG-py provides a list of citations, but does not take advantage of the GitHub Cite this Repository feature which automatically provides BibTex files with appropriate citations to users.
Description of Changes
This PR adds a single
CITATION.cff
file that is (hopefully) correctly formatted and accurate.Testing
After merging, GitHub will automatically detect the file and add a Cite this Repository button, and any formatting/accuracy issues will then be obvious.
Reviewer Tips
The CITATION.cff file format is described here.