Skip to content

Commit 2cc557c

Browse files
docs(landice): update slm -> slm_circ_icesheet, add smoke_test docs
1 parent f7b639d commit 2cc557c

4 files changed

Lines changed: 47 additions & 33 deletions

File tree

docs/developers_guide/landice/api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -450,15 +450,15 @@ mismipplus
450450
tasks.exact_cell_count
451451
tasks.approx_cell_count
452452

453-
slm
453+
slm_circ_icesheet
454454
~~~
455455

456-
.. currentmodule:: compass.landice.tests.slm
456+
.. currentmodule:: compass.landice.tests.slm_circ_icesheet
457457

458458
.. autosummary::
459459
:toctree: generated/
460460

461-
Slm
461+
SlmCircIcesheet
462462

463463
circ_icesheet.CircIcesheetTest
464464
circ_icesheet.CircIcesheetTest.configure

docs/developers_guide/landice/test_groups/slm.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
.. _dev_landice_slm:
1+
.. _dev_landice_slm_circ_icesheet:
22

3-
slm
4-
===
3+
slm_circ_icesheet
4+
==================
55

6-
The ``slm`` test group (:py:class:`compass.landice.tests.slm.Slm`) adds an
7-
framework for evaluating coupled MALI and Sea-Level Model (SLM)
8-
behavior. The group currently contains one test case,
9-
``circular_icesheet_test``
10-
(:py:class:`compass.landice.tests.slm.circ_icesheet.CircIcesheetTest`),
11-
which is designed to compare MALI-derived and SLM-derived estimates of sea
12-
level change for a controlled circular ice-sheet geometry.
6+
The ``slm_circ_icesheet`` test group (:py:class:`compass.landice.tests.slm_circ_icesheet.SlmCircIcesheet`) adds a
7+
framework for evaluating coupled MALI and Sea-Level Model (SLM) behavior.
8+
The group contains two test cases:
9+
10+
* ``mesh_convergence`` (:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.CircIcesheetTest`),
11+
which compares MALI-derived and SLM-derived estimates of sea-level change
12+
across a parameter sweep of mesh and SLM resolutions.
13+
* ``smoke_test``, a minimal test case intended for quick validation and CI.
1314

1415
framework
1516
---------
@@ -32,7 +33,7 @@ setup_mesh
3233
~~~~~~~~~~
3334

3435
The class
35-
:py:class:`compass.landice.tests.slm.circ_icesheet.setup_mesh.SetupMesh`
36+
:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.setup_mesh.SetupMesh`
3637
builds all inputs required by MALI and SLM coupling for each
3738
``(mali_res, slm_nglv)`` combination:
3839

@@ -51,15 +52,15 @@ run_model
5152
~~~~~~~~~
5253

5354
The class
54-
:py:class:`compass.landice.tests.slm.circ_icesheet.run_model.RunModel`
55+
:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.run_model.RunModel`
5556
consumes the mesh, graph, SMB forcing, and mapping files from ``setup_mesh``
5657
and runs MALI with SLM coupling options enabled in ``namelist.landice``.
5758

5859
During ``setup()``, the step also:
5960

6061
* creates ``OUTPUT_SLM`` and ``ICELOAD_SLM`` directories,
6162
* renders ``namelist.sealevel`` from the Jinja template
62-
``compass.landice.tests.slm.namelist.sealevel.template``, and
63+
``compass.landice.tests.slm_circ_icesheet.namelist.sealevel.template``, and
6364
* fills SLM input paths from the ``slm_input_root`` config option.
6465

6566
The expected structure beneath ``slm_input_root`` is:
@@ -72,7 +73,7 @@ visualize
7273
~~~~~~~~~
7374

7475
The class
75-
:py:class:`compass.landice.tests.slm.circ_icesheet.visualize.Visualize`
76+
:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.visualize.Visualize`
7677
collects all ``output.nc`` files produced by the parameter sweep and computes
7778
diagnostic quantities for coupled MALI-SLM comparison.
7879

docs/users_guide/landice/test_groups/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ physics but that are not run routinely.
3030
koge_bugt_s
3131
mesh_modifications
3232
mismipplus
33-
slm
33+
slm_circ_icesheet
3434
thwaites

docs/users_guide/landice/test_groups/slm.rst

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
.. _landice_slm:
1+
.. _landice_slm_circ_icesheet:
22

3-
slm
4-
===
3+
slm_circ_icesheet
4+
==================
55

6-
The ``landice/slm`` test group adds a workflow for coupled
7-
MALI and Sea-Level Model (SLM)
8-
configurations. It currently contains one test case,
9-
``circular_icesheet_test``, that creates an idealized circular ice sheet and
10-
compares MALI- and SLM-derived sea-level diagnostics across a configurable
11-
sweep of mesh and SLM resolutions.
6+
The ``landice/slm_circ_icesheet`` test group adds a workflow for coupled
7+
MALI and Sea-Level Model (SLM) configurations. It contains two test cases:
128

13-
The test case is useful for:
9+
- ``mesh_convergence``: a parameter sweep used to compare MALI- and
10+
SLM-derived sea-level diagnostics across a configurable sweep of mesh and
11+
SLM resolutions.
12+
- ``smoke_test``: a minimal smoke test that exercises the setup and a
13+
short model run for quick validation and CI purposes.
14+
15+
The test cases are useful for:
1416

1517
* validating coupled MALI-SLM setup and mapping files,
1618
* comparing sensitivity to MALI horizontal resolution and SLM ``nglv``, and
1719
* generating summary error plots for sea-level diagnostics.
1820

19-
circular_icesheet_test
20-
----------------------
21+
mesh_convergence
22+
----------------
2123

22-
The test case path is:
24+
The convergence test case path is:
2325

24-
``landice/slm/circular_icesheet_test``
26+
``landice/slm_circ_icesheet/mesh_convergence``
2527

2628
At configure time, the test case reads:
2729

@@ -35,6 +37,17 @@ For each ``(mali_res, slm_nglv)`` combination, it creates:
3537

3638
It also creates one shared ``visualize`` step to analyze all combinations.
3739

40+
smoke_test
41+
----------
42+
43+
The smoke test path is:
44+
45+
``landice/slm_circ_icesheet/smoke_test``
46+
47+
This test provides a minimal configuration (small mesh and short run) that
48+
validates the mesh setup, mapping-file generation, and the end-to-end
49+
coupling workflow without requiring a full parameter sweep.
50+
3851
setup_mesh
3952
~~~~~~~~~~
4053

@@ -108,4 +121,4 @@ The test case uses four config sections:
108121
* ``[circ_icesheet_viz]``: plotting controls and fallback ocean-area constants
109122

110123
The defaults are in
111-
``compass/landice/tests/slm/circ_icesheet/circ_icesheet.cfg``.
124+
``compass/landice/tests/slm_circ_icesheet/smoke_test/smoke_test.cfg``.

0 commit comments

Comments
 (0)