argopy.fetchers.ArgoDataFetcher
argopy.fetchers.ArgoDataFetcher#
- class ArgoDataFetcher(mode: str = '', src: str = '', ds: str = '', **fetcher_kwargs)[source]#
Fetcher and post-processor of Argo data (API facade)
- Parameters
mode (str, optional) – User mode. Eg:
standard
orexpert
. 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 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)[source]#
Create a fetcher instance
- Return type
Methods
__init__
([mode, src, ds])Create a fetcher instance
Clear data cached by fetcher
dashboard
(**kw)Open access point dashboard.
float
()Float data fetcher
load
([force])Fetch data (and compute an index) if not already in memory
plot
([ptype])Create custom plots from data
profile
()Profile data fetcher
region
()Space/time domain data fetcher
to_dataframe
(**kwargs)Fetch and return data as pandas.Dataframe
to_index
([full, coriolis_id])Create an index of Argo data, fetch data if necessary
to_xarray
(**kwargs)Fetch and return data as xarray.DataSet
Attributes
Data structure
domain
" Domain of the dataset
Index structure, as returned by the to_index method
List of resources to load for a request