# pygmt **Repository Path**: weiji14/pygmt ## Basic Information - **Project Name**: pygmt - **Description**: No description available - **Primary Language**: Unknown - **License**: BSD-3-Clause - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-09-06 - **Last Updated**: 2022-12-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README 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://img.shields.io/conda/v/conda-forge/pygmt?style=flat-square :alt: Latest version on conda-forge :target: https://anaconda.org/conda-forge/pygmt .. image:: https://github.com/GenericMappingTools/pygmt/workflows/Tests/badge.svg :alt: GitHub Actions Tests status :target: https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests.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/ci_tests_dev.yaml .. image:: https://codecov.io/gh/GenericMappingTools/pygmt/branch/main/graph/badge.svg?token=78Fu4EWstx :alt: Test coverage status :target: https://app.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://tinyurl.com/y22nb8up :alt: PyOpenSci :target: https://github.com/pyOpenSci/software-review/issues/43 .. image:: https://img.shields.io/github/license/GenericMappingTools/pygmt?style=flat-square :alt: GitHub license :target: https://github.com/GenericMappingTools/pygmt/blob/main/LICENSE.txt .. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg :alt: Contributor Code of Conduct :target: CODE_OF_CONDUCT.md .. image:: https://img.shields.io/twitter/follow/gmt_dev?style=social :alt: Twitter URL :target: https://twitter.com/gmt_dev .. 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 `__! 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 `__! .. image:: https://user-images.githubusercontent.com/14077947/155809878-48b8f235-141b-460a-80ec-08bbf6c36e40.png :alt: Quick Introduction to PyGMT YouTube Video :align: center :target: https://youtu.be/4iPnITXrxVU :width: 80% 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.ndarray`` or ``pandas.DataFrame`` for data tables, ``xarray.DataArray`` for grids and ``geopandas.GeoDataFrame`` for geographical data. Quickstart ---------- Installation ++++++++++++ Simple installation using `conda `__:: conda install --channel conda-forge pygmt If you use `mamba `__:: mamba 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: .. code-block:: @software{pygmt_2022_6702566, author = {Uieda, Leonardo and Tian, Dongdong and Leong, Wei Ji and Jones, Max and Schlitzer, William and Grund, Michael and Toney, Liam and Yao, Jiayuan and Magen, Yohai and Materna, Kathryn and Fröhlich, Yvonne and Belem, Andre 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 = jul, year = 2022, publisher = {Zenodo}, version = {v0.7.0}, doi = {10.5281/zenodo.6702566}, url = {https://doi.org/10.5281/zenodo.6702566} } 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 (not maintained): * `gmtpy `__ by `Sebastian Heimann `__ * `pygmt `__ by `Ian Rose `__ * `PyGMT `__ by `Magnus Hagdorn `__ Compatibility with GMT/Python/NumPy versions -------------------------------------------- .. list-table:: :widths: 25 30 15 20 15 :header-rows: 1 * - PyGMT Version - Documentation - GMT - Python - NumPy * - `Dev `_ (upcoming release) - `Dev Documentation `_ (reflects `main branch `_) - >=6.3.0 - >=3.8 - >=1.20 * - `v0.7.0 `_ (latest release) - `v0.7.0 Documentation `_ - >=6.3.0 - >=3.8 - >=1.20 * - `v0.6.1 `_ - `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 -