clouddrift.adapters.gdp.get_gdp_metadata

clouddrift.adapters.gdp.get_gdp_metadata#

clouddrift.adapters.gdp.get_gdp_metadata(tmp_path: str = '/tmp/clouddrift/gdp', skip_download: bool = False) DataFrame[source]#

Download (or read locally cached) GDP metadata and return it as a Pandas DataFrame.

Parameters#

tmp_pathstr

Directory where dirfl_*.dat metadata files are stored.

skip_downloadbool, optional

If True, scan tmp_path for cached dirfl_*.dat files instead of fetching the file list from the network, and skip re-downloading any dirfl_*.dat files that already exist locally. Use this when the drifter data files have also been downloaded with skip_download=True to ensure the metadata is consistent with the local files.

Returns#

dfpd.DataFrame

Sorted list of drifters as a pandas DataFrame.