From 28da5b92200722773b889cd95ac550502851211d Mon Sep 17 00:00:00 2001 From: Valeriu Predoi Date: Fri, 21 Feb 2020 15:22:44 +0000 Subject: [PATCH 1/2] docstringing for PR 439 child --- esmvalcore/preprocessor/_area.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/esmvalcore/preprocessor/_area.py b/esmvalcore/preprocessor/_area.py index 48f83c9212..9d26b2ac3f 100644 --- a/esmvalcore/preprocessor/_area.py +++ b/esmvalcore/preprocessor/_area.py @@ -221,6 +221,9 @@ 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 @@ -228,8 +231,11 @@ def area_statistics(cube, operator, fx_files=None): 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 ------- From 83ec16b1b0dc788ca1ceef7b8ee8c9a62333b423 Mon Sep 17 00:00:00 2001 From: Valeriu Predoi Date: Fri, 21 Feb 2020 15:22:53 +0000 Subject: [PATCH 2/2] docstringing for PR 439 child --- esmvalcore/preprocessor/_volume.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/esmvalcore/preprocessor/_volume.py b/esmvalcore/preprocessor/_volume.py index 4859b73639..0f0bb5ba66 100644 --- a/esmvalcore/preprocessor/_volume.py +++ b/esmvalcore/preprocessor/_volume.py @@ -176,7 +176,9 @@ 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 ---------- @@ -184,8 +186,11 @@ def volume_statistics( 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 -------