xoa.thermdyn.get_dens

Contents

xoa.thermdyn.get_dens#

xoa.thermdyn.get_dens(ds, variant=None, errors='warn')[source]#

Search for a density variable in a dataset

Parameters:

  • ds (xarray.Dataset)

  • variant ({None, 'dens', 'insitu', 'sigmat', 'pdens', 'potential', 'sigma0', 'sigma1', 'sigma2', 'sigma3', 'sigma4', 'ndens', 'neutral'}) –

    Restrict checking to a given variant(s)

    • None: No restriction

    • 'dens'|'insitu'|'sigmat': In situ density

    • 'pdens'|'potential'|'sigma0'|'sigma1'|'sigma2'|'sigma3'|'sigma4': Potential density

    • 'ndens'|'neutral': Neutral density

  • errors (str) – Error handling: "ignore", "warn" or "raise".

Returns:

xarray.DataArray, None – The density array, or None if not found.

See also

is_dens, get_temp, get_sal

Contents