improver.cli.collapse_realizations module

Script to collapse the realizations dimension of a cube.

process(cube, *, method='mean', new_name=None)

Collapse the realization dimension of a cube.

Parameters:

• cube (iris.cube.Cube) – Cube to be collapsed.

• method (str) – One of “sum”, “mean”, “median”, “std_dev”, “min”, “max”.

• new_name (str) – New name for output cube; if None use iris default.

Returns:

Collapsed cube. Dimensions are the same as input cube, without realization dimension.

Return type:

iris.cube.Cube

Raises:

ValueError – if realization is not a dimension coordinate.