argopy.stores.argo_index_pa.indexstore_pyarrow.search_params#

indexstore_pyarrow.search_params(PARAMs, nrows=None, logical='and')[source]#

Search index for one or a list of parameters

Parameters:

  • PARAMs (str or list) – 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.

Examples

>>> idx.search_params(['C1PHASE_DOXY', 'DOWNWELLING_PAR'])
>>> idx.search_params(['C1PHASE_DOXY', 'DOWNWELLING_PAR'], logical='or')

Warning

This method is only available for index following the bgc-s or bgc-b conventions.