argopy.data_fetchers.erddap_refdata.Fetch_box

class Fetch_box(*args, **kwargs)

Manage access to Argo CTD-reference data through Ifremer ERDDAP for: an ocean rectangle

__init__(*args, **kwargs)

Instantiate an authenticated ERDDAP Argo data fetcher

Parameters:

• cache (bool (optional)) – Cache data or not (default: False)

• cachedir (str (optional)) – Path to cache folder

• api_timeout (int (optional)) – Erddap request time out in seconds. Set to OPTIONS[‘api_timeout’] by default.

Methods

__init__(*args, **kwargs)	Instantiate an authenticated 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
dashboard(**kw)	Return 3rd party dashboard for the access point
define_constraints()	Define request constraints
filter_data_mode(ds, **kwargs)	Apply xarray argo accessor filter_data_mode method
filter_points(ds)	Enforce request criteria
filter_qc(ds, **kwargs)	Apply xarray argo accessor filter_qc method
filter_researchmode(ds, *args, **kwargs)	Filter dataset for research user mode
filter_variables(ds, mode, *args, **kwargs)	Filter variables according to user mode
get_url()	Return the URL to download requested data
init(box, **kw)	Create Argo data loader
post_process(this_ds[, add_dm, URI])	Post-process a xarray.DataSet created from a netcdf erddap response
to_xarray([errors])	Load CTD-Reference 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
server	URL of the Erddap server
sha	Returns a unique SHA for a specific cname / fetcher implementation
uri	List of files to load for a request