Skip to content

climate_ref_core.source_types #

Lightweight types for dataset source identification.

This module contains core type definitions that are used across the codebase but don't require heavy dependencies like pandas. Keeping these in a separate module allows other modules to import them without triggering heavy imports.

Selector = tuple[tuple[str, str], ...] module-attribute #

Type describing the key used to identify a group of datasets

This is a tuple of tuples, where each inner tuple contains a metadata and dimension value that was used to group the datasets together.

This type must be hashable, as it is used as a key in a dictionary.

SourceDatasetType #

Bases: Enum

Types of supported source datasets

Source code in packages/climate-ref-core/src/climate_ref_core/source_types.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class SourceDatasetType(enum.Enum):
    """
    Types of supported source datasets
    """

    CMIP6 = "cmip6"
    CMIP7 = "cmip7"
    obs4MIPs = "obs4mips"
    PMPClimatology = "pmp-climatology"

    @classmethod
    @functools.lru_cache(maxsize=1)
    def ordered(
        cls,
    ) -> list[Self]:
        """
        Order in alphabetical order according to their value.

        Returns
        -------
        :
            Ordered list of dataset types
        """
        return sorted(cls, key=lambda x: x.value)

ordered() cached classmethod #

Order in alphabetical order according to their value.

Returns:

Type Description
list[Self]

Ordered list of dataset types
Source code in packages/climate-ref-core/src/climate_ref_core/source_types.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@classmethod
@functools.lru_cache(maxsize=1)
def ordered(
    cls,
) -> list[Self]:
    """
    Order in alphabetical order according to their value.

    Returns
    -------
    :
        Ordered list of dataset types
    """
    return sorted(cls, key=lambda x: x.value)