Skip to content

Commit 75ff3a2

Browse files
committed
add docstring for grdvolume
1 parent 97adf31 commit 75ff3a2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

pygmt/src/grdvolume.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
@kwargs_to_strings(C="sequence", R="sequence")
2727
def grdvolume(grid, data_format="a", **kwargs):
2828
r"""
29+
Read a 2-D grid file and calculate the volume contained below the surface
30+
and above the plane specified by the given contour (or zero if not given)
31+
and return the contour, area, volume, and maximum mean height
32+
(volume/area). Alternatively, a range of contours can be specified to
33+
return the volume and area inside the contour for all contour values.
34+
Using **-T**, the contour that produced the maximum mean height
35+
(or maximum curvature of heights vs contour value) is returned as well.
36+
2937
{aliases}
3038
3139
Parameters

0 commit comments

Comments
 (0)