argopy.data_fetchers.erddap_data.ErddapArgoDataFetcher¶
- class ErddapArgoDataFetcher(ds: str = '', cache: bool = False, cachedir: str = '', parallel: bool = False, parallel_method: str = 'thread', progress: bool = False, chunks: str = 'auto', chunks_maxsize: dict = {}, api_timeout: int = 0, **kwargs)[source]¶
Manage access to Argo data through Ifremer ERDDAP
ERDDAP transaction are managed with the erddapy library
- __init__(ds: str = '', cache: bool = False, cachedir: str = '', parallel: bool = False, parallel_method: str = 'thread', progress: bool = False, chunks: str = 'auto', chunks_maxsize: dict = {}, api_timeout: int = 0, **kwargs)[source]¶
Instantiate an ERDDAP Argo data fetcher
- Parameters
- ds: str (optional)
Dataset to load: ‘phy’ or ‘ref’ or ‘bgc’
- cache: bool (optional)
Cache data or not (default: False)
- cachedir: str (optional)
Path to cache folder
- parallel: bool (optional)
Chunk request to use parallel fetching (default: False)
- parallel_method: str (optional)
Define the parallelization method:
thread
,process
or adask.distributed.client.Client
.- progress: bool (optional)
Show a progress bar or not when
parallel
is set to True.- chunks: ‘auto’ or dict of integers (optional)
Dictionary with request access point as keys and number of chunks to create as values. Eg: {‘wmo’: 10} will create a maximum of 10 chunks along WMOs when used with
Fetch_wmo
.- chunks_maxsize: dict (optional)
Dictionary with request access point as keys and chunk size as values (used as maximum values in ‘auto’ chunking). Eg: {‘wmo’: 5} will create chunks with as many as 5 WMOs each.
- api_timeout: int (optional)
Erddap request time out in seconds. Set to OPTIONS[‘api_timeout’] by default.
Methods
__init__
([ds, cache, cachedir, parallel, ...])Instantiate an ERDDAP Argo data fetcher
clear_cache
()Remove cache files and entries from resources opened with this fetcher
cname
()Return a unique string defining the constraints
define_constraints
()Define erddapy constraints
filter_data_mode
(ds, **kwargs)filter_qc
(ds, **kwargs)filter_variables
(ds[, mode])get_url
()Return the URL to download data requested
init
(*args, **kwargs)Initialisation for a specific fetcher
to_xarray
([errors])Load Argo data and return a xarray.DataSet
Attributes
N_POINTS
Number of measurements expected to be returned by a request
cachepath
Return path to cached file(s) for this request
uri
Return the list of Unique Resource Identifier (URI) to download data