Need help with pygmt?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

GenericMappingTools
342 Stars 137 Forks BSD 3-Clause "New" or "Revised" License 817 Commits 123 Opened issues

Description

A Python interface for the Generic Mapping Tools.

Services available

!
?

Need anything else?

Contributors list

PyGMT

A Python interface for the Generic Mapping Tools

Documentation (development version) 
__ |
Contact 
__ |
Try Online 
__

.. image:: http://img.shields.io/pypi/v/pygmt.svg?style=flat-square :alt: Latest version on PyPI :target: https://pypi.python.org/pypi/pygmt .. image:: https://github.com/GenericMappingTools/pygmt/workflows/Tests/badge.svg :alt: GitHub Actions Tests status :target: https://github.com/GenericMappingTools/pygmt/actions/workflows/citests.yaml .. image:: https://github.com/GenericMappingTools/pygmt/workflows/GMT%20Dev%20Tests/badge.svg :alt: GitHub Actions GMT Dev Tests status :target: https://github.com/GenericMappingTools/pygmt/actions/workflows/citestsdev.yaml .. image:: https://img.shields.io/codecov/c/github/GenericMappingTools/pygmt/master.svg?style=flat-square :alt: Test coverage status :target: https://codecov.io/gh/GenericMappingTools/pygmt .. image:: https://img.shields.io/pypi/pyversions/pygmt.svg?style=flat-square :alt: Compatible Python versions. :target: https://pypi.python.org/pypi/pygmt .. image:: https://img.shields.io/discourse/status?label=forum&server=https%3A%2F%2Fforum.generic-mapping-tools.org%2F&style=flat-square :alt: Discourse forum :target: https://forum.generic-mapping-tools.org .. image:: https://zenodo.org/badge/DOI/10.5281/3781524.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.3781524 .. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg :alt: Contributor Code of Conduct :target: CODEOF_CONDUCT.md

.. placeholder-for-doc-index

Why PyGMT?

A beautiful map is worth a thousand words. To truly understand how powerful PyGMT is, play with it online on

Binder 
! But if you need some convincing first, watch this
1 hour introduction 
to PyGMT!

Afterwards, feel free to look at our

Tutorials 
__ or visit the
PyGMT Gallery 
__.

.. image:: https://user-images.githubusercontent.com/23487320/95393255-c0b72e80-0956-11eb-9471-24429461802b.png :alt: Remote Online Sessions for Emerging Seismologists (ROSES): Unit 8 - PyGMT :align: center :target: https://www.youtube.com/watch?v=SSIGJEe0BIk

Disclaimer

🚨 This package is still undergoing rapid development. 🚨

All of the API (functions/classes/interfaces) is subject to change until we reach v1.0.0 as per the

semantic versioning specification 
__. There may be non-backward compatible changes as we experiment with new design ideas and implement new features. This is not a finished product, use with caution.

We welcome any feedback and ideas! Let us know by submitting

issues on GitHub 
__ or by posting on our
Discourse forum 
__.

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.

We rely heavily on new features that have been implemented in GMT 6.0. In particular, a new modern execution mode that greatly simplifies figure creation. These features are not available in the 5.4 version of GMT.

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.ndarray
    or
    pandas.DataFrame
    for data tables and
    xarray.DataArray
    for grids.

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:

.. code-block::

@software{pygmt_2021_4592991,
  author       = {Uieda, Leonardo and
                  Tian, Dongdong and
                  Leong, Wei Ji and
                  Toney, Liam and
                  Schlitzer, William and
                  Yao, Jiayuan and
                  Grund, Michael and
                  Jones, Meghan and
                  Materna, Kathryn and
                  Newton, Tyler and
                  Ziebarth, Malte and
                  Wessel, Paul},
  title        = {{PyGMT: A Python interface for the Generic Mapping Tools}},
  month        = mar,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {v0.3.1},
  doi          = {10.5281/zenodo.4592991},
  url          = {https://doi.org/10.5281/zenodo.4592991}
}

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

  • GMT.jl 
    __: A Julia wrapper for GMT.
  • gmtmex 
    __: A Matlab/Octave wrapper for GMT.

Other Python wrappers for GMT:

  • gmtpy 
    __ by
    Sebastian Heimann 
    __
  • pygmt 
    __ by
    Ian Rose 
    __
  • PyGMT 
    __ by
    Magnus Hagdorn 
    __

Documentation for other versions

  • Development 
    __ (reflects the master branch on GitHub)
  • Latest release 
    __
  • v0.3.1 
    __
  • v0.3.0 
    __
  • v0.2.1 
    __
  • v0.2.0 
    __
  • v0.1.2 
    __
  • v0.1.1 
    __
  • v0.1.0 
    __
  • v0.0.1a0 
    __

Compatibility with GMT and Python/NumPy versions

======= ========== ========= ========= PyGMT GMT Python NumPy ======= ========== ========= ========= 0.4.x >=6.2.0 >=3.7 >=1.17.0 0.3.x >=6.1.1 >=3.7 0.2.1 >=6.1.1 >=3.6 0.2.0 >=6.1.1 3.6 - 3.8 0.1.x >=6.0.0 3.6 - 3.8 ======= ========== ========= =========

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.