polaris.ModelStep.map_yaml_options

ModelStep.map_yaml_options(options, config_model)[source]

A mapping between model config options from different models. This method should be overridden for situations in which yaml config options have diverged in name or structure from their counterparts in another model (e.g. when translating from MPAS-Ocean namelist options to Omega config options)

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