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

Jump to bottom

Add inline example for grdsample #1724

Merged
merged 3 commits into from
Feb 20, 2022
Merged

Add inline example for grdsample #1724

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01dfc27
add inline example to grdsample.py
willschlitzer Feb 5, 2022
d955cc3
Update pygmt/src/grdsample.py
willschlitzer Feb 14, 2022
c43e593
Merge branch 'main' into inline-example/grdsample
willschlitzer Feb 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions pygmt/src/grdsample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,20 @@ def grdsample(grid, **kwargs):
- :class:`xarray.DataArray` if ``outgrid`` is not set
- None if ``outgrid`` is set (grid output will be stored in file set by
``outgrid``)

Example
-------
>>> import pygmt # doctest: +SKIP
>>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
>>> # and a y-range of 15 to 25
>>> grid = pygmt.datasets.load_earth_relief(
... resolution="30m", region=[10, 30, 15, 25]
... ) # doctest: +SKIP
>>> # Create a new grid from an input grid, change the registration,
>>> # and set both x- and y-spacing to 0.5 degrees
>>> new_grid = pygmt.grdsample(
... grid=grid, translate=True, spacing=[0.5, 0.5]
... ) # doctest: +SKIP
"""
with GMTTempFile(suffix=".nc") as tmpfile:
with Session() as lib:
Expand Down