clouddrift.adapters.yomaha

This module defines functions used to adapt the YoMaHa’07: Velocity data assessed from trajectories of Argo floats at parking level and at the sea surface as a ragged-arrays dataset.

The dataset is hosted at http://apdrc.soest.hawaii.edu/projects/yomaha/ and the user manual is available at http://apdrc.soest.hawaii.edu/projects/yomaha/yomaha07/YoMaHa070612.pdf.

Example

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

Reference

Lebedev, K. V., Yoshinari, H., Maximenko, N. A., & Hacker, P. W. (2007). Velocity data assessed from trajectories of Argo floats at parking level and at the sea surface. IPRC Technical Note, 4(2), 1-16.

Functions

download(tmp_path[, skip_download])
to_raggedarray([tmp_path, skip_download])	Convert the YoMaHa'07 dataset to a RaggedArray instance.

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

Convert the YoMaHa’07 dataset to a RaggedArray instance.

Parameters

tmp_pathstr, optional

Path where the dataset files are cached. Defaults to a platform-specific temporary directory.

skip_downloadbool, optional

If True, skip re-downloading files that already exist in tmp_path. The main data file (yomaha07.dat.gz) is skipped when its decompressed version already exists locally. Default is False.

Returns

RaggedArray

YoMaHa’07 dataset as a ragged array.