From e14c614ddb5f8ab81631c177f50aea536af05b74 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Wed, 4 Nov 2020 11:50:38 +1300 Subject: [PATCH] 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 --- README.rst | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 6d4004527fd..86a2aceb6d6 100644 --- a/README.rst +++ b/README.rst @@ -145,13 +145,38 @@ mistakes. That's how we all improve and we are happy to help others learn. `MetPy project `__. -Who we are ----------- +Citing PyGMT +------------ PyGMT is a community developed project. See the `AUTHORS.md `__ file on GitHub for a list of the people involved and a definition of the term "PyGMT -Developers". +Developers". Feel free to cite our work in your research using the following BibTeX: + +.. code-block:: + + @software{uieda_leonardo_2020_4025418, + author = {Uieda, Leonardo and + Tian, Dongdong and + Leong, Wei Ji and + Toney, Liam and + Newton, Tyler and + Wessel, Paul}, + title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, + month = sep, + year = 2020, + publisher = {Zenodo}, + version = {v0.2.0}, + doi = {10.5281/zenodo.4025418}, + url = {https://doi.org/10.5281/zenodo.4025418} + } + +To cite a specific version of PyGMT, go to our Zenodo page at +https://doi.org/10.5281/zenodo.3781524 and use the "Export to BibTeX" function there. +It is also strongly recommended to cite the +`GMT6 paper `__ (which PyGMT wraps around). +Note that some modules like ``surface`` and ``x2sys`` also have their dedicated citation. +Further information for all these can be found at https://www.generic-mapping-tools.org/cite. License