clouddrift.adapters.ibtracs

Contents

clouddrift.adapters.ibtracs#

Functions

to_raggedarray(version, kind[, tmp_path])

Returns International Best Track Archive for Climate Stewardship (IBTrACS) as a ragged array xarray dataset.

clouddrift.adapters.ibtracs.to_raggedarray(version: Literal['v04r00', 'v04r01'], kind: Literal['ACTIVE', 'ALL', 'EP', 'NA', 'NI', 'SA', 'SI', 'SP', 'WP', 'LAST_3_YEARS', 'SINCE_1980'], tmp_path: str = '/tmp/clouddrift/ibtracs') Dataset[source]#

Returns International Best Track Archive for Climate Stewardship (IBTrACS) as a ragged array xarray dataset.

The upstream data is available at https://www.ncei.noaa.gov/products/international-best-track-archive

Parameters#

versionstr, optional

Specify the dataset version to retrieve. Default to the latest version. Default is “v04r01”.

kind: str, optional

Specify the dataset kind to retrieve. Specifying the kind can speed up execution time of specific querries and operations. Default is “LAST_3_YEARS”.

tmp_path: str, default adapter temp path (default)

Temporary path where intermediary files are stored. Default is ${osSpecificTempFileLocation}/clouddrift/ibtracs/.

Returns#

xarray.Dataset

IBTRACS dataset as a ragged array.