xarray.Dataset.cf.decode_vertical_coords#

Dataset.cf.decode_vertical_coords(*, outnames=None, prefix=None)#

Decode parameterized vertical coordinates in place.

Parameters:
outnamesdict, optional

Keys of outnames are the input sigma/s coordinate variable name and the values are the name to use for the associated vertical coordinate.

prefixstr, optional

Prefix for newly created z variables. E.g. s_rho becomes z_rho.

Returns:
None

Modifies self inplace.

Notes

Will only decode when the formula_terms and standard_name attributes are set on the parameter (e.g s_rho )

Currently only supports ocean_s_coordinate_g1, ocean_s_coordinate_g2, and ocean_sigma_coordinate.

Warning

Very lightly tested. Please double check the results.