Skip to content

Variable reference

Source code in c3s_event_attribution_tools/data/variable.py 
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 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
 81
 82
 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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
class Variable:
    class CMIP5Monthly(Enum):
        temperature_2m = 1 # 2 meter temperature

        def cds_name(self) -> str:
            """
            Get the corresponding CDS variable name.

            Returns:
                str: The CDS variable name.
            """
            translation_dict = {
                Variable.CMIP5Monthly.temperature_2m: '2m_temperature',
            }
            return translation_dict[self]

        def column_name(self) -> str:
            """
            Get the corresponding column name for dataframes.

            Returns:
                str: The column name.
            """
            translation_dict = {
                Variable.CMIP5Monthly.temperature_2m: 't2m',
            }
            return translation_dict[self]

    class CMIP6(Enum):
        near_surface_air_temperature = 1 # near surface air temperature
        daily_maximum_near_surface_air_temperature = 2 # maximum daily near surface air temperature
        daily_minimum_near_surface_air_temperature = 3 # minimum daily near surface air temperature
        precipitation = 4 # precipitation

        def cds_name(self) -> str:
            """
            Get the corresponding CDS variable name.

            Returns:
                str: The CDS variable name.
            """
            translation_dict = {
                Variable.CMIP6.near_surface_air_temperature: 'near_surface_air_temperature',
                Variable.CMIP6.daily_maximum_near_surface_air_temperature: 'daily_maximum_near_surface_air_temperature',
                Variable.CMIP6.daily_minimum_near_surface_air_temperature: 'daily_minimum_near_surface_air_temperature',
                Variable.CMIP6.precipitation: 'precipitation',
            }
            return translation_dict[self]

        def column_name(self) -> str:
            """
            Get the corresponding column name for dataframes.

            Returns:
                str: The column name.
            """
            translation_dict = {
                Variable.CMIP6.near_surface_air_temperature: 'tas',
                Variable.CMIP6.daily_maximum_near_surface_air_temperature: 'tasmax',
                Variable.CMIP6.daily_minimum_near_surface_air_temperature: 'tasmin',
                Variable.CMIP6.precipitation: 'pr',
            }
            return translation_dict[self]

    class ERA5DailySingleLevel(Enum):
        temperature_2m_mean = 1 # 2 meter temperature mean
        temperature_2m_max = 2 # 2 meter temperature max
        temperature_2m_min = 3 # 2 meter temperature min
        total_precipitation = 4 # total precipitation
        mean_sea_level_pressure = 5 # mean sea level pressure

        def cds_name(self) -> str:
            """
            Get the corresponding CDS variable name.

            Returns:
                str: The CDS variable name.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: '2m_temperature',
                Variable.ERA5DailySingleLevel.temperature_2m_max: '2m_temperature',
                Variable.ERA5DailySingleLevel.temperature_2m_min: '2m_temperature',
                Variable.ERA5DailySingleLevel.total_precipitation: 'total_precipitation',
                Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'mean_sea_level_pressure',
            }
            return translation_dict[self]

        def cds_daily_statistic(self) -> str:
            """
            Get the corresponding CDS daily statistic name.

            Returns:
                str: The CDS daily statistic name.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: 'daily_mean',
                Variable.ERA5DailySingleLevel.temperature_2m_max: 'daily_maximum',
                Variable.ERA5DailySingleLevel.temperature_2m_min: 'daily_minimum',
                Variable.ERA5DailySingleLevel.total_precipitation: 'daily_sum',
                Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'daily_mean',
            }
            return translation_dict[self]

        def cds_variable_renames(self) -> dict[str, str]:
            """
            Get the renaming dictionary for CDS variable names to standard names.

            Returns:
                dict: A dictionary mapping CDS variable names to standard names.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: {'t2m': 't2m'},
                Variable.ERA5DailySingleLevel.total_precipitation: {'tp': 'tp'},
                Variable.ERA5DailySingleLevel.temperature_2m_min: {'t2m': 't2m'},
                Variable.ERA5DailySingleLevel.temperature_2m_max: {'t2m': 't2m'},
            }
            return translation_dict[self]

        def column_name(self) -> str:
            """
            Get the corresponding column name for dataframes.

            Returns:
                str: The column name.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
                Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m', 
                Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m', 
                Variable.ERA5DailySingleLevel.total_precipitation: 'tp',
                Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
            }
            return translation_dict[self]

        def beacon_name(self) -> str:
            """
            Get the corresponding Beacon variable name.

            Returns:
                str: The Beacon variable name.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
                Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m_max',
                Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m_min',
                Variable.ERA5DailySingleLevel.total_precipitation: 'total_precipitation',
                Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
            }
            return translation_dict[self]

        def beacon_alias(self) -> str:
            """
            Get the corresponding Beacon alias for the variable.

            Returns:
                str: The Beacon alias.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
                Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m',
                Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m',
                Variable.ERA5DailySingleLevel.total_precipitation: 'tp',
                Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
            }
            return translation_dict[self]

        def beacon_variable_renames(self) -> dict[str, str]:
            """
            Get the renaming dictionary for CDS variable names to standard names.

            Returns:
                dict: A dictionary mapping CDS variable names to standard names.
            """
            translation_dict = {
                Variable.ERA5DailySingleLevel.temperature_2m_mean: {'t2m': 't2m'},
                Variable.ERA5DailySingleLevel.total_precipitation: {'total_precipitation': 'tp'},
                Variable.ERA5DailySingleLevel.temperature_2m_min: {'t2m_min': 't2m'},
                Variable.ERA5DailySingleLevel.temperature_2m_max: {'t2m_max': 't2m'},
            }
            return translation_dict[self]

    class ERA5DailyPressureLevels(Enum):
        geopotential = 1 # geopotential

        def cds_name(self) -> str:
            """
            Get the corresponding CDS variable name.

            Returns:
                str: The CDS variable name.
            """
            translation_dict = {
                Variable.ERA5DailyPressureLevels.geopotential: 'geopotential',
            }
            return translation_dict[self]

        def beacon_name(self) -> str:
            """
            Get the corresponding Beacon variable name.

            Returns:
                str: The Beacon variable name.
            """
            translation_dict = {
                Variable.ERA5DailyPressureLevels.geopotential: 'z',
            }
            return translation_dict[self]

        def cds_daily_statistic(self) -> str:
            """
            Get the corresponding CDS daily statistic name.

            Returns:
                str: The CDS daily statistic name.
            """
            translation_dict = {
                Variable.ERA5DailyPressureLevels.geopotential: 'daily_mean',
            }
            return translation_dict[self]

        def column_name(self) -> str:
            """
            Get the corresponding column name for dataframes.

            Returns:
                str: The column name.
            """
            translation_dict = {
                Variable.ERA5DailyPressureLevels.geopotential: 'z',
            }
            return translation_dict[self]

CMIP5Monthly

Bases: Enum

Source code in c3s_event_attribution_tools/data/variable.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class CMIP5Monthly(Enum):
    temperature_2m = 1 # 2 meter temperature

    def cds_name(self) -> str:
        """
        Get the corresponding CDS variable name.

        Returns:
            str: The CDS variable name.
        """
        translation_dict = {
            Variable.CMIP5Monthly.temperature_2m: '2m_temperature',
        }
        return translation_dict[self]

    def column_name(self) -> str:
        """
        Get the corresponding column name for dataframes.

        Returns:
            str: The column name.
        """
        translation_dict = {
            Variable.CMIP5Monthly.temperature_2m: 't2m',
        }
        return translation_dict[self]

cds_name()

Get the corresponding CDS variable name.

Returns:

Name Type Description
str str

The CDS variable name.
Source code in c3s_event_attribution_tools/data/variable.py 
 7
 8
 9
10
11
12
13
14
15
16
17
def cds_name(self) -> str:
    """
    Get the corresponding CDS variable name.

    Returns:
        str: The CDS variable name.
    """
    translation_dict = {
        Variable.CMIP5Monthly.temperature_2m: '2m_temperature',
    }
    return translation_dict[self]

column_name()

Get the corresponding column name for dataframes.

Returns:

Name Type Description
str str

The column name.
Source code in c3s_event_attribution_tools/data/variable.py 
19
20
21
22
23
24
25
26
27
28
29
def column_name(self) -> str:
    """
    Get the corresponding column name for dataframes.

    Returns:
        str: The column name.
    """
    translation_dict = {
        Variable.CMIP5Monthly.temperature_2m: 't2m',
    }
    return translation_dict[self]

CMIP6

Bases: Enum

Source code in c3s_event_attribution_tools/data/variable.py 
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
class CMIP6(Enum):
    near_surface_air_temperature = 1 # near surface air temperature
    daily_maximum_near_surface_air_temperature = 2 # maximum daily near surface air temperature
    daily_minimum_near_surface_air_temperature = 3 # minimum daily near surface air temperature
    precipitation = 4 # precipitation

    def cds_name(self) -> str:
        """
        Get the corresponding CDS variable name.

        Returns:
            str: The CDS variable name.
        """
        translation_dict = {
            Variable.CMIP6.near_surface_air_temperature: 'near_surface_air_temperature',
            Variable.CMIP6.daily_maximum_near_surface_air_temperature: 'daily_maximum_near_surface_air_temperature',
            Variable.CMIP6.daily_minimum_near_surface_air_temperature: 'daily_minimum_near_surface_air_temperature',
            Variable.CMIP6.precipitation: 'precipitation',
        }
        return translation_dict[self]

    def column_name(self) -> str:
        """
        Get the corresponding column name for dataframes.

        Returns:
            str: The column name.
        """
        translation_dict = {
            Variable.CMIP6.near_surface_air_temperature: 'tas',
            Variable.CMIP6.daily_maximum_near_surface_air_temperature: 'tasmax',
            Variable.CMIP6.daily_minimum_near_surface_air_temperature: 'tasmin',
            Variable.CMIP6.precipitation: 'pr',
        }
        return translation_dict[self]

cds_name()

Get the corresponding CDS variable name.

Returns:

Name Type Description
str str

The CDS variable name.
Source code in c3s_event_attribution_tools/data/variable.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def cds_name(self) -> str:
    """
    Get the corresponding CDS variable name.

    Returns:
        str: The CDS variable name.
    """
    translation_dict = {
        Variable.CMIP6.near_surface_air_temperature: 'near_surface_air_temperature',
        Variable.CMIP6.daily_maximum_near_surface_air_temperature: 'daily_maximum_near_surface_air_temperature',
        Variable.CMIP6.daily_minimum_near_surface_air_temperature: 'daily_minimum_near_surface_air_temperature',
        Variable.CMIP6.precipitation: 'precipitation',
    }
    return translation_dict[self]

column_name()

Get the corresponding column name for dataframes.

Returns:

Name Type Description
str str

The column name.
Source code in c3s_event_attribution_tools/data/variable.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def column_name(self) -> str:
    """
    Get the corresponding column name for dataframes.

    Returns:
        str: The column name.
    """
    translation_dict = {
        Variable.CMIP6.near_surface_air_temperature: 'tas',
        Variable.CMIP6.daily_maximum_near_surface_air_temperature: 'tasmax',
        Variable.CMIP6.daily_minimum_near_surface_air_temperature: 'tasmin',
        Variable.CMIP6.precipitation: 'pr',
    }
    return translation_dict[self]

ERA5DailyPressureLevels

Bases: Enum

Source code in c3s_event_attribution_tools/data/variable.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
class ERA5DailyPressureLevels(Enum):
    geopotential = 1 # geopotential

    def cds_name(self) -> str:
        """
        Get the corresponding CDS variable name.

        Returns:
            str: The CDS variable name.
        """
        translation_dict = {
            Variable.ERA5DailyPressureLevels.geopotential: 'geopotential',
        }
        return translation_dict[self]

    def beacon_name(self) -> str:
        """
        Get the corresponding Beacon variable name.

        Returns:
            str: The Beacon variable name.
        """
        translation_dict = {
            Variable.ERA5DailyPressureLevels.geopotential: 'z',
        }
        return translation_dict[self]

    def cds_daily_statistic(self) -> str:
        """
        Get the corresponding CDS daily statistic name.

        Returns:
            str: The CDS daily statistic name.
        """
        translation_dict = {
            Variable.ERA5DailyPressureLevels.geopotential: 'daily_mean',
        }
        return translation_dict[self]

    def column_name(self) -> str:
        """
        Get the corresponding column name for dataframes.

        Returns:
            str: The column name.
        """
        translation_dict = {
            Variable.ERA5DailyPressureLevels.geopotential: 'z',
        }
        return translation_dict[self]

beacon_name()

Get the corresponding Beacon variable name.

Returns:

Name Type Description
str str

The Beacon variable name.
Source code in c3s_event_attribution_tools/data/variable.py 
199
200
201
202
203
204
205
206
207
208
209
def beacon_name(self) -> str:
    """
    Get the corresponding Beacon variable name.

    Returns:
        str: The Beacon variable name.
    """
    translation_dict = {
        Variable.ERA5DailyPressureLevels.geopotential: 'z',
    }
    return translation_dict[self]

cds_daily_statistic()

Get the corresponding CDS daily statistic name.

Returns:

Name Type Description
str str

The CDS daily statistic name.
Source code in c3s_event_attribution_tools/data/variable.py 
211
212
213
214
215
216
217
218
219
220
221
def cds_daily_statistic(self) -> str:
    """
    Get the corresponding CDS daily statistic name.

    Returns:
        str: The CDS daily statistic name.
    """
    translation_dict = {
        Variable.ERA5DailyPressureLevels.geopotential: 'daily_mean',
    }
    return translation_dict[self]

cds_name()

Get the corresponding CDS variable name.

Returns:

Name Type Description
str str

The CDS variable name.
Source code in c3s_event_attribution_tools/data/variable.py 
187
188
189
190
191
192
193
194
195
196
197
def cds_name(self) -> str:
    """
    Get the corresponding CDS variable name.

    Returns:
        str: The CDS variable name.
    """
    translation_dict = {
        Variable.ERA5DailyPressureLevels.geopotential: 'geopotential',
    }
    return translation_dict[self]

column_name()

Get the corresponding column name for dataframes.

Returns:

Name Type Description
str str

The column name.
Source code in c3s_event_attribution_tools/data/variable.py 
223
224
225
226
227
228
229
230
231
232
233
def column_name(self) -> str:
    """
    Get the corresponding column name for dataframes.

    Returns:
        str: The column name.
    """
    translation_dict = {
        Variable.ERA5DailyPressureLevels.geopotential: 'z',
    }
    return translation_dict[self]

ERA5DailySingleLevel

Bases: Enum

Source code in c3s_event_attribution_tools/data/variable.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 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
class ERA5DailySingleLevel(Enum):
    temperature_2m_mean = 1 # 2 meter temperature mean
    temperature_2m_max = 2 # 2 meter temperature max
    temperature_2m_min = 3 # 2 meter temperature min
    total_precipitation = 4 # total precipitation
    mean_sea_level_pressure = 5 # mean sea level pressure

    def cds_name(self) -> str:
        """
        Get the corresponding CDS variable name.

        Returns:
            str: The CDS variable name.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: '2m_temperature',
            Variable.ERA5DailySingleLevel.temperature_2m_max: '2m_temperature',
            Variable.ERA5DailySingleLevel.temperature_2m_min: '2m_temperature',
            Variable.ERA5DailySingleLevel.total_precipitation: 'total_precipitation',
            Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'mean_sea_level_pressure',
        }
        return translation_dict[self]

    def cds_daily_statistic(self) -> str:
        """
        Get the corresponding CDS daily statistic name.

        Returns:
            str: The CDS daily statistic name.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: 'daily_mean',
            Variable.ERA5DailySingleLevel.temperature_2m_max: 'daily_maximum',
            Variable.ERA5DailySingleLevel.temperature_2m_min: 'daily_minimum',
            Variable.ERA5DailySingleLevel.total_precipitation: 'daily_sum',
            Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'daily_mean',
        }
        return translation_dict[self]

    def cds_variable_renames(self) -> dict[str, str]:
        """
        Get the renaming dictionary for CDS variable names to standard names.

        Returns:
            dict: A dictionary mapping CDS variable names to standard names.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: {'t2m': 't2m'},
            Variable.ERA5DailySingleLevel.total_precipitation: {'tp': 'tp'},
            Variable.ERA5DailySingleLevel.temperature_2m_min: {'t2m': 't2m'},
            Variable.ERA5DailySingleLevel.temperature_2m_max: {'t2m': 't2m'},
        }
        return translation_dict[self]

    def column_name(self) -> str:
        """
        Get the corresponding column name for dataframes.

        Returns:
            str: The column name.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
            Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m', 
            Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m', 
            Variable.ERA5DailySingleLevel.total_precipitation: 'tp',
            Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
        }
        return translation_dict[self]

    def beacon_name(self) -> str:
        """
        Get the corresponding Beacon variable name.

        Returns:
            str: The Beacon variable name.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
            Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m_max',
            Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m_min',
            Variable.ERA5DailySingleLevel.total_precipitation: 'total_precipitation',
            Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
        }
        return translation_dict[self]

    def beacon_alias(self) -> str:
        """
        Get the corresponding Beacon alias for the variable.

        Returns:
            str: The Beacon alias.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
            Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m',
            Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m',
            Variable.ERA5DailySingleLevel.total_precipitation: 'tp',
            Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
        }
        return translation_dict[self]

    def beacon_variable_renames(self) -> dict[str, str]:
        """
        Get the renaming dictionary for CDS variable names to standard names.

        Returns:
            dict: A dictionary mapping CDS variable names to standard names.
        """
        translation_dict = {
            Variable.ERA5DailySingleLevel.temperature_2m_mean: {'t2m': 't2m'},
            Variable.ERA5DailySingleLevel.total_precipitation: {'total_precipitation': 'tp'},
            Variable.ERA5DailySingleLevel.temperature_2m_min: {'t2m_min': 't2m'},
            Variable.ERA5DailySingleLevel.temperature_2m_max: {'t2m_max': 't2m'},
        }
        return translation_dict[self]

beacon_alias()

Get the corresponding Beacon alias for the variable.

Returns:

Name Type Description
str str

The Beacon alias.
Source code in c3s_event_attribution_tools/data/variable.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def beacon_alias(self) -> str:
    """
    Get the corresponding Beacon alias for the variable.

    Returns:
        str: The Beacon alias.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
        Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m',
        Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m',
        Variable.ERA5DailySingleLevel.total_precipitation: 'tp',
        Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
    }
    return translation_dict[self]

beacon_name()

Get the corresponding Beacon variable name.

Returns:

Name Type Description
str str

The Beacon variable name.
Source code in c3s_event_attribution_tools/data/variable.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
def beacon_name(self) -> str:
    """
    Get the corresponding Beacon variable name.

    Returns:
        str: The Beacon variable name.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
        Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m_max',
        Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m_min',
        Variable.ERA5DailySingleLevel.total_precipitation: 'total_precipitation',
        Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
    }
    return translation_dict[self]

beacon_variable_renames()

Get the renaming dictionary for CDS variable names to standard names.

Returns:

Name Type Description
dict dict[str, str]

A dictionary mapping CDS variable names to standard names.
Source code in c3s_event_attribution_tools/data/variable.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def beacon_variable_renames(self) -> dict[str, str]:
    """
    Get the renaming dictionary for CDS variable names to standard names.

    Returns:
        dict: A dictionary mapping CDS variable names to standard names.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: {'t2m': 't2m'},
        Variable.ERA5DailySingleLevel.total_precipitation: {'total_precipitation': 'tp'},
        Variable.ERA5DailySingleLevel.temperature_2m_min: {'t2m_min': 't2m'},
        Variable.ERA5DailySingleLevel.temperature_2m_max: {'t2m_max': 't2m'},
    }
    return translation_dict[self]

cds_daily_statistic()

Get the corresponding CDS daily statistic name.

Returns:

Name Type Description
str str

The CDS daily statistic name.
Source code in c3s_event_attribution_tools/data/variable.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def cds_daily_statistic(self) -> str:
    """
    Get the corresponding CDS daily statistic name.

    Returns:
        str: The CDS daily statistic name.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: 'daily_mean',
        Variable.ERA5DailySingleLevel.temperature_2m_max: 'daily_maximum',
        Variable.ERA5DailySingleLevel.temperature_2m_min: 'daily_minimum',
        Variable.ERA5DailySingleLevel.total_precipitation: 'daily_sum',
        Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'daily_mean',
    }
    return translation_dict[self]

cds_name()

Get the corresponding CDS variable name.

Returns:

Name Type Description
str str

The CDS variable name.
Source code in c3s_event_attribution_tools/data/variable.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def cds_name(self) -> str:
    """
    Get the corresponding CDS variable name.

    Returns:
        str: The CDS variable name.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: '2m_temperature',
        Variable.ERA5DailySingleLevel.temperature_2m_max: '2m_temperature',
        Variable.ERA5DailySingleLevel.temperature_2m_min: '2m_temperature',
        Variable.ERA5DailySingleLevel.total_precipitation: 'total_precipitation',
        Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'mean_sea_level_pressure',
    }
    return translation_dict[self]

cds_variable_renames()

Get the renaming dictionary for CDS variable names to standard names.

Returns:

Name Type Description
dict dict[str, str]

A dictionary mapping CDS variable names to standard names.
Source code in c3s_event_attribution_tools/data/variable.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def cds_variable_renames(self) -> dict[str, str]:
    """
    Get the renaming dictionary for CDS variable names to standard names.

    Returns:
        dict: A dictionary mapping CDS variable names to standard names.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: {'t2m': 't2m'},
        Variable.ERA5DailySingleLevel.total_precipitation: {'tp': 'tp'},
        Variable.ERA5DailySingleLevel.temperature_2m_min: {'t2m': 't2m'},
        Variable.ERA5DailySingleLevel.temperature_2m_max: {'t2m': 't2m'},
    }
    return translation_dict[self]

column_name()

Get the corresponding column name for dataframes.

Returns:

Name Type Description
str str

The column name.
Source code in c3s_event_attribution_tools/data/variable.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def column_name(self) -> str:
    """
    Get the corresponding column name for dataframes.

    Returns:
        str: The column name.
    """
    translation_dict = {
        Variable.ERA5DailySingleLevel.temperature_2m_mean: 't2m',
        Variable.ERA5DailySingleLevel.temperature_2m_max: 't2m', 
        Variable.ERA5DailySingleLevel.temperature_2m_min: 't2m', 
        Variable.ERA5DailySingleLevel.total_precipitation: 'tp',
        Variable.ERA5DailySingleLevel.mean_sea_level_pressure: 'msl',
    }
    return translation_dict[self]