xoa.sigma.ocean_sigma_coordinate
- xoa.sigma.ocean_sigma_coordinate(sig, ssh, bathy, dask='parallelized', cache=None)[source]
Convert from sigma [-1, 0] to negative depths in an ocean model
Note
This function is dask-aware since it delegates the core computation to
xarray.apply_ufunc()
.- Source:
- Formula:
- \[z = \eta + \sigma * (\eta+h)\]
- Sigma standard name:
ocean_sigma_coordinate
- Formula terms:
sigma: var1 eta: var2 depth: var3
- Parameters:
sig (xarray.DataArray) – Sigma coordinates range from 0 to 1 (\(\sigma\) |
sigma
)ssh (xarray.DataArray) – Surface air pressure (\(\eta\) |
eta
)bathy (xarray.DataArray) – Positive sea floor depth (\(h\) |
depth
)
- Returns:
xarray.DataArray – Negative depth below surface in m (\(z\))