earth2studio.data.IFS_ENS_FX#
- class earth2studio.data.IFS_ENS_FX(source='aws', member=0, cache=True, verbose=True, async_timeout=600)[source]#
Integrated forecast system (IFS) ensemble (ENS) forecast data source on an equirectangular grid at 0.25 degree resolution. IFS is a forecast model developed by ECMWF. Data for the most recent 4 days can be retrieved from ECMWF’s servers (source ecmwf). Historical data is part of ECMWF’s open data project on AWS (source aws).
- Parameters:
source (str, optional) – Data source to fetch data from. For possible options refer to ECMWF’s open data Python SDK, by default “aws”.
member (int, optional) – Ensemble member id to use. If 0 the control forecast will be requested, if greater than 0 perturbed ensemble member will be requested, by default 0.
cache (bool, optional) – Cache data source in local memory, by default True.
verbose (bool, optional) – Print download progress, by default True.
async_timeout (int, optional) – Time in seconds after which the download will be cancelled if not finished successfully, by default 600.
Warning
This is a remote data source and can potentially download a large amount of data to your local machine for large requests.
Note
Additional information on the data repository can be referenced here:
- __call__(time, lead_time, variable)[source]#
Retrieve IFS ENS forecast data.
- Parameters:
time (datetime | list[datetime] | TimeArray) – Timestamps to return data for (UTC).
lead_time (timedelta | list[timedelta] | LeadTimeArray) – Forecast lead times to fetch.
variable (str | list[str] | VariableArray) – String, list of strings or array of strings that refer to variables to return. Must be in the data lexicon.
- Returns:
IFS ENS forecast data array
- Return type:
xr.DataArray
- async fetch(time, lead_time, variable)[source]#
Async function to get data.
- Parameters:
time (datetime | list[datetime] | TimeArray) – Timestamps to return data for (UTC).
lead_time (timedelta | list[timedelta] | LeadTimeArray) – Forecast lead times to fetch.
variable (str | list[str] | VariableArray) – String, list of strings or array of strings that refer to variables to return. Must be in the data lexicon.
- Returns:
IFS ENS forecast data array.
- Return type:
xr.DataArray