clouddrift.adapters.andro

clouddrift.adapters.andro#

This module defines functions used to adapt the ANDRO: An Argo-based deep displacement dataset as a ragged-arrays dataset.

The dataset is hosted at https://www.seanoe.org/data/00360/47077/ and the user manual is available at https://archimer.ifremer.fr/doc/00360/47126/.

Example#

>>> from clouddrift.adapters import andro
>>> ra = andro.to_raggedarray()
>>> ds = ra.to_xarray()

Reference#

Ollitrault Michel, Rannou Philippe, Brion Emilie, Cabanes Cecile, Piron Anne, Reverdin Gilles, Kolodziejczyk Nicolas (2022). ANDRO: An Argo-based deep displacement dataset. SEANOE. https://doi.org/10.17882/47077

Functions

to_raggedarray([tmp_path, skip_download])

Return the ANDRO dataset as a RaggedArray instance.
clouddrift.adapters.andro.to_raggedarray(tmp_path: str | None = None, skip_download: bool = False) → RaggedArray[source]#

Return the ANDRO dataset as 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.