Contents

API reference

API reference

This page provides an auto-generated summary of argopy’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Top-levels functions

Fetcher access points

DataFetcher.region()

Space/time domain data fetcher

DataFetcher.float()

Float data fetcher

DataFetcher.profile()

Profile data fetcher

IndexFetcher.region()

Space/time domain index fetcher

IndexFetcher.float()

Float index fetcher

IndexFetcher.profile()

Profile index fetcher

Fetcher methods

DataFetcher.load([force])

Fetch data (and compute an index) if not already in memory

DataFetcher.to_xarray(**kwargs)

Fetch and return data as xarray.DataSet

DataFetcher.to_dataframe(**kwargs)

Fetch and return data as pandas.Dataframe

DataFetcher.to_index([full])

Create an index of Argo data, fetch data if necessary

IndexFetcher.load([force])

Load index in memory

IndexFetcher.to_xarray(**kwargs)

Fetch and return index data as xarray DataSet

IndexFetcher.to_dataframe(**kwargs)

Fetch and return index data as pandas Dataframe

IndexFetcher.to_csv([file])

Fetch and save index data as csv in a file

Data visualisation

DataFetcher.plot([ptype])

Create custom plots from data

IndexFetcher.plot([ptype])

Create custom plots from index

dashboard([wmo, cyc, width, height, url, type])

Insert the Euro-Argo dashboard page in a notebook cell

Fetcher properties

DataFetcher.uri

List of resources to load for a request

DataFetcher.data

Data structure

DataFetcher.index

Index structure, as returned by the to_index method

IndexFetcher.index

Index structure

Helpers

status

alias of argopy.utilities.monitor_status

TopoFetcher(box[, ds, cache, cachedir, ...])

Fetch topographic data through an ERDDAP server for an ocean rectangle

set_options(**kwargs)

Set options for argopy

clear_cache([fs])

Delete argopy cache folder content

tutorial.open_dataset(name)

Open a dataset from the argopy online data repository (requires internet).

Low-level functions

show_versions([file])

Print the versions of argopy and its dependencies

utilities.list_available_data_src()

List all available data sources

utilities.list_available_data_src()

List all available data sources

utilities.list_available_index_src()

List all available index sources

Dataset.argo (xarray accessor)

Dataset.argo

Class registered under scope argo to access a xarray.Dataset object.

This accessor extends xarray.Dataset. Proper use of this accessor should be like:

>>> import xarray as xr         # first import xarray
>>> import argopy               # import argopy (the dataset 'argo' accessor is registered)
>>> from argopy import DataFetcher
>>> ds = DataFetcher().float([6902766, 6902772, 6902914, 6902746]).load().data
>>> ds.argo
>>> ds.argo.filter_qc()

Data Transformation

Dataset.argo.point2profile()

Transform a collection of points into a collection of profiles

Dataset.argo.profile2point()

Convert a collection of profiles to a collection of points

Dataset.argo.interp_std_levels(std_lev[, axis])

Interpolate measurements to standard pressure levels

Dataset.argo.groupby_pressure_bins(bins[, ...])

Group measurements by pressure bins

Data Filters

Dataset.argo.filter_qc([QC_list, QC_fields, ...])

Filter data set according to QC values

Dataset.argo.filter_data_mode([keep_error, ...])

Filter variables according to their data mode

Dataset.argo.filter_scalib_pres([force, inplace])

Filter variables according to OWC salinity calibration software requirements

Processing

Dataset.argo.teos10([vlist, inplace])

Add TEOS10 variables to the dataset

Dataset.argo.create_float_source([path, ...])

Preprocess data for OWC software calibration

Misc

Dataset.argo.uid(wmo_or_uid[, cyc, direction])

UID encoder/decoder

Dataset.argo.cast_types()

Make sure variables are of the appropriate types according to Argo

Internals

File systems

argopy.stores.filestore([cache, cachedir])

Argo local file system

argopy.stores.httpstore([cache, cachedir])

Argo http file system

argopy.stores.memorystore([cache, cachedir])

Argo in-memory file system

argopy.stores.indexstore([cache, cachedir, ...])

Use to manage access to a local Argo index and searches

argopy.stores.indexfilter_wmo([WMO, CYC])

Index filter based on WMO and/or CYCLE_NUMER

argopy.stores.indexfilter_box([BOX])

Index filter based on LATITUDE, LONGITUDE, DATE

Fetcher sources

ERDDAP

argopy.data_fetchers.erddap_data.ErddapArgoDataFetcher([...])

Manage access to Argo data through Ifremer ERDDAP

argopy.data_fetchers.erddap_data.Fetch_wmo([...])

Manage access to Argo data through Ifremer ERDDAP for: a list of WMOs

argopy.data_fetchers.erddap_data.Fetch_box([...])

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

Local FTP

argopy.data_fetchers.localftp_data.LocalFTPArgoDataFetcher([...])

Manage access to Argo data from a local copy of GDAC ftp

argopy.data_fetchers.localftp_data.Fetch_wmo([...])

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

argopy.data_fetchers.localftp_data.Fetch_box([...])

Manage access to local ftp Argo data for: a rectangular space/time domain

Plotters

argopy.plotters.plot_trajectory(*args, **kwargs)

argopy.plotters.bar_plot(*args, **kwargs)

argopy.plotters.open_dashboard([wmo, cyc, ...])

Insert the Euro-Argo dashboard page in a notebook cell

argopy.plotters.open_sat_altim_report([WMO, ...])

Insert the CLS Satellite Altimeter Report figure in notebook cell

previous

Contributing to argopy

next

argopy.DataFetcher