Skip to content

Commit

Permalink
Add documentation of the new feature
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Oct 17, 2024
1 parent e79d3cf commit 68c036f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/developers_guide/ocean/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,8 @@
OceanModelStep.setup
OceanModelStep.constrain_resources
OceanModelStep.compute_cell_count
OceanModelStep.map_input_dataset
OceanModelStep.map_output_dataset
OceanModelStep.map_yaml_options
OceanModelStep.map_yaml_configs
Expand Down
16 changes: 16 additions & 0 deletions docs/developers_guide/ocean/framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,22 @@ map in the [mpaso_to_omega.yaml](https://github.com/E3SM-Project/polaris/blob/ma
file. Note that `config_model='Omega'` must be capitalized since this is the
convention on the model name in Omega's own YAML files.

#### Mapping between MPAS-Ocean to Omega variable names

Similarly to config options, it is necessary to be able to map between
MPAS-Ocean and Omega variable names in both input (e.g. initial condition)
and output datasets.

We implement a mapping between the MPAS-Ocean and Omega variable names in the
methods
{py:meth}`polaris.ocean.model.OceanModelStep.map_input_dataset()` and
{py:meth}`polaris.ocean.model.OceanModelStep.map_output_dataset()`. These
methods should be called in Polaris immediatly before writing out input files
and immediately after reading in output files, respectively.
As new variables are added to Omega, they should be added to the map in the
[mpaso_to_omega.yaml](https://github.com/E3SM-Project/polaris/blob/main/polaris/ocean/model/mpaso_to_omega.yaml)
file.

#### Setting MPI resources

The target and minimum number of MPI tasks (`ntasks` and `min_tasks`,
Expand Down

0 comments on commit 68c036f

Please sign in to comment.