argopy.data_fetchers.gdacftp_data.Fetch_wmo

argopy.data_fetchers.gdacftp_data.Fetch_wmo#

class Fetch_wmo(ftp: str = '', ds: str = '', cache: bool = False, cachedir: str = '', dimension: str = 'point', errors: str = 'raise', parallel: bool = False, parallel_method: str = 'thread', progress: bool = False, api_timeout: int = 0, **kwargs)[source]#

Manage access to GDAC ftp Argo data for: a list of WMOs.

This class is instantiated when a call is made to these facade access points:

>>> ArgoDataFetcher(src='gdac').float(**)
>>> ArgoDataFetcher(src='gdac').profile(**)
__init__(ftp: str = '', ds: str = '', cache: bool = False, cachedir: str = '', dimension: str = 'point', errors: str = 'raise', parallel: bool = False, parallel_method: str = 'thread', progress: bool = False, api_timeout: int = 0, **kwargs)#

Init fetcher

Parameters:

  • ftp (str (optional)) – Path to the remote FTP directory where the ‘dac’ folder is located.

  • ds (str (optional)) – Dataset to load: ‘phy’ or ‘bgc’

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

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

  • dimension (str, default: 'point') – Main dimension of the output dataset. This can be “profile” to retrieve a collection of profiles, or “point” (default) to have data as a collection of measurements. This can be used to optimise performances.

  • errors (str (optional)) – If set to ‘raise’ (default), will raise a NetCDF4FileNotFoundError error if any of the requested files cannot be found. If set to ‘ignore’, the file not found is skipped when fetching data.

  • parallel (bool (optional)) – Chunk request to use parallel fetching (default: False)

  • parallel_method (str (optional)) – Define the parallelization method: thread, process or a dask.distributed.client.Client.

  • progress (bool (optional)) – Show a progress bar or not when fetching data.

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

Methods

__init__([ftp, ds, cache, cachedir, ...])

Init fetcher

clear_cache()

Remove cached 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

filter_data_mode(ds, **kwargs)

filter_points(ds)

Enforce request criteria

filter_qc(ds, **kwargs)

filter_researchmode(ds, *args, **kwargs)

Filter dataset for research user mode

filter_variables(ds, mode, *args, **kwargs)

Filter variables according to user mode

init([WMO, CYC])

Create Argo data loader for WMOs

to_xarray([errors])

Load Argo data and return a xarray.Dataset

uri_mono2multi(URIs)

Convert mono-profile URI files to multi-profile files

Attributes

cachepath

Return path to cache file(s) for this request

sha

Returns a unique SHA for a specific cname / fetcher implementation

uri

List of files to load for a request
Contents