Skip to content

cmip_branded_variable_mapper.area_label#

Determination of the area label

Functions:

Name Description
get_area_label

Get area label

Attributes:

Name Type Description
AREA_LABEL_CELL_METHODS_MAPPER

Mapper from sub-strings of cell methods to the area label

AREA_LABEL_CELL_METHODS_MAPPER module-attribute #

AREA_LABEL_CELL_METHODS_MAPPER = from_unordered(
    {
        "over land and sea ice": "lsi",
        "air": "air",
        "cloud": "cl",
        "convective_cloud": "ccl",
        "crops": "crp",
        "floating_ice_shelf": "fis",
        "grounded_ice_sheet": "gis",
        "ice_free_sea": "ifs",
        "ice_sheet": "is",
        "land": "lnd",
        "land_ice": "li",
        "natural_grasses": "ng",
        "pastures": "pst",
        "sea": "sea",
        "sea_ice": "si",
        "sea_ice_melt_pond": "simp",
        "sea_ice_ridges": "sir",
        "sector": "multi",
        "shrubs": "shb",
        "snow": "sn",
        "stratiform_cloud": "scl",
        "trees": "tree",
        "unfrozen_soil": "ufs",
        "vegetation": "veg",
        "wetland": "wl",
    }
)

Mapper from sub-strings of cell methods to the area label

get_area_label #

get_area_label(
    cell_methods: str | None,
    cell_methods_mapper: CellMethodsSubStringMapperOrdered = AREA_LABEL_CELL_METHODS_MAPPER,
    fallback: str = "u",
) -> str

Get area label

The logic this should follow is defined in Table F4 of Taylor et al.. This was last checked on June 14 2025. If updates have been made since, this code may be out of date with the underlying specification.

Parameters:

Name Type Description Default
cell_methods str | None

Cell methods of the variable

 required
cell_methods_mapper CellMethodsSubStringMapperOrdered

Mapper to use to get values based on cell methods

 AREA_LABEL_CELL_METHODS_MAPPER
fallback str

Value to return if no other conditions are matched

 'u'

Returns:

Type Description
str

Area label to use for constructing the branded variable name
Source code in src/cmip_branded_variable_mapper/area_label.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def get_area_label(
    cell_methods: str | None,
    cell_methods_mapper: CellMethodsSubStringMapperOrdered = (
        AREA_LABEL_CELL_METHODS_MAPPER
    ),
    fallback: str = "u",
) -> str:
    """
    Get area label

    The logic this should follow is defined in Table F4 of
    [Taylor et al.](https://docs.google.com/document/d/19jzecgymgiiEsTDzaaqeLP6pTvLT-NzCMaq-wu-QoOc/edit?pli=1&tab=t.0).
    This was last checked on June 14 2025.
    If updates have been made since,
    this code may be out of date with the underlying specification.

    Parameters
    ----------
    cell_methods
        Cell methods of the variable

    cell_methods_mapper
        Mapper to use to get values based on cell methods

    fallback
        Value to return if no other conditions are matched

    Returns
    -------
    :
        Area label to use for constructing the branded variable name
    """
    if cell_methods is not None:
        if (match := cell_methods_mapper.get_value(cell_methods)) is not None:
            return match

    return fallback