xarray.Dataset.xoa.get_depth

xarray.Dataset.xoa.get_depth#

Dataset.xoa.get_depth(errors='ignore')#

Get the depth as computed or recognized by the CFSpecs()

If a depth variable cannot be found, it tries to compute either from sigma-like coordinates or from layer thinknesses.

Parameters:

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

In case of errors

  • 'ignore': silently ignore

  • 'warn': emit a warning

  • 'raise': raise an exception

Returns:

xarray.DataArray, None

See also

xoa.coords.get_depth(), xoa.grid.decode_cf_dz2depth(), xoa.sigma.decode_cf_sigma(), Naming conventions with xoa.cf

Contents