argopy.fetchers.ArgoDataFetcher

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

Fetcher and post-processor of Argo data (API facade)

Parameters:

• mode (str, optional) – User mode. Eg: standard or expert. Set to OPTIONS[‘mode’] by default if empty.

• src (str, optional) – Source of the data to use. Eg: erddap. Set to OPTIONS[‘src’] by default if empty.

• ds (str, optional) – Name of the dataset to load. Eg: phy. Set to OPTIONS[‘ds’] by default if empty.

• **fetcher_kwargs (optional) – Additional arguments passed on data source fetcher creation of each access points.

Examples

>>> from argopy import DataFetcher
>>> adf = DataFetcher().region([-75, -65, 10, 20]).load()
>>> idx.plot()
>>> idx.data

__init__(mode: str = '', src: str = '', ds: str = '', **fetcher_kwargs)

Create a fetcher instance

Return type:

argopy.fetchers.ArgoDataFetcher

Methods

__init__([mode, src, ds])	Create a fetcher instance
clear_cache()	Clear data cached by fetcher
dashboard(**kw)	Open access point dashboard.
define_postprocessor()	Define the post-processing workflow according to the dataset and user-mode
float()	Float data fetcher
load([force])	Fetch data (and compute a profile index) if not already in memory
plot([ptype])	Create custom plots from this fetcher data or index.
postprocess(*args, **kwargs)
profile()	Profile data fetcher
region()	Space/time domain data fetcher
to_dataframe(**kwargs)	Fetch and return data as pandas.DataFrame
to_dataset(**kwargs)	Fetch and return data as netCDF4.Dataset
to_index([full, coriolis_id])	Return a profile index of Argo data, fetch data if necessary
to_xarray(**kwargs)	Fetch and return data as xarray.DataSet

Attributes

data	Data structure
domain	Space/time domain of the dataset
index	Index structure, as returned by the to_index method
mission
uri	List of resources to load for a request