xoa.thermdyn.get_sal

Contents

xoa.thermdyn.get_sal#

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

Search for a salinity variable in a dataset

Parameters:

  • ds (xarray.Dataset)

  • variant ({None, 'sal', 'insitu', 'asal', 'absolute salinity', 'pfsal', 'preformed', 'psal', 'practical'}) –

    Restrict checking to a given variant(s)

    • None: No restriction

    • 'sal'|'insitu': In situ salinity

    • 'asal'|'absolute salinity': Absolute salinity

    • 'pfsal'|'preformed': Preformed salinity

    • 'psal'|'practical': Practical salinity

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

Returns:

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

See also

is_sal, get_temp, get_dens

Contents