diff --git a/README.md b/README.md index 86289113e6c..8a1b05e784b 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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 -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 . - ## License PyGMT is free software: you can redistribute it and/or modify it under the terms of the diff --git a/doc/citing.md b/doc/citing.md new file mode 100644 index 00000000000..2fc3c32f24d --- /dev/null +++ b/doc/citing.md @@ -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 . + + +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}, + 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. diff --git a/doc/index.md b/doc/index.md index 993075c8b49..776d795bc25 100644 --- a/doc/index.md +++ b/doc/index.md @@ -32,6 +32,7 @@ intro/index.rst overview.md ecosystem.md presentations.md +citing.md ``` ```{toctree} diff --git a/doc/team.md b/doc/team.md index 38ca274699a..498555a0389 100644 --- a/doc/team.md +++ b/doc/team.md @@ -3,10 +3,11 @@ We are an international team dedicated to building a Pythonic API for the Generic Mapping 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, diff --git a/pygmt/src/dimfilter.py b/pygmt/src/dimfilter.py index 560734e1a25..2797b550beb 100644 --- a/pygmt/src/dimfilter.py +++ b/pygmt/src/dimfilter.py @@ -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 diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py index fbee0bd2b32..fc5e56c6651 100644 --- a/pygmt/src/surface.py +++ b/pygmt/src/surface.py @@ -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 diff --git a/pygmt/src/x2sys_cross.py b/pygmt/src/x2sys_cross.py index c0ca51c38b0..a0983a20e18 100644 --- a/pygmt/src/x2sys_cross.py +++ b/pygmt/src/x2sys_cross.py @@ -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 diff --git a/pygmt/src/x2sys_init.py b/pygmt/src/x2sys_init.py index 1abba77d350..009e5d501ad 100644 --- a/pygmt/src/x2sys_init.py +++ b/pygmt/src/x2sys_init.py @@ -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