argopy.fetchers.ArgoIndexFetcher

argopy.fetchers.ArgoIndexFetcher#

class ArgoIndexFetcher(mode: str = 'standard', src: str = 'erddap', ds: str = 'phy', **fetcher_kwargs)[source]#

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

An index dataset gather space/time information, and possibly more meta-data, of Argo profiles.

Examples

>>> from argopy import IndexFetcher
>>> adf = IndexFetcher.region([-75, -65, 10, 20]).load()
>>> idx.index
>>> idx.plot()
__init__(mode: str = 'standard', src: str = 'erddap', ds: str = 'phy', **fetcher_kwargs)[source]#

Facade for Argo index fetchers

Parameters:

  • mode (str, optional) – User mode. Eg: standard or expert.

  • src (str, optional) – Source of the data to use. Eg: erddap.

  • ds (str, optional) – Name of the dataset to load. Eg: phy.

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

Methods

__init__([mode, src, ds])

Facade for Argo index fetchers

clear_cache()

Clear fetcher cached data

float()

Float index fetcher

load([force])

Load index in memory

plot([ptype])

Create custom plots from this fetcher 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

Index structure