Skip to content

Commit

Permalink
Update the docs for SO12to30
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Mar 31, 2024
1 parent 59d3590 commit 467e79d
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 37 deletions.
4 changes: 2 additions & 2 deletions docs/developers_guide/ocean/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,8 @@ test cases and steps
mesh.rrs6to18.RRS6to18BaseMesh
mesh.rrs6to18.RRS6to18BaseMesh.build_cell_width_lat_lon

mesh.so12to60.SO12to60BaseMesh
mesh.so12to60.SO12to60BaseMesh.build_cell_width_lat_lon
mesh.so12to30.SO12to30BaseMesh
mesh.so12to30.SO12to30BaseMesh.build_cell_width_lat_lon

mesh.wc14.WC14BaseMesh
mesh.wc14.WC14BaseMesh.build_cell_width_lat_lon
Expand Down
34 changes: 15 additions & 19 deletions docs/developers_guide/ocean/test_groups/global_ocean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -768,20 +768,18 @@ the higher surface resolution of the 80-layer RRS vertical coordinate.
config_rx1_min_layer_thickness = 0.1
.. _dev_ocean_global_ocean_sowisc12to60:
.. _dev_ocean_global_ocean_sowisc12to30:

SO12to60 and SOwISC12to60
SO12to30 and SOwISC12to30
+++++++++++++++++++++++++

The ``SO12to60`` and ``SOwISC12to60`` meshes are Southern Ocean regionally
refined meshes with 12-km resolution around the Southern Ocean and Antarctica,
45-km at southern mid-latitudes, 30-km at the equator and in the North
Atlantic, 60-km resolution in the North Pacific, and 35-km resolution in the
Arctic.
The ``SO12to30`` and ``SOwISC12to30`` meshes are Southern Ocean regionally
refined meshes with 12-km resolution around the Southern Ocean and Antarctica
and have 30-km resoltuion elsewhere.

The class
:py:class:`compass.ocean.tests.global_ocean.mesh.so12to60.SO12to60BaseMesh` defines
the resolution for the meshes. The ``compass.ocean.tests.global_ocean.mesh.so12to60``
:py:class:`compass.ocean.tests.global_ocean.mesh.so12to30.SO12to30BaseMesh` defines
the resolution for the meshes. The ``compass.ocean.tests.global_ocean.mesh.so12to30``
module includes namelist options appropriate for forward simulations with
split-explicit (but not RK4) time integration on these meshes. These set the time
step and default run duration for short runs with these meshes.
Expand Down Expand Up @@ -824,24 +822,21 @@ The default config options for these meshes are:
prefix = SO
# a description of the mesh and initial condition
mesh_description = MPAS Southern Ocean regionally refined mesh for E3SM version
${e3sm_version} with enhanced resolution (${min_res} km) around
Antarctica, 45-km resolution in the mid southern latitudes,
30-km resolution in a 15-degree band around the equator, 60-km
resolution in northern mid latitudes, 30 km in the north
Atlantic and 35 km in the Arctic. This mesh has <<<levels>>>
vertical levels and includes cavities under the ice shelves
around Antarctica.
${e3sm_version} with enhanced resolution (${min_res} km) around
Antarctica and 30 km elsewhere. This mesh has <<<levels>>>
vertical levels and includes cavities under the ice shelves
around Antarctica.
# E3SM version that the mesh is intended for
e3sm_version = 3
# The revision number of the mesh, which should be incremented each time the
# mesh is revised
mesh_revision = 1
mesh_revision = 2
# the minimum (finest) resolution in the mesh
min_res = 12
# the maximum (coarsest) resolution in the mesh, can be the same as min_res
max_res = 60
max_res = 30
# The URL of the pull request documenting the creation of the mesh
pull_request = https://github.com/MPAS-Dev/compass/pull/460
pull_request = https://github.com/MPAS-Dev/compass/pull/752
# config options related to initial condition and diagnostics support files
Expand All @@ -851,6 +846,7 @@ The default config options for these meshes are:
# CMIP6 grid resolution
cmip6_grid_res = 180x360
The vertical grid is an ``index_tanh_dz`` profile (see
:ref:`dev_ocean_framework_vertical`) with 64 vertical levels ranging in
thickness from 10 to 250 m.
Expand Down
2 changes: 1 addition & 1 deletion docs/developers_guide/organization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1675,7 +1675,7 @@ should have cached outputs, the suffix ``c`` can be added to the test number:
compass setup -n 90c 91c 92 ...
In this example, test cases 90 and 91 (``mesh`` and ``init`` test cases from
the ``SOwISC12to60`` global ocean mesh, in this case) are set up with cached
the ``SOwISC12to30`` global ocean mesh, in this case) are set up with cached
outputs in all steps and 92 (``performance_test``) is not. This approach is
efficient but does not provide any control of which steps use cached outputs
and which do not.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/dev_add_rrm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This tutorial presents a step-by-step guide to adding a new mesh to the
``global_ocean`` test group in ``compass`` (see the :ref:`glossary` for
definitions of some relevant terms). In this tutorial, I will add a new
mesh called YAM ("yet another mesh") that is based on techniques used to build
the existing :ref:`dev_ocean_global_ocean_sowisc12to60` as well as
the existing :ref:`dev_ocean_global_ocean_sowisc12to30` as well as
:ref:`dev_ocean_global_ocean_wc14` meshes.

.. _dev_tutorial_add_rrm_getting_started:
Expand Down Expand Up @@ -164,7 +164,7 @@ Next, we need to add this mesh to the list of known meshes:
...
from compass.ocean.tests.global_ocean.mesh.so12to60 import SO12to60BaseMesh
from compass.ocean.tests.global_ocean.mesh.so12to30 import SO12to30BaseMesh
from compass.ocean.tests.global_ocean.mesh.wc14 import WC14BaseMesh
from compass.ocean.tests.global_ocean.mesh.yam10to60 import YAM10to60BaseMesh
from compass.ocean.tests.global_ocean.metadata import (
Expand Down
17 changes: 8 additions & 9 deletions docs/users_guide/ocean/test_groups/global_ocean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -435,24 +435,23 @@ ice-shelf cavities around Antarctica, whereas the RRS6to18 mesh does not.
:width: 500 px
:align: center

.. _global_ocean_mesh_sowisc12to60:
.. _global_ocean_mesh_sowisc12to30:

SO12to60 and SOwISC12to60
SO12to30 and SOwISC12to30
^^^^^^^^^^^^^^^^^^^^^^^^^

The Southern Ocean 12- to 60-km mesh with ice-shelf cavities (SOwISC12to60),
The Southern Ocean 12- to 30-km mesh with ice-shelf cavities (SOwISC12to30),
sometimes called the Southern Ocean regionally refined mesh (SORRM), is
the main simulation mesh for the
`E3SM v2 Cryosphere Science Campaign <https://e3sm.org/research/cryosphere-ocean/v2-cryosphere-research/>`_
and E3SM v3 Polar Processes, Sea-Level Rise, and Coastal Impacts Campaign.

The SO12to60 is the same mesh but without ice-shelf cavities.
The mesh has 12 km resolution around Antarctica, tapering to 45 km in mid
Southern latitudes, 30 km at the equator and in the North Atlantic, 60 km
in the North Pacific, and 35 km in the Arctic. The mesh includes the
:ref:`global_ocean_ice_shelf_cavities` around Antarctica in the ocean domain.
The SO12to30 is the same mesh but without ice-shelf cavities.
The mesh has 12-km resolution around Antarctica and 30-km resolution elsewhere.
The mesh includes the :ref:`global_ocean_ice_shelf_cavities` around Antarctica
in the ocean domain.

.. image:: images/sowisc12to60.png
.. image:: images/sowisc12to30.png
:width: 500 px
:align: center

Expand Down
4 changes: 2 additions & 2 deletions docs/users_guide/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -428,8 +428,8 @@ The output is:
-c ocean -t qu240_for_e3sm
-c ocean -t quwisc240
-c ocean -t quwisc240_for_e3sm
-c ocean -t so12to60
-c ocean -t sowisc12to60
-c ocean -t so12to30
-c ocean -t sowisc12to30
-c ocean -t wc14
-c ocean -t wcwisc14
-c ocean -t wetdry
Expand Down
4 changes: 2 additions & 2 deletions docs/users_guide/test_suites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ the current set of available test suites is:
-c ocean -t qu240_for_e3sm
-c ocean -t quwisc240
-c ocean -t quwisc240_for_e3sm
-c ocean -t so12to60
-c ocean -t sowisc12to60
-c ocean -t so12to30
-c ocean -t sowisc12to30
-c ocean -t wc14
-c ocean -t wcwisc14
-c ocean -t wetdry
Expand Down

0 comments on commit 467e79d

Please sign in to comment.