icclim._core.model.standard_variable

Define the StandardVariable class and the StandardVariableRegistry class.

The StandardVariable class represents a standard variable used in climate data analysis. The StandardVariableRegistry class is a registry that stores instances of StandardVariable.

StandardVariable are mainly used to compute the metadata of the output of the generic indices.

Module Contents

class icclim._core.model.standard_variable.StandardVariable

StandardVariable represents a typical variable used in climate data analysis.

Parameters:

• short_name (str) – The short name of the variable.

• standard_name (str) – The standard name of the variable.

• long_name (str) – The long name of the variable.

• aliases (list[str]) – A list of aliases for the variable.

• default_units (str) – The default units of the variable.

get_metadata() → dict[str, str]

Get the metadata of the StandardVariable object.

class icclim._core.model.standard_variable.StandardVariableRegistry

StandardVariableRegistry stores instances of StandardVariable such as PR, TAS.

static get_item_aliases(item: StandardVariable) → list[str]

Return a list of aliases for the given StandardVariable.

Parameters:

item (StandardVariable) – The StandardVariable object for which to retrieve the aliases.

Returns:

A list of aliases for the given StandardVariable.

Return type:

list[str]