icclim._core.model.index_group

Contain the IndexGroup class and the IndexGroupRegistry class.

Module Contents

class icclim._core.model.index_group.IndexGroup(name: str, values: list[IndexGroup] | None = None)

Class representing a group of climate indices.

Parameters:

• name (str) – The name of the index group.

• values (list[IndexGroup] | None, optional) – The list of index groups contained within this group. Defaults to None.

name

The name of the index group.

Type:

str

values

The list of index groups contained within this group.

Type:

list[IndexGroup]

get_indices() → list[Any]

Get the list of indices belonging to this group.

Returns:

The list of indices belonging to this group.

Return type:

list[Any]

Notes

The list of indices is obtained by filtering the EcadIndexRegistry values. The others indices are not considered.

class icclim._core.model.index_group.IndexGroupRegistry

Registry for IndexGroup instances.