clouddrift.adapters.subsurface_floats

This module defines functions to adapt as a ragged-array dataset a collection of data from 2193 trajectories of SOFAR, APEX, and RAFOS subsurface floats from 52 experiments across the world between 1989 and 2015.

The dataset is hosted at https://www.aoml.noaa.gov/phod/float_traj/index.php

Example

>>> from clouddrift.adapters import subsurface_floats
>>> ra = subsurface_floats.to_raggedarray()

Functions

download(file[, skip_download])
to_raggedarray([tmp_path, skip_download])	Convert the subsurface floats dataset to a RaggedArray instance.

clouddrift.adapters.subsurface_floats.to_raggedarray(tmp_path: str | None = None, skip_download: bool = False) → RaggedArray

Convert the subsurface floats dataset to a RaggedArray instance.

Parameters

tmp_pathstr, optional

Path where the dataset file is cached. Defaults to a platform-specific temporary directory.

skip_downloadbool, optional

If True, skip re-downloading the dataset file if it already exists in tmp_path. Default is False.

Returns

RaggedArray

Subsurface float trajectories as a ragged array.