Skip to content
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.

Sign up for GitHub

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

Add an inline example for load_earth_vertical_gravity_gradient #2356

Merged
merged 1 commit into from
Feb 10, 2023
Merged

Add an inline example for load_earth_vertical_gravity_gradient #2356

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions pygmt/datasets/earth_vertical_gravity_gradient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,23 @@ def load_earth_vertical_gravity_gradient(
The :class:`xarray.DataArray` grid doesn't support slice operation, for
Earth vertical gravity gradient grids with resolutions of 5 arc-minutes or
higher, which are stored as smaller tiles.

Examples
--------

>>> from pygmt.datasets import load_earth_vertical_gravity_gradient
>>> # load the default grid (gridline-registered 1 arc-degree grid)
>>> grid = load_earth_vertical_gravity_gradient()
>>> # load the 30 arc-minutes grid with "gridline" registration
>>> grid = load_earth_vertical_gravity_gradient(
... resolution="30m", registration="gridline"
... )
>>> # load high-resolution (5 arc-minutes) grid for a specific region
>>> grid = load_earth_vertical_gravity_gradient(
... resolution="05m",
... region=[120, 160, 30, 60],
... registration="gridline",
... )
"""
grid = _load_remote_dataset(
dataset_name="earth_vgg",
Expand Down