Global index file API

This module implements the logic to lazily load index files as necessary. The classes in this module represent the indexes provided by the main package API (e.g., argopandas.prof).

class GlobalBioProf

The global BGC profile index (i.e., ‘argo_bio-profile_index.txt.gz’). Subsets are argopandas.index.ProfIndex objects. This object is available as the argopandas.bio_prof object.

class GlobalBioTraj

The global BGC trajectory index (i.e., ‘argo_bio-traj_index.txt.gz’). Subsets are argopandas.index.TrajIndex objects. This object is available as the argopandas.bio_traj object.

class GlobalIndex(path: str)

Abstract base class for global indexes implementing the logic to make these lazy and data frame-like (without unnecessarily downloading the index until requested).

head(n=6)

Get the first n rows of this index without downloading it.

subset_data_mode(data_mode: str) → argopandas.index.DataFrameIndex

Return the subset of this index corresponding to the specified data_mode. See argopandas.index.DataFrameIndex.subset_data_mode().

Parameters

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

subset_date(date_start=None, date_end=None) → argopandas.index.DataFrameIndex

Return the subset of this index representing profiles collected between date_start and date_end. See argopandas.index.DataFrameIndex.subset_date().

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: str) → argopandas.index.DataFrameIndex

Return the subset of this index corresponding to the specified direction. See argopandas.index.DataFrameIndex.subset_direction().

Parameters

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

subset_float(floats: Union[str, int, Iterable[Union[str, int]]]) → argopandas.index.DataFrameIndex

Return the subset of this index corresponding to the specified floats. See argopandas.index.DataFrameIndex.subset_float().

Parameters

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

subset_parameter(parameters: Union[None, str, Iterable[str]]) → argopandas.index.DataFrameIndex

Return the subset of this index corresponding containing one or more of the parameters specified. See argopandas.index.DataFrameIndex.subset_parameter().

Parameters

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

subset_radius(latitude, longitude, radius_km) → argopandas.index.DataFrameIndex

Return the subset of this index representing profiles collected within radius_km of the position given by latitude/longitude. See argopandas.index.DataFrameIndex.subset_radius().

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) → argopandas.index.DataFrameIndex

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. See argopandas.index.DataFrameIndex.subset_rect().

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) → argopandas.index.DataFrameIndex

Return the subset of this index representing profiles updated between date_start and date_end. See argopandas.index.DataFrameIndex.subset_updated().

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 GlobalMeta

The global meta index (i.e., ‘ar_index_global_meta.txt.gz’). Subsets of the global meta index are argopandas.index.MetaIndex objects. This object is available as the argopandas.meta object.

class GlobalProf

The global profile index (i.e., ‘ar_index_global_prof.txt.gz’). Subsets of the global meta index are argopandas.index.ProfIndex objects. This object is available as the argopandas.prof object.

class GlobalSyntheticProf

The global BGC synthetic profile index (i.e., ‘argo_synthetic-profile_index.txt.gz’). Subsets are argopandas.index.ProfIndex objects. This object is avilable as the argopandas.synthetic_prof object.

class GlobalTech

The global tech index (i.e., ‘ar_index_global_tech.txt.gz’). Subsets of the global meta index are argopandas.index.TechIndex objects. This object is available as the argopandas.tech object.

class GlobalTraj

The global trajectory index (i.e., ‘ar_index_global_traj.txt.gz’). Subsets of the global meta index are argopandas.index.TrajIndex objects. This object is available as the argopandas.traj object.