Skip to content

Commit 9d5a904

Browse files
DOC/website: Move citiation information from README to separate file and subsection "citing" (#4784)
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
1 parent beaf996 commit 9d5a904

8 files changed

Lines changed: 91 additions & 73 deletions

File tree

README.md

Lines changed: 4 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ fig.show()
7575
For other ways to install PyGMT and more examples, please visit the
7676
[PyGMT documentation](https://www.pygmt.org/).
7777

78+
## Documentation
79+
80+
- [Citing PyGMT](https://www.pygmt.org/dev/citing.html)
81+
7882
## Contacting us
7983

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

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

120-
## Citing PyGMT
121-
122-
PyGMT is a community developed project. See the
123-
[AUTHORS.md](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md) file
124-
on GitHub for a list of the people involved and a definition of the term "PyGMT Developers".
125-
126-
Feel free to cite our work in your research. You can either cite the [PyGMT paper](https://doi.org/10.1029/2026GC013105)
127-
published in *Geochemistry, Geophysics, Geosystems* or the Zenodo archive of the PyGMT software.
128-
129-
The BibTeX entry for the PyGMT paper is:
130-
```
131-
@article{pygmt_2026_2026GC013105,
132-
author = {Tian, Dongdong and
133-
Fröhlich, Yvonne and
134-
Leong, Wei Ji and
135-
Grund, Michael and
136-
Schlitzer, William and
137-
Jones, Max and
138-
Uieda, Leonardo and
139-
Luis, Joaquim M. F.},
140-
title = {{PyGMT: Bridging Python and the Generic Mapping Tools for Geospatial Visualization and Analysis}},
141-
journal = {Geochemistry, Geophysics, Geosystems},
142-
year = 2026,
143-
volume = {27},
144-
number = {7},
145-
pages = {e2026GC013105},
146-
doi = {10.1029/2026GC013105},
147-
url = {https://doi.org/10.1029/2026GC013105},
148-
}
149-
```
150-
The BibTeX entry for the latest Zenodo archive of the PyGMT software is:
151-
```
152-
@software{
153-
pygmt_2026_19398871,
154-
author = {Tian, Dongdong and
155-
Leong, Wei Ji and
156-
Fröhlich, Yvonne and
157-
Grund, Michael and
158-
Schlitzer, William and
159-
Jones, Max and
160-
Toney, Liam and
161-
Yao, Jiayuan and
162-
Tong, Jing-Hui and
163-
Magen, Yohai and
164-
Materna, Kathryn and
165-
Belem, Andre and
166-
Newton, Tyler and
167-
Anant, Abhishek and
168-
Ziebarth, Malte and
169-
Quinn, Jamie and
170-
He, Xingchen and
171-
Uieda, Leonardo and
172-
Wessel, Paul},
173-
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
174-
month = jul,
175-
year = 2026,
176-
publisher = {Zenodo},
177-
version = {0.19.0},
178-
doi = {10.5281/zenodo.19398871},
179-
url = {https://doi.org/10.5281/zenodo.19398871}
180-
}
181-
```
182-
183-
To cite a specific version of PyGMT, go to our Zenodo page at <https://doi.org/10.5281/zenodo.3781524>
184-
and use the "Export to BibTeX" function there. It is also strongly recommended to cite
185-
the [GMT 6 paper](https://doi.org/10.1029/2019GC008515) (which PyGMT wraps around). Note
186-
that some modules like `dimfilter`, `surface`, and `x2sys` also have their dedicated
187-
citations. Further information for all these can be found at <https://www.generic-mapping-tools.org/cite>.
188-
189124
## License
190125

191126
PyGMT is free software: you can redistribute it and/or modify it under the terms of the

doc/citing.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Citing PyGMT
2+
3+
If you used PyGMT in your research please consider citing PyGMT. You can either cite the
4+
[PyGMT paper](https://doi.org/10.1029/2026GC013105) or the [Zenodo archive](https://doi.org/10.5281/zenodo.3781524)
5+
of the PyGMT software.
6+
7+
It is also strongly recommended to cite the [GMT 6 paper](https://doi.org/10.1029/2019GC008515) (which PyGMT
8+
wraps around). Note that some modules like `dimfilter`, `surface`, and `x2sys` also have their dedicated
9+
citations. Further information for all these can be found at <https://www.generic-mapping-tools.org/cite>.
10+
11+
12+
The BibTeX entry for the PyGMT paper is:
13+
```
14+
@article{pygmt_2026_2026GC013105,
15+
author = {Tian, Dongdong and
16+
Fröhlich, Yvonne and
17+
Leong, Wei Ji and
18+
Grund, Michael and
19+
Schlitzer, William and
20+
Jones, Max and
21+
Uieda, Leonardo and
22+
Luis, Joaquim M. F.},
23+
title = {{PyGMT: Bridging Python and the Generic Mapping Tools for Geospatial Visualization and Analysis}},
24+
journal = {Geochemistry, Geophysics, Geosystems},
25+
year = 2026,
26+
volume = {27},
27+
number = {7},
28+
pages = {e2026GC013105},
29+
doi = {10.1029/2026GC013105},
30+
url = {https://doi.org/10.1029/2026GC013105},
31+
}
32+
```
33+
The BibTeX entry for the latest Zenodo archive, i.e., release 0.19.0, of the PyGMT software is:
34+
```
35+
@software{pygmt_2026_19398871,
36+
author = {Tian, Dongdong and
37+
Leong, Wei Ji and
38+
Fröhlich, Yvonne and
39+
Grund, Michael and
40+
Schlitzer, William and
41+
Jones, Max and
42+
Toney, Liam and
43+
Yao, Jiayuan and
44+
Tong, Jing-Hui and
45+
Magen, Yohai and
46+
Materna, Kathryn and
47+
Belem, Andre and
48+
Newton, Tyler and
49+
Anant, Abhishek and
50+
Ziebarth, Malte and
51+
Quinn, Jamie and
52+
He, Xingchen and
53+
Uieda, Leonardo and
54+
Wessel, Paul},
55+
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
56+
month = jul,
57+
year = 2026,
58+
publisher = {Zenodo},
59+
version = {0.19.0},
60+
doi = {10.5281/zenodo.19398871},
61+
url = {https://doi.org/10.5281/zenodo.19398871}
62+
}
63+
```
64+
To cite a specific version of PyGMT, go to the [Zenodo archive](https://doi.org/10.5281/zenodo.3781524),
65+
select the specific version, and use the "Export to BibTeX" function there.

doc/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ intro/index.rst
3232
overview.md
3333
ecosystem.md
3434
presentations.md
35+
citing.md
3536
```
3637

3738
```{toctree}

doc/team.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
We are an international team dedicated to building a Pythonic API for the Generic Mapping
44
Tools (GMT).
55

6-
All are welcome to become involved with the PyGMT project! For more information about how
7-
to get involved, see the [](contributing.md). A more complete list of contributors
8-
is available in the [`AUTHORS.md`](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md)
9-
file in the source repository.
6+
PyGMT is a community developed project. All are welcome! For more information about how
7+
to get involved, see the [](contributing.md). A more complete list of contributors and a
8+
definition of the term "PyGMT Developers" is available in the
9+
[`AUTHORS.md`](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md) file in
10+
the source repository.
1011

1112
Distinguished Contributors are recognized for their substantial contributions to PyGMT,
1213
which may include code, documentation, pull request review, triaging, forum responses,

pygmt/src/dimfilter.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ def dimfilter(
4747
4848
Full GMT docs at :gmt-docs:`dimfilter.html`.
4949
50+
**Reference**: Kim, S.-S., & Wessel, P. (2008). Directional median filtering for
51+
regional-residual separation of bathymetry. *Geochemistry, Geophysics, Geosystems*,
52+
9(3), 2007GC001850. https://doi.org/10.1029/2007GC001850
53+
5054
$aliases
5155
- G = outgrid
5256
- I = spacing

pygmt/src/surface.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ def surface(
7777
7878
Full GMT docs at :gmt-docs:`surface.html`.
7979
80+
**Reference**: Smith, W. H. F., & Wessel, P. (1990). Gridding with continuous
81+
curvature splines in tension. *Geophysics*, 55(3), 293-305.
82+
https://doi.org/10.1190/1.1442837
83+
8084
$aliases
8185
- G = outgrid
8286
- I = spacing

pygmt/src/x2sys_cross.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ def x2sys_cross(
9393
9494
Full GMT docs at :gmt-docs:`supplements/x2sys/x2sys_cross.html`.
9595
96+
**Reference**: Wessel, P. (2010). Tools for analyzing intersecting tracks: The x2sys
97+
package. *Computers & Geosciences*, 36(3), 348-354.
98+
https://doi.org/10.1016/j.cageo.2009.05.009
99+
96100
$aliases
97101
- R = region
98102
- V = verbose

pygmt/src/x2sys_init.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ def x2sys_init(
4343
4444
Full GMT docs at :gmt-docs:`supplements/x2sys/x2sys_init.html`.
4545
46+
**Reference**: Wessel, P. (2010). Tools for analyzing intersecting tracks: The x2sys
47+
package. *Computers & Geosciences*, 36(3), 348-354.
48+
https://doi.org/10.1016/j.cageo.2009.05.009
49+
4650
$aliases
4751
- I = spacing
4852
- R = region

0 commit comments

Comments
 (0)