API Reference

Plotting

All plotting is handled through the pygmt.Figure class and its methods.

Figure()

A GMT figure to handle all plotting.

Plotting data and laying out the map:

Figure.basemap(**kwargs)	Produce a basemap for the figure.
Figure.coast(**kwargs)	Plot continents, shorelines, rivers, and borders on maps
Figure.colorbar(**kwargs)	Plot a gray or color scale-bar on maps.
Figure.plot([x, y, data, sizes, direction])	Plot lines, polygons, and symbols on maps.
Figure.contour([x, y, z, data])	Contour table data by direct triangulation.
Figure.grdcontour(grid, **kwargs)	Convert grids or images to contours and plot them on maps
Figure.grdimage(grid, **kwargs)	Project grids or images and plot them on maps.
Figure.grdview(grid, **kwargs)	Create 3-D perspective image or surface mesh from a grid.
Figure.legend([spec, position, box])	Plot legends on maps.
Figure.logo(**kwargs)	Place the GMT graphics logo on a map.
Figure.image(imagefile, **kwargs)	Place images or EPS files on maps.
Figure.shift_origin([xshift, yshift])	Shift plot origin in x and/or y directions.
Figure.text([textfiles, x, y, position, …])	Plot or typeset text strings of variable size, font type, and orientation.

Color palette table generation:

makecpt(**kwargs)

Creates a static color palette table (CPT).

Saving and displaying the figure:

Figure.savefig(fname[, transparent, crop, …])	Save the figure to a file.
Figure.show([dpi, width, method])	Display a preview of the figure.
Figure.psconvert(**kwargs)	Convert [E]PS file(s) to other formats.

Data Processing

Operations on tabular data:

blockmedian(table[, outfile])	Block average (x,y,z) data tables by median estimation.
info(fname, **kwargs)	Get information about data tables.
surface([x, y, z, data])	Grids table data using adjustable tension continuous curvature splines.

Operations on grids:

grdcut(grid, **kwargs)	Extract subregion from a grid.
grdinfo(grid, **kwargs)	Get information about a grid.
grdtrack(points, grid[, newcolname, outfile])	Sample grids at specified (x,y) locations.

GMT Defaults

Operations on GMT defaults:

config(**kwargs)

Set GMT defaults globally or locally.

Miscellaneous

which(fname, **kwargs)	Find the full path to specified files.
test([doctest, verbose, coverage, figures])	Run the test suite.
print_clib_info()	Print information about the GMT shared library that we can find.
show_versions()	Prints various dependency versions useful when submitting bug reports.

Datasets

PyGMT provides access to GMT’s datasets through the pygmt.datasets package. These functions will download the datasets automatically the first time they are used and store them in the GMT cache folder.

datasets.load_earth_relief([resolution, …])	Load Earth relief grids (topography and bathymetry) in various resolutions.
datasets.load_japan_quakes()	Load a table of earthquakes around Japan as a pandas.Dataframe.
datasets.load_ocean_ridge_points()	Load a table of ocean ridge points for the entire world as a pandas.DataFrame.
datasets.load_sample_bathymetry()	Load a table of ship observations of bathymetry off Baja California as a pandas.DataFrame.
datasets.load_usgs_quakes()	Load a table of global earthquakes form the USGS as a pandas.Dataframe.

Exceptions

All custom exceptions are derived from pygmt.exceptions.GMTError.

exceptions.GMTError	Base class for all GMT related errors.
exceptions.GMTInvalidInput	Raised when the input of a function/method is invalid.
exceptions.GMTVersionError	Raised when an incompatible version of GMT is being used.
exceptions.GMTOSError	Unsupported operating system.
exceptions.GMTCLibError	Error encountered when running a function from the GMT shared library.
exceptions.GMTCLibNoSessionError	Tried to access GMT API without a currently open GMT session.
exceptions.GMTCLibNotFoundError	Could not find the GMT shared library.

GMT C API

The pygmt.clib package is a wrapper for the GMT C API built using ctypes. Most calls to the C API happen through the pygmt.clib.Session class.

clib.Session

A GMT API session where most operations involving the C API happen.

GMT modules are executed through the call_module method:

clib.Session.call_module(module, args)

Call a GMT module with the given arguments.

Passing memory blocks between Python variables (numpy.ndarray, pandas.Series, and xarray.DataArray) and GMT happens through virtual files. These methods are context managers that automate the conversion of Python variables to GMT virtual files:

clib.Session.virtualfile_from_matrix(matrix)	Store a 2d array as a table inside a virtual file.
clib.Session.virtualfile_from_vectors(*vectors)	Store 1d arrays as columns of a table inside a virtual file.
clib.Session.virtualfile_from_grid(grid)	Store a grid in a virtual file.

Low level access (these are mostly used by the pygmt.clib package):

clib.Session.create(name)	Create a new GMT C API session.
clib.Session.destroy()	Destroy the currently open GMT API session.
clib.Session.__getitem__(name)	Get the value of a GMT constant (C enum) from gmt_resources.h
clib.Session.__enter__()	Create a GMT API session and check the libgmt version.
clib.Session.__exit__(exc_type, exc_value, …)	Destroy the currently open GMT API session.
clib.Session.get_default(name)	Get the value of a GMT default parameter (library version, paths, etc).
clib.Session.create_data(family, geometry, …)	Create an empty GMT data container.
clib.Session.put_matrix(dataset, matrix[, pad])	Attach a numpy 2D array to a GMT dataset.
clib.Session.put_vector(dataset, column, vector)	Attach a numpy 1D array as a column on a GMT dataset.
clib.Session.write_data(family, geometry, …)	Write a GMT data container to a file.
clib.Session.open_virtual_file(family, …)	Open a GMT Virtual File to pass data to and from a module.
clib.Session.extract_region()	Extract the WESN bounding box of the currently active figure.
clib.Session.get_libgmt_func(name[, …])	Get a ctypes function from the libgmt shared library.