Skip to content

input4mips_validation.xarray_helpers.variables#

input4mips_validation.xarray_helpers.variables #

Helpers for determining what is and isn't a variable

XRVariableHelper #

Helper for processing the variables in an xarray object

This is required because the rules for handling bounds variables compared to data variables are not uniformly applied in xarray.

Source code in src/input4mips_validation/xarray_helpers/variables.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
@define
class XRVariableHelper:
    """
    Helper for processing the variables in an xarray object

    This is required because the rules for handling bounds variables
    compared to data variables are not uniformly applied in xarray.
    """

    bounds_coord_indicators: tuple[str, ...] = ("bounds", "bnds")
    """
    Strings that show that the variable represents bounds

    If any of these strings is found in the variable's name,
    it is assumed that the variable is a bounds variable.
    """

    climatology_bounds_coord_indicators: tuple[str, ...] = ("climatology",)
    """
    Strings that show that the variable represents climatology bounds

    If any of these strings is found in the variable's name,
    it is assumed that the variable is a climatology bounds variable.
    """

    def get_ds_bounds_variables(
        self,
        ds: xr.Dataset,
    ) -> tuple[str, ...]:
        """
        Get the bounds variables in a dataset

        Parameters
        ----------
        ds
            Dataset to check

        Returns
        -------
        :
            Bounds variables in the dataset.
        """
        return tuple(
            str(v)
            for v in ds.data_vars
            if any(bci in str(v) for bci in self.bounds_coord_indicators)
        )

    def get_ds_climatology_bounds_variables(
        self,
        ds: xr.Dataset,
    ) -> tuple[str, ...]:
        """
        Get the climatology bounds variables in a dataset

        Parameters
        ----------
        ds
            Dataset to check

        Returns
        -------
        :
            Climatology bounds variables in the dataset.
        """
        return tuple(
            str(v)
            for v in ds.data_vars
            if any(
                clim_i in str(v) for clim_i in self.climatology_bounds_coord_indicators
            )
        )

    def get_ds_variables(
        self,
        ds: xr.Dataset,
    ) -> tuple[str, ...]:
        """
        Get the variables in a dataset

        Parameters
        ----------
        ds
            Dataset to check

        Returns
        -------
        :
            Variables in the dataset, excluding bounds, climatology
            and non-number variables.
        """
        non_variables = (
            *self.get_ds_bounds_variables(ds),
            *self.get_ds_climatology_bounds_variables(ds),
            *(
                k
                for k, v in ds.data_vars.items()
                if not np.issubdtype(v.dtype, np.number)
            ),
        )

        return tuple(str(v) for v in ds.data_vars if v not in non_variables)

bounds_coord_indicators: tuple[str, ...] = ('bounds', 'bnds') class-attribute instance-attribute #

Strings that show that the variable represents bounds

If any of these strings is found in the variable's name, it is assumed that the variable is a bounds variable.

climatology_bounds_coord_indicators: tuple[str, ...] = ('climatology') class-attribute instance-attribute #

Strings that show that the variable represents climatology bounds

If any of these strings is found in the variable's name, it is assumed that the variable is a climatology bounds variable.

get_ds_bounds_variables(ds) #

Get the bounds variables in a dataset

Parameters:

Name Type Description Default
ds Dataset

Dataset to check

 required

Returns:

Type Description
tuple[str, ...]

Bounds variables in the dataset.
Source code in src/input4mips_validation/xarray_helpers/variables.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def get_ds_bounds_variables(
    self,
    ds: xr.Dataset,
) -> tuple[str, ...]:
    """
    Get the bounds variables in a dataset

    Parameters
    ----------
    ds
        Dataset to check

    Returns
    -------
    :
        Bounds variables in the dataset.
    """
    return tuple(
        str(v)
        for v in ds.data_vars
        if any(bci in str(v) for bci in self.bounds_coord_indicators)
    )

get_ds_climatology_bounds_variables(ds) #

Get the climatology bounds variables in a dataset

Parameters:

Name Type Description Default
ds Dataset

Dataset to check

 required

Returns:

Type Description
tuple[str, ...]

Climatology bounds variables in the dataset.
Source code in src/input4mips_validation/xarray_helpers/variables.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def get_ds_climatology_bounds_variables(
    self,
    ds: xr.Dataset,
) -> tuple[str, ...]:
    """
    Get the climatology bounds variables in a dataset

    Parameters
    ----------
    ds
        Dataset to check

    Returns
    -------
    :
        Climatology bounds variables in the dataset.
    """
    return tuple(
        str(v)
        for v in ds.data_vars
        if any(
            clim_i in str(v) for clim_i in self.climatology_bounds_coord_indicators
        )
    )

get_ds_variables(ds) #

Get the variables in a dataset

Parameters:

Name Type Description Default
ds Dataset

Dataset to check

 required

Returns:

Type Description
tuple[str, ...]

Variables in the dataset, excluding bounds, climatology and non-number variables.
Source code in src/input4mips_validation/xarray_helpers/variables.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def get_ds_variables(
    self,
    ds: xr.Dataset,
) -> tuple[str, ...]:
    """
    Get the variables in a dataset

    Parameters
    ----------
    ds
        Dataset to check

    Returns
    -------
    :
        Variables in the dataset, excluding bounds, climatology
        and non-number variables.
    """
    non_variables = (
        *self.get_ds_bounds_variables(ds),
        *self.get_ds_climatology_bounds_variables(ds),
        *(
            k
            for k, v in ds.data_vars.items()
            if not np.issubdtype(v.dtype, np.number)
        ),
    )

    return tuple(str(v) for v in ds.data_vars if v not in non_variables)

XRVariableProcessorLike #

Bases: Protocol

Interface for helpers for processing the variables in an xarray object

This is required because the rules for handling bounds variables compared to data variables are not uniformly applied in xarray. There are CF-rules, but these are not applied consistently in xarray hence we use this instead. We would use https://github.com/xarray-contrib/cf-xarray, but that just hard-codes the name "bounds", which doesn't work when the variable is saved as "bnds", which seems to be the case when we save with e.g. iris.

Source code in src/input4mips_validation/xarray_helpers/variables.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
class XRVariableProcessorLike(Protocol):
    """
    Interface for helpers for processing the variables in an xarray object

    This is required because the rules for handling bounds variables
    compared to data variables are not uniformly applied in xarray.
    There are CF-rules, but these are not applied consistently in xarray
    hence we use this instead.
    We would use https://github.com/xarray-contrib/cf-xarray,
    but that just hard-codes the name "bounds",
    which doesn't work when the variable is saved as "bnds",
    which seems to be the case when we save with e.g. iris.
    """

    def get_ds_bounds_variables(
        self,
        ds: xr.Dataset,
    ) -> tuple[str, ...]:
        """
        Get the bounds variables in a dataset

        Parameters
        ----------
        ds
            Dataset to check

        Returns
        -------
        :
            Bounds variables in the dataset.
        """

    def get_ds_climatology_bounds_variables(
        self,
        ds: xr.Dataset,
    ) -> tuple[str, ...]:
        """
        Get the climatology bounds variables in a dataset

        Parameters
        ----------
        ds
            Dataset to check

        Returns
        -------
        :
            Climatology bounds variables in the dataset.
        """

    def get_ds_variables(
        self,
        ds: xr.Dataset,
    ) -> tuple[str, ...]:
        """
        Get the variables in a dataset

        Parameters
        ----------
        ds
            Dataset to check

        Returns
        -------
        :
            Variables in the dataset, excluding bounds variables.
        """

get_ds_bounds_variables(ds) #

Get the bounds variables in a dataset

Parameters:

Name Type Description Default
ds Dataset

Dataset to check

 required

Returns:

Type Description
tuple[str, ...]

Bounds variables in the dataset.
Source code in src/input4mips_validation/xarray_helpers/variables.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def get_ds_bounds_variables(
    self,
    ds: xr.Dataset,
) -> tuple[str, ...]:
    """
    Get the bounds variables in a dataset

    Parameters
    ----------
    ds
        Dataset to check

    Returns
    -------
    :
        Bounds variables in the dataset.
    """

get_ds_climatology_bounds_variables(ds) #

Get the climatology bounds variables in a dataset

Parameters:

Name Type Description Default
ds Dataset

Dataset to check

 required

Returns:

Type Description
tuple[str, ...]

Climatology bounds variables in the dataset.
Source code in src/input4mips_validation/xarray_helpers/variables.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def get_ds_climatology_bounds_variables(
    self,
    ds: xr.Dataset,
) -> tuple[str, ...]:
    """
    Get the climatology bounds variables in a dataset

    Parameters
    ----------
    ds
        Dataset to check

    Returns
    -------
    :
        Climatology bounds variables in the dataset.
    """

get_ds_variables(ds) #

Get the variables in a dataset

Parameters:

Name Type Description Default
ds Dataset

Dataset to check

 required

Returns:

Type Description
tuple[str, ...]

Variables in the dataset, excluding bounds variables.
Source code in src/input4mips_validation/xarray_helpers/variables.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def get_ds_variables(
    self,
    ds: xr.Dataset,
) -> tuple[str, ...]:
    """
    Get the variables in a dataset

    Parameters
    ----------
    ds
        Dataset to check

    Returns
    -------
    :
        Variables in the dataset, excluding bounds variables.
    """