mpas_tools.ocean.depth.add_depth

mpas_tools.ocean.depth.add_depth(inFileName, outFileName, coordFileName=None)[source]

Add a 1D depth coordinate to an MPAS-Ocean file.

Note

This adds a 1D depth coordinate derived from refBottomDepth, which assumes a z-level/z-star vertical coordinate. It is not supported for Omega or other general vertical coordinates, which do not provide refBottomDepth. Use add_zmid() for a 3D zMid coordinate instead.

Parameters:

  • inFileName (str) – An input MPAS-Ocean file that depth should be added to, used for coords if another file is not provided via coordFileName.

  • outFileName (str) – An output MPAS-Ocean file with depth added

  • coordFileName (str, optional) – An MPAS-Ocean file with refBottomDepth