argopy.fetchers.ArgoDataFetcher

class ArgoDataFetcher(mode: str = '', src: str = '', ds: str = '', **fetcher_kwargs)[source]

Fetch and process Argo data.

Can return data selected from:

  • one or more float(s), defined by WMOs
  • one or more profile(s), defined for one WMO and one or more CYCLE NUMBER
  • a space/time rectangular domain, defined by lat/lon/pres/time range

Can return data from the regular Argo dataset (‘phy’: temperature, salinity) and the Argo referenced dataset used in DMQC (‘ref’: temperature, salinity).

This is the main API facade. Specify here all options to data_fetchers.

Parameters:
mode : str
src : str
ds : str
__init__(self, mode:str='', src:str='', ds:str='', **fetcher_kwargs)[source]
Parameters:
mode : str

User mode. Set to OPTIONS[‘mode’] by default.

ds : str

Name of the dataset to load. Use the global OPTIONS[‘dataset’] by default.

src : str

Source of the data to use. Use the global OPTIONS[‘src’] by default.

**fetcher_kwargs

Used to pass arguments specific to a data source.

Methods

__init__(self, mode, src, ds, **fetcher_kwargs)
Parameters:
clear_cache(self) Clear fetcher cached data
float(self, wmo, **kw) Fetch data from a float
profile(self, wmo, cyc) Fetch data from a profile
region(self, box) Fetch data from a space/time domain
to_dataframe(self, **kwargs) Fetch and return data as pandas.Dataframe
to_xarray(self, **kwargs) Fetch and return data as xarray.DataSet