Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
22db70f
Add separat subsection 'citing'
yvonnefroehlich Jul 30, 2026
78c0007
Move BibTex to documentation
yvonnefroehlich Jul 30, 2026
a0d456d
Move citing information completely to documentation
yvonnefroehlich Jul 31, 2026
c2cbcb7
Add link to docs for citing PyGMT in README
yvonnefroehlich Jul 31, 2026
ce9331b
Merge branch 'main' into add-subsection-citing
yvonnefroehlich Jul 31, 2026
c590d2f
Merge branch 'main' into add-subsection-citing
yvonnefroehlich Jul 31, 2026
e97861b
Move and combine community-contribution paragraph to Team page
yvonnefroehlich Jul 31, 2026
b14dd1c
Use full line length
yvonnefroehlich Jul 31, 2026
4f76913
Make BibTex entries consistent
yvonnefroehlich Jul 31, 2026
a102658
Shorten formulation
yvonnefroehlich Jul 31, 2026
a26fa4a
Add specifc reference to api doc page of the module
yvonnefroehlich Jul 31, 2026
086a099
Need to link to dev for citing as new section
yvonnefroehlich Jul 31, 2026
6b90f06
Fix hypens
yvonnefroehlich Jul 31, 2026
6945550
Move reference after 'Full GMT docs'
yvonnefroehlich Jul 31, 2026
b22f85c
Set journals in italic style
yvonnefroehlich Jul 31, 2026
929f5f6
Add documentation section to README and list 'Citing PyGMT'
yvonnefroehlich Jul 31, 2026
b9e3fc6
Fix link
yvonnefroehlich Jul 31, 2026
45426a3
Move 'Documentation' section after 'Quickstart' section in README
yvonnefroehlich Jul 31, 2026
c63f036
Make citing a specific PyGMT version clearer
yvonnefroehlich Jul 31, 2026
eadce0b
Remove journal of PyGMT paper
yvonnefroehlich Jul 31, 2026
a6482ff
Add release number to explaniation of Zenodo BibTex
yvonnefroehlich Jul 31, 2026
1010638
Use line length limit
yvonnefroehlich Aug 1, 2026
cb99974
Use hypen instead of star for bullet point list
yvonnefroehlich Aug 1, 2026
45480c9
Move citing specific PyGMT release to the end of the file
yvonnefroehlich Aug 1, 2026
c76cd3e
Remove trailing white spaces
yvonnefroehlich Aug 1, 2026
47b7a49
Try to set latest PyGMT version flexible
yvonnefroehlich Aug 1, 2026
308a6f3
Try to get latest release number
yvonnefroehlich Aug 1, 2026
0fc0adc
Fix coding style
yvonnefroehlich Aug 1, 2026
1f13d37
Fix coding style
yvonnefroehlich Aug 1, 2026
aa46cce
Merge branch 'main' into add-subsection-citing
yvonnefroehlich Aug 1, 2026
da23b8d
Move 'citing' after 'presentations'
yvonnefroehlich Aug 2, 2026
bb65027
Add link to Zenodo archive
yvonnefroehlich Aug 2, 2026
26b93ef
Remove 'mys_subsitutions' variable for latest release
yvonnefroehlich Aug 2, 2026
71d76a7
Merge branch 'main' into add-subsection-citing
yvonnefroehlich Aug 2, 2026
3c03f98
Merge branch 'main' into add-subsection-citing
yvonnefroehlich Aug 2, 2026
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
73 changes: 4 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ fig.show()
For other ways to install PyGMT and more examples, please visit the
[PyGMT documentation](https://www.pygmt.org/).

## Documentation

- [Citing PyGMT](https://www.pygmt.org/dev/citing.html)

## Contacting us

- Most discussion happens [on GitHub](https://github.com/GenericMappingTools/pygmt).
Expand Down Expand Up @@ -117,75 +121,6 @@ happy to help others learn.

*This disclaimer was adapted from the* [MetPy project](https://github.com/Unidata/MetPy).

## Citing PyGMT

PyGMT is a community developed project. See the
[AUTHORS.md](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md) file
on GitHub for a list of the people involved and a definition of the term "PyGMT Developers".

Feel free to cite our work in your research. You can either cite the [PyGMT paper](https://doi.org/10.1029/2026GC013105)
published in *Geochemistry, Geophysics, Geosystems* or the Zenodo archive of the PyGMT software.

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 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},
doi = {10.5281/zenodo.19398871},
url = {https://doi.org/10.5281/zenodo.19398871}
}
```

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

## License

PyGMT is free software: you can redistribute it and/or modify it under the terms of the
Expand Down
65 changes: 65 additions & 0 deletions doc/citing.md
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>.
Comment thread
seisman marked this conversation as resolved.


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},

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Tian, D., Leong, W. J., Fröhlich, Y., Grund, M., Schlitzer, W., Jones, M., Toney, L., Yao, J., Tong, J.-H., Magen, Y., Materna, K., Belem, A., Newton, T., Anant, A., Ziebarth, M., Quinn, J., He, X., Uieda, L.& Wessel, P. (2026). PyGMT: A Python interface for the Generic Mapping Tools (Version v0.19.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.19398871

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

image

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.

@yvonnefroehlich yvonnefroehlich Aug 1, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

OK. This means we should update the metadata of the Zenodo uploads.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think so. @weiji14 any comments on it?

@yvonnefroehlich yvonnefroehlich Aug 2, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe open an issue so that we can discuss it in detail

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The 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.
1 change: 1 addition & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ intro/index.rst
overview.md
ecosystem.md
presentations.md
citing.md
```

```{toctree}
Expand Down
9 changes: 5 additions & 4 deletions doc/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
We are an international team dedicated to building a Pythonic API for the Generic Mapping

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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,
Expand Down
4 changes: 4 additions & 0 deletions pygmt/src/dimfilter.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ def dimfilter(

Full GMT docs at :gmt-docs:`dimfilter.html`.

**Reference**: Kim, S.-S., & Wessel, P. (2008). Directional median filtering for
regional-residual separation of bathymetry. *Geochemistry, Geophysics, Geosystems*,
9(3), 2007GC001850. https://doi.org/10.1029/2007GC001850

$aliases
- G = outgrid
- I = spacing
Expand Down
4 changes: 4 additions & 0 deletions pygmt/src/surface.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ def surface(

Full GMT docs at :gmt-docs:`surface.html`.

**Reference**: Smith, W. H. F., & Wessel, P. (1990). Gridding with continuous
curvature splines in tension. *Geophysics*, 55(3), 293-305.
https://doi.org/10.1190/1.1442837

$aliases
- G = outgrid
- I = spacing
Expand Down
4 changes: 4 additions & 0 deletions pygmt/src/x2sys_cross.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ def x2sys_cross(

Full GMT docs at :gmt-docs:`supplements/x2sys/x2sys_cross.html`.

**Reference**: Wessel, P. (2010). Tools for analyzing intersecting tracks: The x2sys
package. *Computers & Geosciences*, 36(3), 348-354.
https://doi.org/10.1016/j.cageo.2009.05.009

$aliases
- R = region
- V = verbose
Expand Down
4 changes: 4 additions & 0 deletions pygmt/src/x2sys_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ def x2sys_init(

Full GMT docs at :gmt-docs:`supplements/x2sys/x2sys_init.html`.

**Reference**: Wessel, P. (2010). Tools for analyzing intersecting tracks: The x2sys
package. *Computers & Geosciences*, 36(3), 348-354.
https://doi.org/10.1016/j.cageo.2009.05.009

$aliases
- I = spacing
- R = region
Expand Down
Loading