pygmt.datasets.load_sample_data

pygmt.datasets.load_sample_data(name)

Load an example dataset from the GMT server.

The data are downloaded to a cache directory (usually ~/.gmt/cache) the first time you invoke this function. Afterwards, it will load the data from the cache. So you’ll need an internet connection the first time around.

Parameters

name (str) – Name of the dataset to load.

Returns

pandas.DataFrame or xarray.DataArray – Sample dataset loaded as a pandas.DataFrame for tabular data or xarray.DataArray for raster data.

See also

list_sample_data

Report datasets available for tests and documentation examples.