Fix ISOMIP+ docs

compass/ocean/tests/isomip_plus/geom.py

@@ -5,10 +5,9 @@
 
 def define_thin_film_mask_step1(ds_mesh, ds_geom):
     """
-    Interpolate the ocean mask from the original BISICLES grid to the MPAS
-    mesh.  This is handled separately from other fields because the ocean mask
-    is needed to cull land cells from the MPAS mesh before interpolating the
-    remaining fields.
+    Define an MPAS mesh mask for the ocean domain including cells over the 
+    full x- and y-range in order to include all land cells in the ocean's 
+    thin-film region.
 
     Parameters
     ----------
@@ -17,7 +16,7 @@ def define_thin_film_mask_step1(ds_mesh, ds_geom):
 
     ds_geom : xarray.Dataset
         Ice-sheet topography produced by
-        :py:func:`compass.ocean.tests.isomip_plus.geom.process_input_geometry()`
+        :py:class:`compass.ocean.tests.isomip_plus.process_geom.ProcessGeom`
 
     Returns
     -------
@@ -57,7 +56,7 @@ def interpolate_ocean_mask(ds_mesh, ds_geom, min_ocean_fraction):
 
     ds_geom : xarray.Dataset
         Ice-sheet topography produced by
-        :py:func:`compass.ocean.tests.isomip_plus.geom.process_input_geometry()`
+        :py:class:`compass.ocean.tests.isomip_plus.process_geom.ProcessGeom`
 
     min_ocean_fraction : float
         The minimum ocean fraction after interpolation, below which the cell
@@ -105,7 +104,7 @@ def interpolate_geom(ds_mesh, ds_geom, min_ocean_fraction, thin_film_present):
 
     ds_geom : xarray.Dataset
         Ice-sheet topography produced by
-        :py:func:`compass.ocean.tests.isomip_plus.geom.process_input_geometry()`
+        :py:class:`compass.ocean.tests.isomip_plus.process_geom.ProcessGeom`
 
     min_ocean_fraction : float
         The minimum ocean fraction after interpolation, below which the cell

docs/developers_guide/ocean/api.rst

@@ -434,15 +434,19 @@ isomip_plus
    forward.Forward.setup
    forward.Forward.run
 
-   geom.process_input_geometry
+   geom.define_thin_film_mask_step1
    geom.interpolate_ocean_mask
+   geom.interpolate_geom
 
    initial_state.InitialState
    initial_state.InitialState.run
 
    misomip.Misomip
    misomip.Misomip.run
 
+   process_geom.ProcessGeom
+   process_geom.ProcessGeom.run
+
    ssh_adjustment.SshAdjustment
    ssh_adjustment.SshAdjustment.setup
    ssh_adjustment.SshAdjustment.run

docs/developers_guide/ocean/test_groups/isomip_plus.rst

@@ -33,11 +33,10 @@ rising indefinitely due to the input of freshwater from ice-shelf melting.
 geom
 ~~~~
 
-The function :py:func:`compass.ocean.tests.isomip_plus.geom.process_input_geometry()`
-is used to apply a simple calving scheme based on a threshold in ice-shelf
-thickness, then apply smoothing to the topography data.  Optionally, the
-ice draft can be scaled by a factor as a simple way to explore changing
-ice-shelf topography.
+The function :py:func:`compass.ocean.tests.isomip_plus.geom.define_thin_film_mask_step1()`
+defines an MPAS mesh mask for the ocean domain including cells over the full x- and y-range
+in cases with a thin film. Thus, all land cells are included in the ocean's thin-film region.
+
 
 The function :py:func:`compass.ocean.tests.isomip_plus.geom.interpolate_ocean_mask()`
 interpolates the ocean mask from the BISICLES grid of the input geometry to
@@ -62,6 +61,17 @@ interpolates the remaining geometric variables:
   may be useful for determining where to alter the vertical coordinate
   to accommodate ice-shelf cavities
 
+process_geom
+~~~~~~~~~~~~
+
+The class :py:class:`compass.ocean.tests.isomip_plus.process_geom.ProcessGeom`
+defines a step for processing ISOMIP+ geometry before interpolating it to the
+MPAS mesh.  This includes applying a simple calving scheme based on a threshold
+in ice-shelf thickness, then apply smoothing to the topography data.
+Optionally, the ice draft can be scaled by a factor as a simple way to explore
+changing ice-shelf topography.  Variables are renamed to those expected by
+MPAS-Ocean.
+
 initial_state
 ~~~~~~~~~~~~~