polaris.ocean.model.OceanModelStep.map_yaml_configs

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

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

Parameters:

  • configs (dict) – A nested dictionary of yaml sections, 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:

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