NetCDF File Index API

This module contains an interface to the index files provided by the GDAC. It is related to the :module:`argopandas.netcdf` module in that there is an index subclass for each argopandas.netcdf.NetCDFWrapper subclass. Indexes are pandas.DataFrame subclasses with a few accessors that load data from each.

class DataFrameIndex(*args, _mirror=None, **kwargs)

A representation of a pandas.DataFrame whose file column represents a path to a NetCDF file on the GDAC. These objects are created by subsetting the global indexes (e.g., argopandas.prof).

property info: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.NetCDFWrapper.info table for the files in this index.

info_(vars: Union[None, str, Iterable[str]] = None) → pandas.core.frame.DataFrame

Combine the argopandas.netcdf.NetCDFWrapper.info table for the files in this index, selecting specific variables.

Parameters: vars – A variable, an interable of variables, or None to select all possible variables.

subset_data_mode(data_mode) → pandas.core.frame.DataFrame

Return the subset of this index corresponding to the specified data_mode.

Parameters: data_mode – One of ‘R’, ‘D’, ‘realtime’ or ‘delayed’

subset_date(date_start=None, date_end=None) → pandas.core.frame.DataFrame

Return the subset of this index representing profiles collected between date_start and date_end.

Parameters

date_start – The first date to include in the subset. Can be a pandas-style date abbreviation like ‘2021’ or ‘2021-09’ or a datetime object.
date_end – The laste date to include in the subset. Can be a pandas-style date abbreviation like ‘2021’ or ‘2021-09’ or a datetime object.

subset_direction(direction) → pandas.core.frame.DataFrame

Return the subset of this index corresponding to the specified direction.

Parameters: direction – ‘ascending’, ‘descending’, ‘asc’, or ‘desc’

subset_float(floats) → pandas.core.frame.DataFrame

Return the subset of this index corresponding to the specified floats.

Parameters: floats – An integer, string, or iterable of those representing the float identifier(s).

subset_parameter(parameters) → pandas.core.frame.DataFrame

Return the subset of this index corresponding containing one or more of the parameters specified.

Parameters: parameters – A string or iterable of strings containing the parameters of interest.

subset_radius(latitude, longitude, radius_km) → pandas.core.frame.DataFrame

Return the subset of this index representing profiles collected within radius_km of the position given by latitude/longitude.

Parameters

latitude – The latitude of the target position.
longitude – The longitude of the target position.
radius_km – The number of kilometres within which profiles should be included.

subset_rect(latitude_min=- inf, longitude_min=- inf, latitude_max=inf, longitude_max=inf) → pandas.core.frame.DataFrame

Return the subset of this index representing profiles or trajectories within the bounding box. You can specify bounding boxes that wrap around the international date line by specifying lat_min > lat_max.

Parameters

latitude_min – The minimum latitude to include
longitude_min – The minimum longitude to include
latitude_max – The maximum latitude to include
longitude_min – The maximum longitude to include

subset_updated(date_start=None, date_end=None) → pandas.core.frame.DataFrame

Return the subset of this index representing profiles updated between date_start and date_end.

Parameters

date_start – The first date to include in the subset. Can be a pandas-style date abbreviation like ‘2021’ or ‘2021-09’ or a datetime object.
date_end – The laste date to include in the subset. Can be a pandas-style date abbreviation like ‘2021’ or ‘2021-09’ or a datetime object.

class MetaIndex(*args, _mirror=None, **kwargs)

A subclass for an index of meta NetCDF files.

property config_param: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.cycle table for the files in this index.

property launch_config_param: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.launch_config_param table for the files in this index.

property missions: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.missions table for the files in this index.

property param: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.param table for the files in this index.

property positioning_system: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.positioning_system table for the files in this index.

property sensor: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.sensor table for the files in this index.

property trans_system: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.MetaNetCDF.trans_system table for the files in this index.

class ProfIndex(*args, _mirror=None, **kwargs)

A subclass for an index of profile NetCDF files.

property calib: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.ProfNetCDF.calib table for the files in this index.

property history: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.ProfNetCDF.history table for the files in this index.

property levels: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.ProfNetCDF.levels table for the files in this index.

levels_(vars: Union[None, str, Iterable[str]] = None) → pandas.core.frame.DataFrame

Combine the argopandas.netcdf.ProfNetCDF.levels table for the files in this index, selecting specific variables.

Parameters: vars – A variable, an interable of variables, or None to select all possible variables.

property param: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.ProfNetCDF.param table for the files in this index.

property prof: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.ProfNetCDF.prof table for the files in this index.

prof_(vars: Union[None, str, Iterable[str]] = None) → pandas.core.frame.DataFrame

Combine the argopandas.netcdf.ProfNetCDF.prof table for the files in this index, selecting specific variables.

Parameters: vars – A variable, an interable of variables, or None to select all possible variables.

class TechIndex(*args, _mirror=None, **kwargs)

A subclass for an index of tech NetCDF files.

property tech_param: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.TechNetCDF.tech_param table for the files in this index.

class TrajIndex(*args, _mirror=None, **kwargs)

A subclass for an index of trajectory NetCDF files.

property cycle: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.TrajNetCDF.cycle table for the files in this index.

cycle_(vars: Union[None, str, Iterable[str]] = None) → pandas.core.frame.DataFrame

Combine the argopandas.netcdf.TrajNetCDF.cycle table for the files in this index, selecting specific variables.

Parameters: vars – A variable, an interable of variables, or None to select all possible variables.

property history: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.TrajNetCDF.history table for the files in this index.

property measurement: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.TrajNetCDF.measurement table for the files in this index.

measurement_(vars: Union[None, str, Iterable[str]] = None) → pandas.core.frame.DataFrame

Combine the argopandas.netcdf.TrajNetCDF.measurement table for the files in this index, selecting specific variables.

Parameters: vars – A variable, an interable of variables, or None to select all possible variables.

property param: pandas.core.frame.DataFrame: Combine the argopandas.netcdf.TrajNetCDF.param table for the files in this index.