Skip to content

Updated docstrings for area and volume statistics to work with fx variables definitions (PR 439 child 3) #509

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

Closed
valeriupredoi wants to merge 2 commits into from
Closed

Updated docstrings for area and volume statistics to work with fx variables definitions (PR 439 child 3) #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28da5b9
docstringing for PR 439 child
valeriupredoi Feb 21, 2020
83ec16b
docstringing for PR 439 child
valeriupredoi Feb 21, 2020
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
10 changes: 8 additions & 2 deletions esmvalcore/preprocessor/_area.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,15 +221,21 @@ def area_statistics(cube, operator, fx_files=None):
| `max` | Maximum value |
+------------+--------------------------------------------------+

If fx_files is provided, the variable's preprocessor chain will be applied
to each of the requested fx variables, up to and not including this step.

Parameters
----------
cube: iris.cube.Cube
Input cube.
operator: str
The operation, options: mean, median, min, max, std_dev, sum,
variance
fx_files: dict
dictionary of field:filename for the fx_files
fx_files: list
list of field:str short_name for the fx variables requested or
list of field:dict for the fx variables requested, including
but not limited to: keys: short_name, mip, experiment etc (at least
short_name required if dict)

Returns
-------
Expand Down
11 changes: 8 additions & 3 deletions esmvalcore/preprocessor/_volume.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,16 +176,21 @@ def volume_statistics(

The volume average is weighted acoording to the cell volume. Cell volume
is calculated from iris's cartography tool multiplied by the cell
thickness.
thickness. If fx_files is provided, the variable's preprocessor chain will
be applied to each of the requested fx variables, up to and not including
this step.

Parameters
----------
cube: iris.cube.Cube
Input cube.
operator: str
The operation to apply to the cube, options are: 'mean'.
fx_files: dict
dictionary of field:filename for the fx_files
fx_files: list
list of field:str short_name for the fx variables requested or
list of field:dict for the fx variables requested, including
but not limited to: keys: short_name, mip, experiment etc (at least
short_name required if dict)

Returns
-------
Expand Down