wrapper
¶
A thin wrapper around xarray for reading and writing Ensemble Forecast Time Series (EFTS) data sets.
EftsDataSet
¶
Convenience class for access to a Ensemble Forecast Time Series in netCDF file.
Source code in src/efts_io/wrapper.py
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 |
|
create_data_variables
¶
Create data variables in the data set.
var_defs_dict["variable_1"].keys() dict_keys(['name', 'longname', 'units', 'dim_type', 'missval', 'precision', 'attributes'])
Source code in src/efts_io/wrapper.py
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 |
|
get_all_series
¶
Return a multivariate time series, where each column is the series for one of the identifiers.
Source code in src/efts_io/wrapper.py
171 172 173 174 175 176 177 178 |
|
get_dim_names
¶
Gets the name of all dimensions in the data set.
Source code in src/efts_io/wrapper.py
199 200 201 |
|
get_ensemble_for_stations
¶
get_ensemble_for_stations(
variable_name: str = "rain_sim",
identifier: Optional[str] = None,
dimension_id: str = ENS_MEMBER_DIMNAME,
start_time: Timestamp = None,
lead_time_count: Optional[int] = None,
) -> DataArray
Not yet implemented.
Source code in src/efts_io/wrapper.py
203 204 205 206 207 208 209 210 211 212 213 |
|
get_ensemble_forecasts
¶
get_ensemble_forecasts(
variable_name: str = "rain_sim",
identifier: Optional[str] = None,
dimension_id: Optional[str] = None,
start_time: Optional[Timestamp] = None,
lead_time_count: Optional[int] = None,
) -> DataArray
Gets an ensemble forecast for a variable.
Source code in src/efts_io/wrapper.py
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
|
get_ensemble_forecasts_for_station
¶
get_ensemble_forecasts_for_station(
variable_name: str = "rain_sim",
identifier: Optional[str] = None,
dimension_id: Optional[str] = None,
)
Return an array, representing all ensemble member forecasts for a single stations over all lead times.
Source code in src/efts_io/wrapper.py
254 255 256 257 258 259 260 261 262 263 264 |
|
get_ensemble_series
¶
get_ensemble_series(
variable_name: str = "rain_ens",
identifier: Optional[str] = None,
dimension_id: Optional[str] = None,
)
Return an ensemble of point time series for a station identifier.
Source code in src/efts_io/wrapper.py
266 267 268 269 270 271 272 273 274 275 276 |
|
get_ensemble_size
¶
get_ensemble_size()
Return the length of the ensemble size dimension.
Source code in src/efts_io/wrapper.py
278 279 280 |
|
get_lead_time_count
¶
get_lead_time_count()
Length of the lead time dimension.
Source code in src/efts_io/wrapper.py
282 283 284 |
|
get_lead_time_values
¶
get_lead_time_values()
Return the values of the lead time dimension.
Source code in src/efts_io/wrapper.py
286 287 288 |
|
get_single_series
¶
get_single_series(
variable_name: str = "rain_obs",
identifier: Optional[str] = None,
dimension_id: Optional[str] = None,
)
Return a single point time series for a station identifier.
Source code in src/efts_io/wrapper.py
294 295 296 297 298 299 300 301 302 303 304 |
|
get_station_count
¶
get_station_count() -> int
Return the number of stations in the data set.
Source code in src/efts_io/wrapper.py
306 307 308 |
|
get_stations_varname
¶
get_stations_varname() -> str
Return the name of the variable that has the station identifiers.
Source code in src/efts_io/wrapper.py
310 311 312 313 314 |
|
get_time_dim
¶
get_time_dim()
Return the time dimension variable as a vector of date-time stamps.
Source code in src/efts_io/wrapper.py
316 317 318 319 |
|
get_time_unit
¶
get_time_unit()
Return the time units of a read time series.
Source code in src/efts_io/wrapper.py
321 322 323 324 |
|
put_lead_time_values
¶
put_lead_time_values(values)
Set the values of the lead time dimension.
Source code in src/efts_io/wrapper.py
290 291 292 |
|
to_netcdf
¶
Write the data set to a netCDF file.
Source code in src/efts_io/wrapper.py
127 128 129 130 131 |
|
byte_to_string
¶
Convert a byte to a string.
Source code in src/efts_io/wrapper.py
42 43 44 45 46 47 48 49 50 |
|