GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
758 stars 220 forks source link

Add a tutorial explaining the generally accepted input types #1268

Open seisman opened 3 years ago

seisman commented 3 years ago

Inspired by PR #1186.

For GMT CLI, there are mainly two types of input: a table or a grid. PyGMT is more powerful and can accept more input types.

For a table input, PyGMT functions generally accept the following input types:

For a grid input, PyGMT functions generally accept the following input types:

Although these various input data types are already used in different tutorials and examples, I think it would be better to have a standalone tutorial, explaining these input types.

weiji14 commented 2 years ago

Also should mention that plotting shapefiles directly using plot and plot3d (maybe others too?) is supported. Xref #1616 and https://docs.generic-mapping-tools.org/6.3/cookbook/file-formats.html?highlight=shapefile#shapefiles

seisman commented 2 years ago

pathlib.Path support was added in https://github.com/GenericMappingTools/pygmt/pull/1382.

weiji14 commented 1 year ago

Working on supporting 3-band xarray.DataArray inputs at #2590, this would be in addition to regular 1-band xarray.DataArray inputs (e.g. DEMs).