xoa.dyn.get_sea_level

Contents

xoa.dyn.get_sea_level#

xoa.dyn.get_sea_level(ds, variant=None, errors='ignore')[source]#

Search for a sea level variable in a dataset

Looks for SSH, ADT, SLA, MDT or MSS variables using the xoa.meta specifications.

See: https://help.marine.copernicus.eu/en/articles/6025269-what-are-the-differences-between-the-ssh-and-sla-variables

Parameters:

  • ds (xarray.Dataset)

  • variant ({None, 'ssh', 'adt', 'sla', 'mdt', 'mss'}) –

    Restrict checking to a given variant(s)

    • None: No restriction

    • 'ssh': sea surface height

    • 'adt': absolute dynamic topography

    • 'sla': sea level anomaly

    • 'mdt': mean dynamic topography

    • 'mss': mean sea surface

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

Returns:

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

Example

>>> ds = xr.Dataset(dict(ssh=(("lat", "lon"), data)))
>>> get_sea_level(ds)
<xarray.DataArray 'ssh' ...>
Contents