PyGMT
A Python interface for the Generic Mapping Tools
Documentation (development version) | Contact | Try Online
Why PyGMT?
A beautiful map is worth a thousand words. To truly understand how powerful PyGMT is, play with it online on Binder! For a quicker introduction, check out our 3 minute overview!
Afterwards, feel free to look at our Tutorials, visit the PyGMT Gallery, and check out some external PyGMT examples!
About
PyGMT is a library for processing geospatial and geophysical data and making publication quality maps and figures. It provides a Pythonic interface for the Generic Mapping Tools (GMT), a command-line program widely used in the Earth Sciences.
Project goals
- Make GMT more accessible to new users.
- Build a Pythonic API for GMT.
- Interface with the GMT C API directly using ctypes (no system calls).
- Support for rich display in the Jupyter notebook.
- Integration with the PyData ecosystem:
numpy.ndarrayorpandas.DataFramefor data tables,xarray.DataArrayfor grids andgeopandas.GeoDataFramefor geographical data.
Quickstart
Installation
Simple installation using conda:
conda install --channel conda-forge pygmt
For other ways to install pygmt, see full installation instructions.
Contacting Us
- Most discussion happens on GitHub. Feel free to open an issue or comment on any open issue or pull request.
- We have a Discourse forum where you can ask questions and leave comments.
Contributing
Code of conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Contributing Guidelines
Please read our Contributing Guide to see how you can help and give feedback.
Imposter syndrome disclaimer
We want your help. No, really.
There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer?
We assure you that the little voice in your head is wrong.
Being a contributor doesn't just mean writing code. Equally important contributions include: writing or proof-reading documentation, suggesting or implementing tests, or even giving feedback about the project (including giving feedback about the contribution process). If you're coming to the project with fresh eyes, you might see the errors and assumptions that seasoned contributors have glossed over. If you can write any code at all, you can contribute code to open source. We are constantly trying out new skills, making mistakes, and learning from those mistakes. That's how we all improve and we are happy to help others learn.
This disclaimer was adapted from the MetPy project.
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". Feel free to cite our work in your research using the following BibTeX:
@software{pygmt_2022_6426493,
author = {Uieda, Leonardo and
Tian, Dongdong and
Leong, Wei Ji and
Jones, Meghan and
Schlitzer, William and
Grund, Michael and
Toney, Liam and
Yao, Jiayuan and
Magen, Yohai and
Materna, Kathryn and
Newton, Tyler and
Anant, Abhishek and
Ziebarth, Malte and
Quinn, Jamie and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = apr,
year = 2022,
publisher = {Zenodo},
version = {v0.6.1},
doi = {10.5281/zenodo.6426493},
url = {https://doi.org/10.5281/zenodo.6426493}
}
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
PyGMT is free software: you can redistribute it and/or modify it under the terms of the BSD 3-clause License. A copy of this license is provided in LICENSE.txt.
Support
The development of PyGMT has been supported by NSF grants OCE-1558403 and EAR-1948603.
Related projects
Other Python wrappers for GMT (not maintained):
- gmtpy by Sebastian Heimann
- pygmt by Ian Rose
- PyGMT by Magnus Hagdorn
Compatibility with GMT/Python/NumPy versions
| PyGMT Version | Documentation | GMT | Python | NumPy |
|---|---|---|---|---|
| Dev (upcoming release) | Dev Documentation (reflects main branch) | >=6.3.0 | >=3.8 | >=1.19 |
| v0.6.1 (latest release) | v0.6.1 Documentation | >=6.3.0 | >=3.8 | >=1.19 |
| v0.6.0 | v0.6.0 Documentation | >=6.3.0 | >=3.8 | >=1.19 |
| v0.5.0 | v0.5.0 Documentation | >=6.2.0 | >=3.7 | >=1.18 |
| v0.4.1 | v0.4.1 Documentation | >=6.2.0 | >=3.7 | >=1.17 |
| v0.4.0 | v0.4.0 Documentation | >=6.2.0 | >=3.7 | >=1.17 |
| v0.3.1 | v0.3.1 Documentation | >=6.1.1 | >=3.7 | |
| v0.3.0 | v0.3.0 Documentation | >=6.1.1 | >=3.7 | |
| v0.2.1 | v0.2.1 Documentation | >=6.1.1 | >=3.6 | |
| v0.2.0 | v0.2.0 Documentation | >=6.1.1 | 3.6 - 3.8 | |
| v0.1.2 | v0.1.2 Documentation | >=6.0.0 | 3.6 - 3.8 | |
| v0.1.1 | v0.1.1 Documentation | >=6.0.0 | 3.6 - 3.8 | |
| v0.1.0 | v0.1.0 Documentation | >=6.0.0 | 3.6 - 3.8 |