easyclimate.field.ocean.thermal¶

The calculation of ocean thermocline variables.

Functions¶

`calc_seawater_thermocline_depth`(→ xarray.DataArray)	Caculate thermocline depth of ocean temperature.
`calc_Dx_depth`(→ xarray.DataArray)	Caculate value depth of ocean temperature.
`calc_D14_depth`(→ xarray.DataArray)	Caculate 14m depth of ocean temperature.
`calc_D17_depth`(→ xarray.DataArray)	Caculate 17m depth of ocean temperature.
`calc_D20_depth`(→ xarray.DataArray)	Caculate 20m depth of ocean temperature.
`calc_D26_depth`(→ xarray.DataArray)	Caculate 26m depth of ocean temperature.
`calc_D28_depth`(→ xarray.DataArray)	Caculate 28m depth of ocean temperature.

Module Contents¶

easyclimate.field.ocean.thermal.calc_seawater_thermocline_depth(seawater_temperature_data: xarray.DataArray, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate thermocline depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.

easyclimate.field.ocean.thermal.calc_Dx_depth(seawater_temperature_data: xarray.DataArray, value: float, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate value depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
value: float.: The depth of ocean temperature to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.

easyclimate.field.ocean.thermal.calc_D14_depth(seawater_temperature_data: xarray.DataArray, value: float = 14, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate 14m depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
value: float (\(\mathrm{m}\)).: The depth of ocean temperature to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.

easyclimate.field.ocean.thermal.calc_D17_depth(seawater_temperature_data: xarray.DataArray, value: float = 17, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate 17m depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
value: float (\(\mathrm{m}\)).: The depth of ocean temperature to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.

easyclimate.field.ocean.thermal.calc_D20_depth(seawater_temperature_data: xarray.DataArray, value: float = 20, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate 20m depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
value: float (\(\mathrm{m}\)).: The depth of ocean temperature to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.

easyclimate.field.ocean.thermal.calc_D26_depth(seawater_temperature_data: xarray.DataArray, value: float = 26, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate 26m depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
value: float (\(\mathrm{m}\)).: The depth of ocean temperature to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.

easyclimate.field.ocean.thermal.calc_D28_depth(seawater_temperature_data: xarray.DataArray, value: float = 28, depth_dim: str = 'depth') → xarray.DataArray¶

Caculate 28m depth of ocean temperature.

Parameters¶

seawater_temperature_data: xarray.DataArray (\(\mathrm{^\circ C}\)).: ocean temperature xarray.DataArray data to be calculated.
value: float (\(\mathrm{m}\)).: The depth of ocean temperature to be calculated.
depth_dim: str, default: depth.: depth like dimension over which to apply calculate. By default extracting is applied over the depth dimension.

Returns¶

xarray.DataArray.