polaris.ocean.model.OceanModelStep.map_yaml_options

OceanModelStep.map_yaml_options(options: Dict[str, str | int | float | bool], config_model: str | None) → Dict[str, str | int | float | bool][source]

A mapping between model config options from MPAS-Ocean to Omega

Parameters:

  • options (dict) – A dictionary of yaml options and value to use as replacements for existing values

  • config_model (str or None) – If config options are available for multiple models, the model that the config options are from

Returns:

options (dict) – A revised dictionary of yaml options and value to use as replacements for existing values