Skip to content

Commit e14c614

Browse files
weiji14seisman
andauthored
Add PyGMT Zenodo BibTeX entry to main README.md (#678)
Ensure that people will cite PyGMT consistently in their research work. BibTeX is copied from https://zenodo.org/record/4025418/export/hx, and modified to make the 'title' single-lined, with the 'note' removed. Also added citation link to GMT6 paper and some other modules. Co-authored-by: Dongdong Tian <[email protected]>
1 parent a01ea4d commit e14c614

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

README.rst

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,38 @@ mistakes. That's how we all improve and we are happy to help others learn.
145145
`MetPy project <https://github.com/Unidata/MetPy>`__.
146146

147147

148-
Who we are
149-
----------
148+
Citing PyGMT
149+
------------
150150

151151
PyGMT is a community developed project. See the
152152
`AUTHORS.md <https://github.com/GenericMappingTools/pygmt/blob/master/AUTHORS.md>`__
153153
file on GitHub for a list of the people involved and a definition of the term "PyGMT
154-
Developers".
154+
Developers". Feel free to cite our work in your research using the following BibTeX:
155+
156+
.. code-block::
157+
158+
@software{uieda_leonardo_2020_4025418,
159+
author = {Uieda, Leonardo and
160+
Tian, Dongdong and
161+
Leong, Wei Ji and
162+
Toney, Liam and
163+
Newton, Tyler and
164+
Wessel, Paul},
165+
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
166+
month = sep,
167+
year = 2020,
168+
publisher = {Zenodo},
169+
version = {v0.2.0},
170+
doi = {10.5281/zenodo.4025418},
171+
url = {https://doi.org/10.5281/zenodo.4025418}
172+
}
173+
174+
To cite a specific version of PyGMT, go to our Zenodo page at
175+
https://doi.org/10.5281/zenodo.3781524 and use the "Export to BibTeX" function there.
176+
It is also strongly recommended to cite the
177+
`GMT6 paper <https://doi.org/10.1029/2019GC008515>`__ (which PyGMT wraps around).
178+
Note that some modules like ``surface`` and ``x2sys`` also have their dedicated citation.
179+
Further information for all these can be found at https://www.generic-mapping-tools.org/cite.
155180

156181

157182
License

0 commit comments

Comments
 (0)