argopy.ArgoIndex.query.params

ArgoIndex.query.params(PARAMs, logical='and', nrows=None, composed=False)

Search index for one or a list of parameters

Parameters:

• PARAMs (str or list(str)) – A string or a list of strings to search Argo records for in the PARAMETERS columns of BGC profiles index.

• logical (str, default='and') – Indicate to search for all (and) or any (or) of the parameters.

Return type:

ArgoIndex

Examples

from argopy import ArgoIndex
idx = ArgoIndex(index_file='bgc-s')

idx.query.params(['C1PHASE_DOXY', 'DOWNWELLING_PAR'])
idx.query.params(['C1PHASE_DOXY', 'DOWNWELLING_PAR'], logical='or')

Warning

This method is only available for index following the bgc-s, bgc-b and aux conventions.