Installing¶
Note
🚨 This package is 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.
Which Python?¶
You’ll need Python 3.6 or greater to run GMT/Python.
We recommend using the Anaconda Python
distribution to ensure you have all dependencies installed and the conda
package manager available.
Installing Anaconda does not require administrative rights to your computer and
doesn’t interfere with any other Python installations in your system.
Which GMT?¶
You’ll need the latest development version available from the GitHub repository. GMT/Python is based on GMT 6, which has not yet been officially released.
We need the very latest GMT since there are many changes being made to GMT itself in response to the development of GMT/Python, mainly the new modern execution mode.
Dependencies¶
GMT/Python requires the following libraries:
The following are optional (but recommended) dependencies:
- IPython: For embedding the figures in Jupyter notebooks.
Installing GMT¶
Unfortunately, you’ll have to build GMT from source in order to get GMT/Python working. Please follow the instructions at http://gmt.soest.hawaii.edu/projects/gmt/wiki/BuildingGMT
Note
We used to maintain conda packages for the latest GMT. That caused many problems and was very difficult to maintain updated. We have opted to not do that anymore so that we can develop more quickly. Once GMT 6 is officially released, we’ll have conda packages available again. Please bear with us.
Installing GMT/Python¶
Now that you have GMT installed and your conda environment activated,
use pip to install the latest source of GMT/Python from Github:
pip install https://github.com/GenericMappingTools/pygmt/archive/master.zip
Alternatively, you can clone the git repository and install using pip:
git clone https://github.com/GenericMappingTools/pygmt.git
cd pygmt
pip install .
This will allow you to use the gmt library from Python.
Testing your install¶
GMT/Python ships with a full test suite. You can run our tests after you install it but you will need a few extra dependencies as well (be sure to have your conda env activated):
conda install pytest pytest-mpl sphinx jinja2 docutils ipython
Test your installation by running the following inside a Python interpreter:
import gmt
gmt.test()