-
Notifications
You must be signed in to change notification settings - Fork 224
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 CITATION.cff file for PyGMT #1592
Changes from all commits
2677173
b12c568
cc12da2
792f43e
056b50d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,68 @@ | ||||||||||||||||||||||||||
# YAML 1.2 | ||||||||||||||||||||||||||
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/) | ||||||||||||||||||||||||||
cff-version: 1.2.0 | ||||||||||||||||||||||||||
message: If you use this software, please cite it as follows. | ||||||||||||||||||||||||||
title: 'PyGMT: A Python interface for the Generic Mapping Tools' | ||||||||||||||||||||||||||
authors: | ||||||||||||||||||||||||||
- given-names: Leonardo | ||||||||||||||||||||||||||
family-names: Uieda | ||||||||||||||||||||||||||
affiliation: University of Liverpool, United Kingdom | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0001-6123-9515 | ||||||||||||||||||||||||||
- given-names: Dongdong | ||||||||||||||||||||||||||
family-names: Tian | ||||||||||||||||||||||||||
affiliation: Michigan State University, USA | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0001-7967-1197 | ||||||||||||||||||||||||||
- given-names: Wei Ji | ||||||||||||||||||||||||||
family-names: Leong | ||||||||||||||||||||||||||
affiliation: Victoria University of Wellington, New Zealand | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0003-2354-1988 | ||||||||||||||||||||||||||
- given-names: William | ||||||||||||||||||||||||||
family-names: Schlitzer | ||||||||||||||||||||||||||
affiliation: Unaffiliated | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0002-5843-2282 | ||||||||||||||||||||||||||
- given-names: Liam | ||||||||||||||||||||||||||
family-names: Toney | ||||||||||||||||||||||||||
affiliation: University of Alaska Fairbanks, USA | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0003-0167-9433 | ||||||||||||||||||||||||||
- given-names: Michael | ||||||||||||||||||||||||||
family-names: Grund | ||||||||||||||||||||||||||
affiliation: Innoplexia GmbH, Germany | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0001-8759-2018 | ||||||||||||||||||||||||||
- given-names: Meghan | ||||||||||||||||||||||||||
family-names: Jones | ||||||||||||||||||||||||||
affiliation: University of Hawai'i at Mānoa, USA | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0003-0180-8928 | ||||||||||||||||||||||||||
- given-names: Jiayuan | ||||||||||||||||||||||||||
family-names: Yao | ||||||||||||||||||||||||||
affiliation: Nanyang Technological University, Singapore | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0001-7036-4238 | ||||||||||||||||||||||||||
- given-names: Kathryn | ||||||||||||||||||||||||||
family-names: Materna | ||||||||||||||||||||||||||
affiliation: US Geological Survey, USA | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0002-6687-980X | ||||||||||||||||||||||||||
- given-names: Tyler | ||||||||||||||||||||||||||
family-names: Newton | ||||||||||||||||||||||||||
affiliation: University of Oregon, USA | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0002-1560-6553 | ||||||||||||||||||||||||||
- given-names: Abhishek | ||||||||||||||||||||||||||
family-names: Anant | ||||||||||||||||||||||||||
affiliation: Unaffiliated | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0002-5751-2010 | ||||||||||||||||||||||||||
- given-names: Malte | ||||||||||||||||||||||||||
family-names: Ziebarth | ||||||||||||||||||||||||||
affiliation: GFZ German Research Centre for Geosciences, Germany | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0002-5190-4478 | ||||||||||||||||||||||||||
- given-names: Yohai | ||||||||||||||||||||||||||
family-names: Magen | ||||||||||||||||||||||||||
affiliation: Tel Aviv University | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0002-4892-4013 | ||||||||||||||||||||||||||
- given-names: Paul | ||||||||||||||||||||||||||
family-names: Wessel | ||||||||||||||||||||||||||
affiliation: University of Hawai'i at Mānoa, USA | ||||||||||||||||||||||||||
orcid: https://orcid.org/0000-0001-5708-7336 | ||||||||||||||||||||||||||
date-released: 2021-08-07 | ||||||||||||||||||||||||||
doi: 10.5281/zenodo.5162003 | ||||||||||||||||||||||||||
license: BSD-3-Clause | ||||||||||||||||||||||||||
repository-code: https://github.com/GenericMappingTools/pygmt | ||||||||||||||||||||||||||
type: software | ||||||||||||||||||||||||||
version: 0.4.1 | ||||||||||||||||||||||||||
Comment on lines
+63
to
+68
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I can modify this to use the v0.5.0 DOI and date if that's preferable. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please do update it for tomorrow's release There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On second thought, maybe better to change it in the PyGMT v0.5.0 changelog PR. Here's the diff for reference.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I agree. |
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.
Do we really want to maintain the citation information at these two places? The 'Cite this repository' button can already generate the BibTeX information.
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.
Yes? I don't like the formatting from the Export to BibTeX, it doesn't wrap the authors list. Also, I think it's good to have the BibTeX on PyPI. But maybe get a second opinion on this.
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.
I'm not familiar with the pros and cons of using
CITATION.cff
instead of BibTeX information, but I think we should err on the side of providing users with more options. I think that releases are few and far between, so adding a few extra parameters to update won't be that much of a demand for maintainers.