xarray.Dataset.xoa.get

xarray.Dataset.xoa.get#

Dataset.xoa.get(cf_name, loc='any', single=True, errors='ignore')#

Search for a data array or coordinate knowing its generic CF name

Search is made with the search() method of the CFSpecs() instance was set at initialisation or inferred with xoa.cf.infer_cf_specs().

Parameters:

  • name (Generic CF)

  • name

  • loc (str, {"any", None}, {"", False}) –

    • str: one of these locations

    • None or “any”: any

    • False or “”: no location

  • errors ({'ignore', 'warn', 'raise'}) –

    In case of errors

    • 'ignore': silently ignore

    • 'warn': emit a warning

    • 'raise': raise an exception

See also

xoa.cf.CFSpecs.search(), xoa.cf.CFCoordSpecs.search(), xoa.cf.CFVarSpecs.search()

Contents