xoa.thermdyn.is_temp

Contents

xoa.thermdyn.is_temp#

xoa.thermdyn.is_temp(da, variant=None)[source]#

Check if da is a temperature-like array

Parameters:

  • da (xarray.DataArray)

  • variant ({None, 'temp', 'insitu', 'ctemp', 'conservative', 'atemp', 'absolute', 'ptemp', 'potential'}) –

    Restrict checking to a given variant(s)

    • None: No restriction

    • 'temp'|'insitu': In situ

    • 'ctemp'|'conservative': Conservative temperature

    • 'atemp'|'absolute': Absolute temperature

    • 'ptemp'|'potential': Potential temperature

Returns:

bool

Example

>>> da = xr.DataArray([15, 16], dims="z", name="temp")
>>> is_temp(da)
True

See also

get_temp, is_sal, is_dens

Contents