Add CITATION.cff file for PyGMT (#1592)

Human- and machine-readable citation information
for software. Generated using `doi2cff` and modified
slightly to cff 1.2.0 schema, see
https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md
for details.

* Document that CITATION.cff needs to be updated every release

Co-authored-by: Will Schlitzer <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>

Author: 3 people

.github/ISSUE_TEMPLATE/release_checklist.md

@@ -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
   - [ ] 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))

AUTHORSHIP.md

@@ -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

CITATION.cff

@@ -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

doc/maintenance.md

@@ -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/NumPy versions. Follow
    [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` specification can be found at
+   https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
 
 ### Check the README syntax