improver.cli.wxcode_modal module

CLI to generate modal weather symbols over periods.

process(*cubes, model_id_attr=None, record_run_attr=None)[source]

Generates a modal weather symbol for the period covered by the input weather symbol cubes. Where there are different weather codes available for night and day, the modal code returned is always a day code, regardless of the times covered by the input files.

Parameters
  • cubes (iris.cube.CubeList) – A cubelist containing weather symbols cubes that cover the period over which a modal symbol is desired.

  • model_id_attr (str) – Name of attribute recording source models that should be inherited by the output cube. The source models are expected as a space-separated string.

  • record_run_attr (Optional[str]) – Name of attribute used to record models and cycles used in constructing the weather symbols.

Returns

A cube of modal weather symbols over a period.

Return type

iris.cube.Cube