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

load_earth_relief: Add import statement to inline examples #2229

Merged
merged 4 commits into from
Dec 7, 2022
Merged

load_earth_relief: Add import statement to inline examples #2229

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d6c77e
add import statement and explicitly define resolution argument
willschlitzer Dec 6, 2022
6d67f04
Add "__doctest_skip__ = ["load_earth_relief"]"
willschlitzer Dec 6, 2022
c4dc891
Apply suggestions from code review
willschlitzer Dec 7, 2022
079f584
Merge branch 'main' into earth-relief-example-update
willschlitzer Dec 7, 2022
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: 11 additions & 6 deletions pygmt/datasets/earth_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
from pygmt.exceptions import GMTInvalidInput, GMTVersionError
from pygmt.helpers import kwargs_to_strings

__doctest_skip__ = ["load_earth_relief"]


@kwargs_to_strings(region="sequence")
def load_earth_relief(
Expand Down Expand Up @@ -101,17 +103,20 @@ def load_earth_relief(
Examples
--------

>>> # load the default grid (gridline-registered 01d grid)
>>> from pygmt.datasets import load_earth_relief
>>> # load the default grid (gridline-registered 1 arc-degree grid)
>>> grid = load_earth_relief()
>>> # load the 30m grid with "gridline" registration
>>> grid = load_earth_relief("30m", registration="gridline")
>>> # load high-resolution grid for a specific region
>>> # load the 30 arc-minute grid with "gridline" registration
>>> grid = load_earth_relief(resolution="30m", registration="gridline")
>>> # load high-resolution (5 arc-minute) grid for a specific region
>>> grid = load_earth_relief(
... "05m", region=[120, 160, 30, 60], registration="gridline"
... resolution="05m",
... region=[120, 160, 30, 60],
... registration="gridline",
... )
>>> # load the original 3 arc-second land-only SRTM tiles from NASA
>>> grid = load_earth_relief(
... "03s",
... resolution="03s",
... region=[135, 136, 35, 36],
... registration="gridline",
... use_srtm=True,
Expand Down