Update docs

Author: matthewhoffman

docs/developers_guide/landice/api.rst

@@ -450,30 +450,31 @@ mismipplus
    tasks.exact_cell_count
    tasks.approx_cell_count 
 
-slm
+slm_circ_icesheet
 ~~~
 
-.. currentmodule:: compass.landice.tests.slm
+.. currentmodule:: compass.landice.tests.slm_circ_icesheet
 
 .. autosummary::
    :toctree: generated/
 
-   Slm
+   SlmCircIcesheet
 
-   circ_icesheet.CircIcesheetTest
-   circ_icesheet.CircIcesheetTest.configure
+   mesh_convergence.MeshConvergenceTest
+   mesh_convergence.MeshConvergenceTest.configure
+   smoke_test.SmokeTest
 
-   circ_icesheet.run_model.RunModel
-   circ_icesheet.run_model.RunModel.setup
-   circ_icesheet.run_model.RunModel.run
+   run_model.RunModel
+   run_model.RunModel.setup
+   run_model.RunModel.run
 
-   circ_icesheet.setup_mesh.SetupMesh
-   circ_icesheet.setup_mesh.SetupMesh.run
+   setup_mesh.SetupMesh
+   setup_mesh.SetupMesh.run
 
-   circ_icesheet.visualize.Visualize
-   circ_icesheet.visualize.Visualize.setup
-   circ_icesheet.visualize.Visualize.run
-   circ_icesheet.visualize.visualize_slm_circsheet
+   visualize.Visualize
+   visualize.Visualize.setup
+   visualize.Visualize.run
+   visualize.visualize_slm_circsheet
 
 thwaites
 ~~~~~~~~

docs/developers_guide/landice/test_groups/slm.rst

@@ -1,15 +1,16 @@
-.. _dev_landice_slm:
+.. _dev_landice_slm_circ_icesheet:
 
-slm
-===
+slm_circ_icesheet
+==================
 
-The ``slm`` test group (:py:class:`compass.landice.tests.slm.Slm`) adds an
-framework for evaluating coupled MALI and Sea-Level Model (SLM)
-behavior.  The group currently contains one test case,
-``circular_icesheet_test``
-(:py:class:`compass.landice.tests.slm.circ_icesheet.CircIcesheetTest`),
-which is designed to compare MALI-derived and SLM-derived estimates of sea
-level change for a controlled circular ice-sheet geometry.
+The ``slm_circ_icesheet`` test group (:py:class:`compass.landice.tests.slm_circ_icesheet.SlmCircIcesheet`) adds a
+framework for evaluating coupled MALI and Sea-Level Model (SLM) behavior.
+The group contains two test cases:
+
+* ``mesh_convergence`` (:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.CircIcesheetTest`),
+  which compares MALI-derived and SLM-derived estimates of sea-level change
+  across a parameter sweep of mesh and SLM resolutions.
+* ``smoke_test``, a minimal test case intended for quick validation and CI.
 
 framework
 ---------
@@ -32,7 +33,7 @@ setup_mesh
 ~~~~~~~~~~
 
 The class
-:py:class:`compass.landice.tests.slm.circ_icesheet.setup_mesh.SetupMesh`
+:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.setup_mesh.SetupMesh`
 builds all inputs required by MALI and SLM coupling for each
 ``(mali_res, slm_nglv)`` combination:
 
@@ -51,15 +52,15 @@ run_model
 ~~~~~~~~~
 
 The class
-:py:class:`compass.landice.tests.slm.circ_icesheet.run_model.RunModel`
+:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.run_model.RunModel`
 consumes the mesh, graph, SMB forcing, and mapping files from ``setup_mesh``
 and runs MALI with SLM coupling options enabled in ``namelist.landice``.
 
 During ``setup()``, the step also:
 
 * creates ``OUTPUT_SLM`` and ``ICELOAD_SLM`` directories,
 * renders ``namelist.sealevel`` from the Jinja template
-  ``compass.landice.tests.slm.namelist.sealevel.template``, and
+  ``compass.landice.tests.slm_circ_icesheet.namelist.sealevel.template``, and
 * fills SLM input paths from the ``slm_input_root`` config option.
 
 The expected structure beneath ``slm_input_root`` is:
@@ -72,7 +73,7 @@ visualize
 ~~~~~~~~~
 
 The class
-:py:class:`compass.landice.tests.slm.circ_icesheet.visualize.Visualize`
+:py:class:`compass.landice.tests.slm_circ_icesheet.circ_icesheet.visualize.Visualize`
 collects all ``output.nc`` files produced by the parameter sweep and computes
 diagnostic quantities for coupled MALI-SLM comparison.
 

docs/users_guide/landice/test_groups/index.rst

@@ -30,5 +30,5 @@ physics but that are not run routinely.
    koge_bugt_s
    mesh_modifications
    mismipplus
-   slm
+   slm_circ_icesheet
    thwaites

docs/users_guide/landice/test_groups/slm.rst

@@ -1,27 +1,29 @@
-.. _landice_slm:
+.. _landice_slm_circ_icesheet:
 
-slm
-===
+slm_circ_icesheet
+==================
 
-The ``landice/slm`` test group adds a workflow for coupled
-MALI and Sea-Level Model (SLM)
-configurations.  It currently contains one test case,
-``circular_icesheet_test``, that creates an idealized circular ice sheet and
-compares MALI- and SLM-derived sea-level diagnostics across a configurable
-sweep of mesh and SLM resolutions.
+The ``landice/slm_circ_icesheet`` test group adds a workflow for coupled
+MALI and Sea-Level Model (SLM) configurations. It contains two test cases:
 
-The test case is useful for:
+- ``mesh_convergence``: a parameter sweep used to compare MALI- and
+    SLM-derived sea-level diagnostics across a configurable sweep of mesh and
+    SLM resolutions.
+- ``smoke_test``: a minimal smoke test that exercises the setup and a
+    short model run for quick validation and CI purposes.
+
+The test cases are useful for:
 
 * validating coupled MALI-SLM setup and mapping files,
 * comparing sensitivity to MALI horizontal resolution and SLM ``nglv``, and
 * generating summary error plots for sea-level diagnostics.
 
-circular_icesheet_test
-----------------------
+mesh_convergence
+----------------
 
-The test case path is:
+The convergence test case path is:
 
-``landice/slm/circular_icesheet_test``
+``landice/slm_circ_icesheet/mesh_convergence``
 
 At configure time, the test case reads:
 
@@ -35,6 +37,17 @@ For each ``(mali_res, slm_nglv)`` combination, it creates:
 
 It also creates one shared ``visualize`` step to analyze all combinations.
 
+smoke_test
+----------
+
+The smoke test path is:
+
+``landice/slm_circ_icesheet/smoke_test``
+
+This test provides a minimal configuration (small mesh and short run) that
+validates the mesh setup, mapping-file generation, and the end-to-end
+coupling workflow without requiring a full parameter sweep.
+
 setup_mesh
 ~~~~~~~~~~
 
@@ -108,4 +121,4 @@ The test case uses four config sections:
 * ``[circ_icesheet_viz]``: plotting controls and fallback ocean-area constants
 
 The defaults are in
-``compass/landice/tests/slm/circ_icesheet/circ_icesheet.cfg``.
+``compass/landice/tests/slm_circ_icesheet/smoke_test/smoke_test.cfg``.