Argo filename information API

This module contains functions that operate on Argo filenames. These filenames follow specific conventions that can be hard to remember. This is built-in to the interactive module. The path argument for all functions in this module can be a string file path, an iterable of file paths, a pandas.Series or a pandas.DataFrame (whose ‘file’ column is used as input).

>>> import argopandas as argo
>>> argo.path.info('2902746_tech.nc')
{'type': 'tech', 'modifier': None, 'data_mode': None, 'float': 2902746, 'aux': None}

info(path)

Return a dictionary of information that can be obtained from the file path. pandas.Series objects are expanded to pandas.DataFrame s; pandas.DataFrame objects are appended to the output pandas.DataFrame.

is_data_mode(path, data_mode)

Return True if path is path a to a real-time (‘R’) or delayed (‘D’) mode file.

Parameters

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

is_descending(path)

Return True if this profile is a descending profile.

is_float(path, floats)

Return True if path matches one of the floats listed in floats.

Parameters

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

is_meta(path)

Return True if path is path to a meta NetCDF or False otherwise.

is_prof(path)

Return True if path is path to a profile NetCDF or False otherwise.

is_tech(path)

Return True if path is path to a tech NetCDF or False otherwise.

is_traj(path)

Return True if path is path to a traj NetCDF or False otherwise.