Skip to content

Document the default CPT for GMT remote datasets #2573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 4, 2023
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_age.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ def load_earth_age(resolution="01d", region=None, registration=None):
registration type (**p** for pixel registration or **g** for gridline
registration).

The default color palette table (CPT) for this dataset is *@earth_age.cpt*.
It's implicitly used when passing in the file name of the dataset to any
grid plotting method if no CPT is explicitly specified. When the dataset
is loaded and plotted as an :class:`xarray.DataArray` object, the default
CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
dataset-specific CPT, you need to explicitly set ``cmap="@earth_age.cpt"``.

Refer to :gmt-datasets:`earth-age.html` for more details.

Parameters
Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_free_air_anomaly.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None
registration type (**p** for pixel registration or **g** for gridline
registration).

The default color palette table (CPT) for this dataset is *@earth_faa.cpt*.
It's implicitly used when passing in the file name of the dataset to any
grid plotting method if no CPT is explicitly specified. When the dataset
is loaded and plotted as an :class:`xarray.DataArray` object, the default
CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
dataset-specific CPT, you need to explicitly set ``cmap="@earth_faa.cpt"``.

Refer to :gmt-datasets:`earth-faa.html` for more details.

Parameters
Expand Down
10 changes: 10 additions & 0 deletions pygmt/datasets/earth_magnetic_anomaly.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ def load_earth_magnetic_anomaly(
(see below), and *reg* is grid registration type (**p** for pixel
registration or **g** for gridline registration).

The default color palette tables (CPTs) for this dataset are
*@earth_mag.cpt* for ``data_source="emag2"`` and
``data_source="emag2_4km"``, and *@earth_wdmam.cpt* for
``data_source="wdmam"``. The dataset-specific CPT is implicitly used when
passing in the file name of the dataset to any grid plotting method if no
CPT is explicitly specified. When the dataset is loaded and plotted as an
:class:`xarray.DataArray` object, the default CPT is ignored and GMT's
default CPT (*turbo*) is used. To use the dataset-specific CPT, you need to
explicitly set ``cmap="@earth_mag.cpt"`` or ``cmap="@earth_wdmam.cpt"``.

Refer to :gmt-datasets:`earth-mag.html`
and :gmt-datasets:`earth-wdmam.html` for more details.

Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_relief.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ def load_earth_relief(
grid resolution (see below), and *reg* is grid registration type
(**p** for pixel registration or **g** for gridline registration).

The default color palette table (CPT) for this dataset is *geo*.
It's implicitly used when passing in the file name of the dataset to any
grid plotting method if no CPT is explicitly specified. When the dataset
is loaded and plotted as an :class:`xarray.DataArray` object, the default
CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
dataset-specific CPT, you need to explicitly set ``cmap="geo"``.

Refer to :gmt-datasets:`earth-relief.html` for more details about available
datasets, including version information and references.

Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_vertical_gravity_gradient.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ def load_earth_vertical_gravity_gradient(
registration type (**p** for pixel registration or **g** for gridline
registration).

The default color palette table (CPT) for this dataset is *@earth_vgg.cpt*.
It's implicitly used when passing in the file name of the dataset to any
grid plotting method if no CPT is explicitly specified. When the dataset
is loaded and plotted as an :class:`xarray.DataArray` object, the default
CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
dataset-specific CPT, you need to explicitly set ``cmap="@earth_vgg.cpt"``.

Refer to :gmt-datasets:`earth-vgg.html` for more details.

Parameters
Expand Down