Skip to content

Commit

Permalink
Add an inline example for load_earth_vertical_gravity_gradient (#2356)
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman authored Feb 10, 2023
1 parent 79a8bfa commit 2c0aa84
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions pygmt/datasets/earth_vertical_gravity_gradient.py
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

0 comments on commit 2c0aa84

Please sign in to comment.