earth2studio.data.GEFS_FX#
- class earth2studio.data.GEFS_FX(member='gec00', max_workers=24, cache=True, verbose=True, async_timeout=600)[source]#
The Global Ensemble Forecast System (GEFS) forecast source is a 30 member ensemble forecast provided on an 0.5 degree equirectangular grid. GEFS is a weather forecast model developed by National Centers for Environmental Prediction (NCEP). This forecast source has data at 6-hour intervals spanning from Sept 23rd 2020 to present date. Each forecast provides 3-hourly predictions up to 10 days (240 hours) and 6 hourly predictions for another 6 days (384 hours).
- Parameters:
member (str, optional) – GEFS member. Options are: control gec00 (control), gepNN (forecast member NN, e.g. gep01, gep02,…), by default “gec00”
max_workers (int, optional) – Max works in async io thread pool. Only applied when using sync call function and will modify the default async loop if one exists, by default 24
cache (bool, optional) – Cache data source on local memory, by default True
verbose (bool, optional) – Print download progress, by default True
async_timeout (int, optional) – Time in sec after which 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.
Warning
Some variables in the GEFS lexicon may not be available at lead time 0. Consult GEFS documentation for additional information.
Note
Additional information on the data repository can be referenced here:
- __call__(time, lead_time, variable)[source]#
Retrieve GEFS 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 GEFS lexicon.
- Returns:
GEFS 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 GEFS FX lexicon.
- Returns:
GEFS forecast data array
- Return type:
xr.DataArray