gordias.util.units.change_precipitation_units

gordias.util.units.change_precipitation_units(cube_or_coord: Cube | Coord, new_unit: Unit, new_standard_name: str | None = None, integration_time: Unit = Unit('1 day'), density: Unit = Unit('1000 kg m-3')) → None

Convert precipitation unit considering standard names.

Converts precipitation units and data to requested units. Standard names are converted too, if required. Changes are made in-place.

Parameters:

• cube_or_coord (iris.cube.Cube | iris.coords.Coord) – Precipitation data.

• new_unit (cf_units.Unit) – Unit to convert to.

• new_standard_name (str | None, optional) – Standard name to convert to.

• integration_time (cf_units.Unit, optional) – Integration time for given data, if not included in unit. By default cf_units.Unit(“1 day”).

• density (cf_units.Unit, optional) – Density of medium. By default cf_units.Unit(“1000 kg m-3”)