ISD

class earth2studio.data.ISD(

stations,

time_tolerance=numpy.timedelta64(10, 'm'),

cache=True,

verbose=True,

async_timeout=600,

)

NA

NOAA’s Integrated Surface Database (ISD) is a global database that consists of hourly and synoptic surface observations compiled from numerous sources into a common data model.

Parameters:

• stations (list[str]) – Station IDs as the concatenation of USAF (6 chars) and WBAN (5 digits) to attempt to fetch data from.

• time_tolerance (TimeTolerance, optional) – Time tolerance window for filtering observations. Accepts a single value (symmetric ± window) or a tuple (lower, upper) for asymmetric windows, by default np.timedelta64(10, ‘m’)

• cache (bool, optional) – Cache data source on local memory, by default True

• verbose (bool, optional) – Print download progress and missing data warnings, 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

To help get a list of possible station IDs, this class includes ISD.get_stations_bbox() which accepts a lat-lon bounding box and will return known historical stations IDs. For more information on the stations, users should consult the isd-history.csv which can easily accessed with ISD.get_station_history()

Note

Additional information on the data repository can be referenced here:

• https://www.ncei.noaa.gov/products/land-based-station/integrated-surface-database

• https://registry.opendata.aws/noaa-isd/

• https://www.ncei.noaa.gov/data/global-hourly/doc/isd-format-document.pdf

Example

# Bay area, lat lon bounding box (lat min, lon min, lat max, lon max)
stations = ISD.get_stations_bbox((36, -124, 40, -120))
ds = ISD(stations, time_tolerance=timedelta(hours=2))
df = ds(datetime(2024, 1, 1, 20), ["t2m", "ws10m"])

__call__(time, variable, fields=None)

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

• fields (str | list[str] | pa.Schema | None, optional) – Fields to include in output, by default None (all fields).

Returns:

ISD data frame

Return type:

pd.DataFrame

async fetch(time, variable, fields=None)

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 (column ids) to return. Must be in the ISD lexicon.

• fields (str | list[str] | pa.Schema | None, optional) – Fields to include in output, by default None (all fields).

Returns:

ISD data frame

Return type:

pd.DataFrame

Examples using earth2studio.data.ISD

StormCast Score-Based Data Assimilation

StormCast Score-Based Data Assimilation