earth2studio.data.GFS#
- class earth2studio.data.GFS(source='aws', cache=True, verbose=True, async_timeout=600)[source]#
The global forecast service (GFS) initial state data source provided on an equirectangular grid. GFS is a weather forecast model developed by NOAA. This data source is provided on a 0.25 degree lat lon grid at 6-hour intervals spanning from Feb 26th 2021 to present date.
- Parameters:
source (str, optional) – Data store location to pull from. Options are [aws, ncep], by default aws
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.
Note
This data source only fetches the initial state of GFS and does not fetch an predicted time steps. See
GFS_FXfor fetching predicted data from this forecast system.Note
Additional information on the data repository can be referenced here:
- __call__(time, variable)[source]#
Retrieve GFS initial state / analysis data
- Parameters:
time (datetime | list[datetime] | TimeArray) – Timestamps to return data for (UTC).
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:
GFS weather data array
- Return type:
xr.DataArray
- async fetch(time, variable)[source]#
Async function to get data
- Parameters:
time (datetime | list[datetime] | TimeArray) – Timestamps to return data for (UTC).
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:
GFS weather data array
- Return type:
xr.DataArray
