easyclimate.field.ocean.stability

The calculation of ocean instability.

Functions

calc_N2_from_temp_salt(→ xarray.Dataset)

Calculate the frequency of seawater buoyancy.

calc_potential_density_from_temp_salt(→ xarray.Dataset)

Calculate the potential density of seawater.

Module Contents

easyclimate.field.ocean.stability.calc_N2_from_temp_salt(seawater_temperature_data: xarray.DataArray, seawater_practical_salinity_data: xarray.DataArray, time_dim: str | None, depth_dim: str = 'depth', lat_dim: str = 'lat', lon_dim: str = 'lon') → xarray.Dataset

Calculate the frequency of seawater buoyancy.

Parameters

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\))

Vertical seawater temperature data.

seawater_practical_salinity_data: xarray.DataArray (\(\mathrm{PSU}\))

Vertical seawater salinity data (practical salinity).

time_dim: str or None, default: time.

The time coordinate dimension name.

depth_dim: str, default: depth.

depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

lon_dim: str, default: lon.

Longitude coordinate dimension name. By default extracting is applied over the lon dimension.

lat_dim: str, default: lat.

Latitude coordinate dimension name. By default extracting is applied over the lat dimension.

Returns

The frequency of seawater buoyancy (xarray.DataArray).

See also

easyclimate.field.ocean.stability.calc_potential_density_from_temp_salt(seawater_temperature_data: xarray.DataArray, seawater_practical_salinity_data: xarray.DataArray, time_dim: str | None, depth_dim: str = 'depth', lat_dim: str = 'lat', lon_dim: str = 'lon') → xarray.Dataset

Calculate the potential density of seawater.

Parameters

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\))

Vertical seawater temperature data.

seawater_practical_salinity_data: xarray.DataArray (\(\mathrm{PSU}\))

Vertical seawater salinity data (practical salinity).

time_dim: str or None, default: time.

The time coordinate dimension name.

depth_dim: str, default: depth.

depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

lon_dim: str, default: lon.

Longitude coordinate dimension name. By default extracting is applied over the lon dimension.

lat_dim: str, default: lat.

Latitude coordinate dimension name. By default extracting is applied over the lat dimension.

Returns

The potential density of seawater (xarray.DataArray).

See also