earth2studio.data.GFS_FX

class earth2studio.data.GFS_FX(source='aws', cache=True, verbose=True)

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, 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

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:

• https://registry.opendata.aws/noaa-gfs-bdp-pds/

• https://www.emc.ncep.noaa.gov/emc/pages/numerical_forecast_systems/gfs.php

__call__(time, lead_time, variable)

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:

GFS weather data array

Return type:

xr.DataArray

classmethod available(time)

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

Parameters:

time (datetime | np.datetime64) – Date time to access

Returns:

If date time is avaiable

Return type:

bool