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 CITATION.cff file for PyGMT #1592

Merged
merged 5 commits into from
Oct 29, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ assignees: ''
- [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version"
- [ ] Finish up 'Changelog entry for v0.x.x' Pull Request:
- [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher
- [ ] Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
- [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt
Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Contributor

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.

- [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions
- [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmt-and-pythonnumpy-versions
- [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog))
Expand Down
5 changes: 5 additions & 0 deletions AUTHORSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ there are a few options:
3. Indicate next to your name on `AUTHORS.md` that you do not wish to be
included with something like `(not included in Zenodo)`.

Note that authors included in the Zenodo archive will also have their name
listed in the `CITATION.cff` file. This is a machine (and human) readable file
that enables people to cite the PyGMT software easily, and the file will be
updated by the PyGMT maintainers each time a new release is made.

## Scientific publications (papers)

We aim to write academic papers for most of our software packages. Ideally, we
Expand Down
68 changes: 68 additions & 0 deletions CITATION.cff
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
Copy link
Member Author

Choose a reason for hiding this comment

The 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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do update it for tomorrow's release

Copy link
Member Author

Choose a reason for hiding this comment

The 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
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
date-released: 2021-10-29
doi: 10.5281/zenodo.5607255
license: BSD-3-Clause
repository-code: https://github.com/GenericMappingTools/pygmt
type: software
version: 0.5.0

Copy link
Member

Choose a reason for hiding this comment

The 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.

I agree.

14 changes: 9 additions & 5 deletions doc/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,16 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
7. Edit the list of people who contributed to the release, linking to their
GitHub account. Sort their names by the number of commits made since the
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
8. Update `README.rst` with new information on the new release version, namely
the BibTeX citation, a vX.Y.Z documentation link, and compatibility with
Python and GMT versions. Follow
8. Update `README.rst` with new information on the new release version,
including a vX.Y.Z documentation link, and compatibility with
GMT/Python/NumPyPython versions. Follow
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
[NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description)
for compatibility updates. Follow `AUTHORSHIP.md` guidelines for updating
the author list in the BibTeX citation.
for compatibility updates.
9. Refresh citation information. Specifically, the BibTeX in `README.rst` and
`CITATION.cff` needs to be updated with any metadata changes. Please follow
guidelines in `AUTHORSHIP.md` for updating the author list in the BibTeX.
More information about the `CITATION.cff` specication can be found at
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md

### Check the README syntax

Expand Down