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 inline example for grdvolume #1726

Merged
merged 15 commits into from
Mar 16, 2022
Merged

Add inline example for grdvolume #1726

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5f2a4b9
add inline example to grdvolume.py
willschlitzer Feb 5, 2022
8a1f5d1
Update pygmt/src/grdvolume.py
willschlitzer Feb 11, 2022
3855b1a
Update pygmt/src/grdvolume.py
willschlitzer Mar 11, 2022
4564a05
update doctest skip format
willschlitzer Mar 11, 2022
0e58a82
Merge remote-tracking branch 'origin/inline-example/grdvolume' into i…
willschlitzer Mar 11, 2022
6de69d3
Merge branch 'main' into inline-example/grdvolume
willschlitzer Mar 11, 2022
ed458d9
Fix formatting
seisman Mar 11, 2022
f87c99b
Merge branch 'main' into inline-example/grdvolume
seisman Mar 11, 2022
4f69b86
Update pygmt/src/grdvolume.py
willschlitzer Mar 11, 2022
56dc7c6
Update pygmt/src/grdvolume.py
willschlitzer Mar 12, 2022
a022c11
Update pygmt/src/grdvolume.py
willschlitzer Mar 14, 2022
cc4b56f
Update pygmt/src/grdvolume.py
willschlitzer Mar 14, 2022
65703b3
Merge branch 'main' into inline-example/grdvolume
willschlitzer Mar 14, 2022
2f70141
Merge branch 'main' into inline-example/grdvolume
willschlitzer Mar 16, 2022
c3596ff
run make format
willschlitzer Mar 16, 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
27 changes: 26 additions & 1 deletion pygmt/src/grdvolume.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
use_alias,
)

__doctest_skip__ = ["grdvolume"]


@fmt_docstring
@use_alias(
Expand Down Expand Up @@ -74,7 +76,30 @@ def grdvolume(grid, output_type="pandas", outfile=None, **kwargs):
``outfile``)
- :class:`pandas.DataFrame` or :class:`numpy.ndarray` if ``outfile``
is not set (depends on ``output_type`` [Default is
class:`pandas.DataFrame`])
:class:`pandas.DataFrame`])

Example
-------
>>> import pygmt
>>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30
>>> # degrees, and a y-range of 15 to 25 degrees
>>> grid = pygmt.datasets.load_earth_relief(
... resolution="30m", region=[10, 30, 15, 25]
... )
>>> # Create a pandas dataframe that contains the contour, area, volume,
>>> # and maximum mean height above the plane specified by the given
>>> # contour and below the surface; set the minimum contour z-value to
>>> # 200, the maximum to 400, and the interval to 50.
>>> output_dataframe = pygmt.grdvolume(
... grid=grid, contour=[200, 400, 50], output_type="pandas"
... )
>>> print(output_dataframe)
0 1 2 3
0 200 2.144285e+12 7.972228e+14 371.789489
1 250 2.104042e+12 6.908183e+14 328.329232
2 300 2.014978e+12 5.877195e+14 291.675420
3 350 1.892109e+12 4.897545e+14 258.840510
4 400 1.744792e+12 3.988316e+14 228.584026
"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, we would have nice column names like in grdhisteq:

pygmt/pygmt/src/grdhisteq.py

Lines 301 to 309 in d85bfdf

>>> bins = pygmt.grdhisteq.compute_bins(grid=grid, divisions=5)
>>> print(bins)
start stop
bin_id
0 179.0 397.5
1 397.5 475.5
2 475.5 573.5
3 573.5 710.5
4 710.5 2103.0

But for the sake of time, and just finish this inline example, let's go with this:

Suggested change
"""
>>> print(output_dataframe)
0 1 2 3
0 200 2.144285e+12 7.972228e+14 371.789489
1 250 2.104042e+12 6.908183e+14 328.329232
2 300 2.014978e+12 5.877195e+14 291.675420
3 350 1.892109e+12 4.897545e+14 258.840510
4 400 1.744792e+12 3.988316e+14 228.584026
"""

if output_type not in ["numpy", "pandas", "file"]:
raise GMTInvalidInput(
Expand Down