argopy.fetchers.ArgoIndexFetcher¶

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

Fetcher and post-processor of Argo index 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[‘dataset’] by default if empty.
**fetcher_kwargs (optional) – Additional arguments passed on data source fetcher of each access points.

Notes

Spec discussions can be found here:

https://github.com/euroargodev/argopy/issues/8

Examples

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

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

Methods

`__init__`([mode, src, ds])
`clear_cache`()	Clear fetcher cached data
`float`()	Float index fetcher
`load`([force])	Load index in memory
`plot`([ptype])	Create custom plots from index
`profile`()	Profile index fetcher
`region`()	Space/time domain index fetcher
`to_csv`([file])	Fetch and save index data as csv in a file
`to_dataframe`(**kwargs)	Fetch and return index data as pandas Dataframe
`to_xarray`(**kwargs)	Fetch and return index data as xarray DataSet

Attributes

Index structure