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.
Argo Data Fetchers#
alias of |
|
alias of |
Data selection methods#
Space/time domain data fetcher |
|
Float data fetcher |
|
Profile data fetcher |
Space/time domain index fetcher |
|
Float index fetcher |
|
Profile index fetcher |
Data access methods#
|
Fetch data (and compute a profile index) if not already in memory |
|
Fetch and return data as xarray.DataSet |
|
Fetch and return data as pandas.Dataframe |
|
Create a profile index of Argo data, fetch data if necessary |
|
Load index in memory |
|
Fetch and return index data as xarray DataSet |
|
Fetch and return index data as pandas Dataframe |
|
Fetch and save index data as csv in a file |
Data visualisation methods#
|
Create custom plots from this fetcher data or index. |
|
Open access point dashboard. |
|
Create custom plots from this fetcher index. |
Properties#
Data structure |
|
Index structure, as returned by the to_index method |
|
Space/time domain of the dataset |
|
List of resources to load for a request |
|
Index structure |
Data visualisation#
Visualisation functions available at the argopy
module level:
|
Insert an Argo dashboard page in a notebook cell, or return the corresponding url |
|
Class to manage discrete coloring for Argo related variables |
All other visualisation functions are in the argopy.plot
submodule:
|
Insert the CLS Satellite Altimeter Report figure in notebook cell |
|
Try-to-be generic function to create a scatter plot on a map from argopy |
|
Create a bar plot for an Argo index dataframe |
|
A quick-and-dirty parameter scatter plot for one variable |
|
Add latitude/longitude grid line and labels to a cartopy geoaxes |
Handy class to manage discrete coloring and the associated colorbar |
Dataset.argo (xarray accessor)#
Class registered under scope |
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#
|
Transform a collection of points into a collection of profiles |
Convert a collection of profiles to a collection of points |
|
|
Interpolate measurements to standard pressure levels |
|
Group measurements by pressure bins |
Data Filters#
|
Filter data set according to QC values |
|
Filter variables according to their data mode |
|
Filter variables according to OWC salinity calibration software requirements |
Filter dataset for research user mode |
Processing#
|
Add TEOS10 variables to the dataset |
|
Preprocess data for OWC software calibration |
Misc#
Basic profile index |
|
Space/time domain of the dataset |
|
Given a dataset, return a list with all possible (PLATFORM_NUMBER, CYCLE_NUMBER) tuple |
|
|
UID encoder/decoder |
|
Make sure variables are of the appropriate types according to Argo |
Utilities#
Function under the argopy.utils
submodule.
List all available data sources |
|
List all available index sources |
|
List of variables for standard users |
|
List of variables in a netcdf multiprofile file. |
|
|
Validate a WMO option and returned it as a list of integers |
|
Validate a CYC option and returned it as a list of integers |
|
Argo float WMO number object |
|
A list manager can that validate item type |
|
To chunk fetcher requests |
|
Check if an URL is alive |
|
Check if a keyword is in the content of a URL |
|
Check if an API is alive or not |
|
Check if a source API is alive or not |
|
Drop variables that are not in all datasets (the lowest common denominator) |
|
Add empty variables to dataset so that all the collection have the same |
Argopy helpers#
|
Set options for argopy |
|
Delete argopy cache folder content |
|
Open a dataset from the argopy online data repository (requires internet). |
|
Print the versions of argopy and its dependencies |
Backend for Argo netCDF files based on the xarray netCDF4 engine |
Internals#
File systems#
|
Argo local file system |
|
Argo http file system |
|
Argo in-memory file system (global) |
|
Argo ftp file system |
Argo index store#
|
Argo GDAC index store |
alias of |
|
alias of |
Fetcher sources#
ERDDAP#
|
Manage access to Argo data through Ifremer ERDDAP |
Manage access to Argo data through Ifremer ERDDAP for: a list of WMOs |
|
Manage access to Argo data through Ifremer ERDDAP for: an ocean rectangle |
GDAC#
Manage access to Argo data from a remote GDAC FTP. |
|
Manage access to GDAC ftp Argo data for: a list of WMOs. |
|
Manage access to GDAC ftp Argo data for: a rectangular space/time domain. |