Python Makefile
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add new template for feature requests and PR Aug 17, 2018
doc Add basic contour functionality (#212) Aug 17, 2018
gmt Add basic contour functionality (#212) Aug 17, 2018
.codeclimate.yml Remove nonexistent ci directory (#192) Jun 21, 2018
.codecov.yml Add Gitter integrations (#36) Aug 5, 2017
.coveragerc Add test and coverage commands Jul 1, 2017
.gitattributes Add versioneer to manage version numbers using tags Jun 30, 2017
.gitignore Add preview option using NASA WorldWind Web (#132) Feb 15, 2018
.pylintrc Use Black for code formatting (#186) Jun 14, 2018
.stickler.yml Log error messages with a callback instead of file (#188) Jun 16, 2018
.travis.yml Pass in NULL pointer to GMT_Get_Enum (#224) Aug 17, 2018
AUTHORS.md Add show arg to Figure.savefig() (#72) Dec 1, 2017
CODE_OF_CONDUCT.md Add impostor syndrome disclaimer + code of conduct Jul 22, 2017
CONTRIBUTING.md Use Black for code formatting (#186) Jun 14, 2018
LICENSE.txt Update license year to 2018 (#189) Jun 20, 2018
MANIFEST.in Add a Contributing Guide (#57) Nov 16, 2017
Makefile Refactor the gmt.clib package (#210) Jul 8, 2018
README.rst Sphinx extension for GMT/Python plots (#208) Jul 7, 2018
environment.yml Pass in NULL pointer to GMT_Get_Enum (#224) Aug 17, 2018
requirements.txt Pass in NULL pointer to GMT_Get_Enum (#224) Aug 17, 2018
setup.cfg Use Black for code formatting (#186) Jun 14, 2018
setup.py Remove nonexistent ci directory (#192) Jun 21, 2018
versioneer.py Add versioneer to manage version numbers using tags Jun 30, 2017

README.rst

GMT/Python

A Python interface for the Generic Mapping Tools

Latest version on PyPI Travis CI build status Test coverage status Code quality status Code quality grade on codacy Compatible Python versions. Chat room on Gitter

Online Demo | Documentation | Source Code | Contact

import gmt

# Load sample earthquake data in a pandas.DataFrame
quakes = gmt.datasets.load_usgs_quakes()

# Load the builtin Earth relief grid as an xarray.DataArray.
relief = gmt.datasets.load_earth_relief(resolution="30m")

# The Figure object controls all plotting functions
fig = gmt.Figure()
# Setup a map with a global region, a Mollweide projection, and automatic ticks
fig.basemap(region="g", projection="W200/8i", frame=True)
# Plot the Earth relief grid in pseudo-color.
fig.grdimage(relief, cmap="geo")
# Plot earthquakes as circles. Size maps to magnitude and color to depth.
fig.plot(x=quakes.longitude, y=quakes.latitude, sizes=0.01*2**quakes.mag,
         color=quakes.depth/quakes.depth.max(), cmap="viridis", style="cc")
# Show a preview of the image (inline if in a Jupyter notebook).
fig.show()

.github/readme-example.png

Disclaimer

This package in early stages of design and implementation.

We welcome any feedback and ideas! Let us know by submitting issues on Github or send us a message on our Gitter chatroom.

Getting started

  1. Try an online demo at try.gmtpython.xyz
  2. Install (Linux and Mac)
  3. Follow the Tutorials.
  4. Take a look at the API to see what is available.

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

Contacting Us

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. Equality 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.

Related projects

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

Other Python wrappers for GMT:

License

GMT/Python 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.