Skip to content

data.GEFS_FX_721x1440

Global

Import path: earth2studio.data.GEFS_FX_721x1440

View source on GitHub

Documentation

Bases: GEFS_FX

The Global Ensemble Forecast System (GEFS) forecast source is a 30 member ensemble forecast provided on an 0.25 degree equirectangular grid. GEFS is a weather forecast model developed by National Centers for Environmental Prediction (NCEP). This data source provides the select variables of GEFS served on a higher resolution grid t 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, default: 'gec00' ) –

    GEFS member. Options are: control gec00 (control), gepNN (forecast member NN, e.g. gep01, gep02,...), by default "gec00"

  • max_workers (int, default: 24 ) –

    Deprecated, use async_workers instead. Kept for API compatibility, by default 24

  • cache (bool, default: True ) –

    Cache data source on local memory, by default True

  • verbose (bool, default: True ) –

    Print download progress, by default True

  • async_timeout (int, default: 600 ) –

    Time in sec after which download will be cancelled if not finished successfully, by default 600

  • async_workers (int, default: None ) –

    Maximum number of concurrent downloads. By default None, which autoscales to the number of download tasks (capped at 64)

  • retries (int, default: 3 ) –

    Number of retries for each download task on transient errors, by default 3

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

NCEP only provides a small subset of variables on the higher resoluton 0.25 degree grid. For a larger selection, use the standard GEFS data source.

Note

Additional information on the data repository can be referenced here:

__call__ 

__call__(
    time: datetime | list[datetime] | TimeArray,
    lead_time: timedelta | list[timedelta] | LeadTimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

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 FX select lexicon.

Returns:

  • DataArray –

    GEFS select forecast data array

fetch async 

fetch(
    time: datetime | list[datetime] | TimeArray,
    lead_time: timedelta | list[timedelta] | LeadTimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

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:

  • DataArray –

    GEFS forecast data array

available classmethod 

available(time: datetime | datetime64) -> bool

Checks if given date time is avaliable in the GEFS object store. Uses S3 store

Parameters:

Returns:

  • bool –

    If date time is avaiable