icclim._core.model.standard_index

Contain the StandardIndex data class.

Module Contents

class icclim._core.model.standard_index.StandardIndex

Standard Index data class.

It is used to describe how a GenericIndicator should be setup to compute a climate index that has been defined in the literature (such as ECA&D’s ATBD document).

short_name

The index name used in the output.

Type:

str

compute

The function to compute the index. It usually wraps a xclim functions.

Type:

Callable

group

The index group category.

Type:

IndexGroup

variables

The Cf variables needed to compute the index. The variable are individually described by a list of aliases.

Type:

List[List[str]]

qualifiers

optional List of configuration to compute the index. Used internally to generate modules for C3S.

Type:

List[str] | None

source

Where the index definition comes from.

Type:

str | None

definition

A formal definition of the index. It should describe what kind of output the user is expected to obtain.

Type:

str | None

clone() → StandardIndex

Return a deep copy of the index.