Skip to content

data.GFS_FX

Global

Import path: earth2studio.data.GFS_FX

View source on GitHub

Documentation

Bases: GFS

The global forecast service (GFS) forecast source provided on an equirectangular grid. GFS is a weather forecast model developed by NOAA. This data source is on a 0.25 degree lat lon grid at 6-hour intervals spanning from Feb 26th 2021 to present date. Each forecast provides hourly predictions up to 16 days (384 hours).

Parameters:

  • source (str, default: 'aws' ) –

    Data store location to pull from. Options are [aws, ncep], by default aws

  • cache (bool, default: True ) –

    Cache data source on local memory, by default True

  • verbose (bool, default: True ) –

    Print download progress, by default True

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__ 

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

Retrieve GFS 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 GFS lexicon.

Returns:

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 GFS lexicon.

Returns:

available classmethod 

available(time: datetime | datetime64) -> bool

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

Parameters:

Returns:

  • bool –

    If date time is avaiable

Examples using earth2studio.data.GFS_FX

Preview of Running StormCast-CONUS InferenceRunning StormCast-CONUS InferenceBasic StormCast-CONUS inference workflow for the full Continental United States. Preview of Running StormCast Ensemble InferenceRunning StormCast Ensemble InferenceEnsemble StormCast inference workflow.