-
Notifications
You must be signed in to change notification settings - Fork 250
DOC/website: Move citiation information from README to separate file and subsection "citing" #4784
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
Changes from all commits
22db70f
78c0007
a0d456d
c2cbcb7
ce9331b
c590d2f
e97861b
b14dd1c
4f76913
a102658
a26fa4a
086a099
6b90f06
6945550
b22f85c
929f5f6
b9e3fc6
45426a3
c63f036
eadce0b
a6482ff
1010638
cb99974
45480c9
c76cd3e
47b7a49
308a6f3
0fc0adc
1f13d37
aa46cce
da23b8d
bb65027
26b93ef
71d76a7
3c03f98
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,65 @@ | ||
| # Citing PyGMT | ||
|
|
||
| If you used PyGMT in your research please consider citing PyGMT. You can either cite the | ||
| [PyGMT paper](https://doi.org/10.1029/2026GC013105) or the [Zenodo archive](https://doi.org/10.5281/zenodo.3781524) | ||
| of the PyGMT software. | ||
|
|
||
| It is also strongly recommended to cite the [GMT 6 paper](https://doi.org/10.1029/2019GC008515) (which PyGMT | ||
| wraps around). Note that some modules like `dimfilter`, `surface`, and `x2sys` also have their dedicated | ||
| citations. Further information for all these can be found at <https://www.generic-mapping-tools.org/cite>. | ||
|
|
||
|
|
||
| The BibTeX entry for the PyGMT paper is: | ||
| ``` | ||
| @article{pygmt_2026_2026GC013105, | ||
| author = {Tian, Dongdong and | ||
| Fröhlich, Yvonne and | ||
| Leong, Wei Ji and | ||
| Grund, Michael and | ||
| Schlitzer, William and | ||
| Jones, Max and | ||
| Uieda, Leonardo and | ||
| Luis, Joaquim M. F.}, | ||
| title = {{PyGMT: Bridging Python and the Generic Mapping Tools for Geospatial Visualization and Analysis}}, | ||
| journal = {Geochemistry, Geophysics, Geosystems}, | ||
| year = 2026, | ||
| volume = {27}, | ||
| number = {7}, | ||
| pages = {e2026GC013105}, | ||
| doi = {10.1029/2026GC013105}, | ||
| url = {https://doi.org/10.1029/2026GC013105}, | ||
| } | ||
| ``` | ||
| The BibTeX entry for the latest Zenodo archive, i.e., release 0.19.0, of the PyGMT software is: | ||
| ``` | ||
| @software{pygmt_2026_19398871, | ||
| author = {Tian, Dongdong and | ||
| Leong, Wei Ji and | ||
| Fröhlich, Yvonne and | ||
| Grund, Michael and | ||
| Schlitzer, William and | ||
| Jones, Max and | ||
| Toney, Liam and | ||
| Yao, Jiayuan and | ||
| Tong, Jing-Hui and | ||
| Magen, Yohai and | ||
| Materna, Kathryn and | ||
| Belem, Andre and | ||
| Newton, Tyler and | ||
| Anant, Abhishek and | ||
| Ziebarth, Malte and | ||
| Quinn, Jamie and | ||
| He, Xingchen and | ||
| Uieda, Leonardo and | ||
| Wessel, Paul}, | ||
| title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, | ||
| month = jul, | ||
| year = 2026, | ||
| publisher = {Zenodo}, | ||
| version = {0.19.0}, | ||
|
Member
Author
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. Should we include the "v"? At Zenodo it is included, please see https://doi.org/10.5281/zenodo.3781524:
Member
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. In our Zenodo records, we set the version field to "v0.19.0" rather than "0.19.0", but Zenodo suggests using a semantic version string.
According to the semver site, v0.19.0 is NOT a semantic version, 0.19.0 is (xref: https://semver.org/#is-v123-a-semantic-version). In other words, we should use 0.19.0 in the version field.
Member
Author
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. OK. This means we should update the metadata of the Zenodo uploads.
Member
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 think so. @weiji14 any comments on it?
Member
Author
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 believe we already had some similar discussions on this "v" during one release but could not find it at the moment in the release issues or changelog PRs. Edit: I found it #2272 (comment) and #2272 (comment). For release 0.8.0, we decided to drop the "v" in the BibTeX entry in the README to be consistent with the CITIATION.cff file (https://github.com/GenericMappingTools/pygmt/pull/2272/changes#diff-7b3ed02bc73dc06b7db906cf97aa91dec2b2eb21f2d92bc5caa761df5bbc168f). Currently we use the "v" in the GitHub releases and tags (https://github.com/GenericMappingTools/pygmt/tags) and the file name for the Zenodo archive as well as in the table for the Minimum Supported Versions. Probably need to add some note to the Maintainers Guide.
Member
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. Maybe open an issue so that we can discuss it in detail
Member
Author
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. Agree, better to have a separate issue for more detailed discussions, please see #4790. |
||
| doi = {10.5281/zenodo.19398871}, | ||
| url = {https://doi.org/10.5281/zenodo.19398871} | ||
| } | ||
| ``` | ||
| To cite a specific version of PyGMT, go to the [Zenodo archive](https://doi.org/10.5281/zenodo.3781524), | ||
| select the specific version, and use the "Export to BibTeX" function there. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,6 +32,7 @@ intro/index.rst | |
| overview.md | ||
| ecosystem.md | ||
| presentations.md | ||
| citing.md | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,10 +3,11 @@ | |
| We are an international team dedicated to building a Pythonic API for the Generic Mapping | ||
|
Member
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. There are four paragraphs of long text on this page. We probably need to shortern them, but in a separate PR. |
||
| Tools (GMT). | ||
|
|
||
| All are welcome to become involved with the PyGMT project! For more information about how | ||
| to get involved, see the [](contributing.md). A more complete list of contributors | ||
| is available in the [`AUTHORS.md`](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md) | ||
| file in the source repository. | ||
| PyGMT is a community developed project. All are welcome! For more information about how | ||
| to get involved, see the [](contributing.md). A more complete list of contributors and a | ||
| definition of the term "PyGMT Developers" is available in the | ||
| [`AUTHORS.md`](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md) file in | ||
| the source repository. | ||
|
|
||
| Distinguished Contributors are recognized for their substantial contributions to PyGMT, | ||
| which may include code, documentation, pull request review, triaging, forum responses, | ||
|
|
||

Uh oh!
There was an error while loading. Please reload this page.