tobac.analysis.spatial.find_vertical_coord_name#

tobac.analysis.spatial.find_vertical_coord_name(variable_cube, vertical_coord=None)#

Function to find the vertical coordinate in the iris cube

Parameters:
  • variable_cube (iris.cube.Cube or xarray.DataArray) – Input variable cube, containing a vertical coordinate.

  • vertical_coord (str) – Vertical coordinate name. If None, this function tries to auto-detect.

Returns:

the vertical coordinate name

Return type:

str

Raises:

ValueError – Raised if the vertical coordinate isn’t found in the cube.