polaris.ocean.model.OceanIOStep.open_vert_coord_dataset

OceanIOStep.open_vert_coord_dataset(ds_init, vert_coord_filename=None, **kwargs)[source]

Return the dataset containing vertical-coordinate variables (bottomDepth, minLevelCell, maxLevelCell, vertCoordMovementWeights and either restingThickness or RefPseudoThickness).

For Omega: opens vert_coord_filename (defaults to get_vert_coord_filename()) via open_model_dataset() so Omega variable names are mapped to their MPAS-Ocean equivalents.

For MPAS-Ocean: returns the set of vertical-coordinate variables from ds_init (those variables live in the initial state file).

Parameters:

  • ds_init (xarray.Dataset) – The already-opened initial-condition dataset.

  • vert_coord_filename (str, optional) – Local filename of the vertical-coordinate file. Defaults to get_vert_coord_filename(). Pass an explicit name when using per-resolution files (e.g. 'vert_coord_r04.nc').

  • **kwargs – Forwarded to open_model_dataset().