argopy.stores.float.spec.ArgoFloatProto

class ArgoFloatProto(wmo: int | str, host: str | None = None, aux: bool = False, cache: bool = False, cachedir: str = '', timeout: int = 0, **kwargs)

__init__(wmo: int | str, host: str | None = None, aux: bool = False, cache: bool = False, cachedir: str = '', timeout: int = 0, **kwargs)

Create an Argo float store

Parameters:

• wmo (int or str) – The float WMO number. It will be validated against the Argo convention and raise an ValueError if not compliant.

• host (str, optional, default: OPTIONS['gdac']) –

  Local or remote (http, ftp or s3) path where a dac folder is to be found (compliant with GDAC structure).

  This parameter takes values like:

  • a local absolute path

  • https://data-argo.ifremer.fr, shortcut with http or https

  • https://usgodae.org/pub/outgoing/argo, shortcut with us-http or us-https

  • ftp://ftp.ifremer.fr/ifremer/argo, shortcut with ftp

  • s3://argo-gdac-sandbox/pub, shortcut with s3 or aws

• aux (bool, default = False) – Should we include dataset from the auxiliary data folder. The ‘aux’ folder is expected to be at the same path level as the ‘dac’ folder on the GDAC host.

• cache (bool, optional, default: False) – Use cache or not.

• cachedir (str, optional, default: OPTIONS['cachedir']) – Folder where to store cached files.

• timeout (int, optional, default: OPTIONS['api_timeout']) – Time out in seconds to connect to a remote host (ftp or http).

Methods

__init__(wmo[, host, aux, cache, cachedir, ...])	Create an Argo float store
describe_profiles()	Return a pandas.DataFrame describing profile files
load_dac()	Load the DAC short name for this float
load_index()	Load the Argo full index in memory and trigger search for this float
load_metadata()	Method to load float meta-data
load_metadata_from_meta_file()	Method to load float meta-data
ls()	Return the list of files in float path
ls_dataset()	List all available dataset for this float in a dictionary
lsprofiles()	Return the list of files in float profiles path
open_dataset([name, cast])	Open and decode a dataset

Attributes

N_CYCLES	Number of cycles
dac	Name of the DAC responsible for this float
host_protocol	Protocol of the GDAC host
host_sep	Host path separator
metadata	A dictionary of float meta-data
path	Return root path for all float datasets