Skip to content

Add inline example for sph2grd #1718

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

Merged
merged 4 commits into from
Mar 6, 2022
Merged

Add inline example for sph2grd #1718

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
43efac2
add inline example for sph2grd.py
willschlitzer Feb 2, 2022
cac4bc3
Apply suggestions from code review
willschlitzer Feb 14, 2022
ce448dc
Merge branch 'main' into inline-example/sph2grd
willschlitzer Feb 27, 2022
797576f
Merge branch 'main' into inline-example/sph2grd
seisman Mar 5, 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
9 changes: 9 additions & 0 deletions pygmt/src/sph2grd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@ def sph2grd(data, **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
>>> # Create a new grid from the remote file "EGM96_to_36.txt",
>>> # set the grid spacing to 1, and the region to "g"
>>> new_grid = pygmt.sph2grd(
... data="@EGM96_to_36.txt", spacing=1, region="g"
... ) # doctest: +SKIP
"""
with GMTTempFile(suffix=".nc") as tmpfile:
with Session() as lib:
Expand Down