documentation

Adds create_salin documentation and updates files_for_e3sm docs to point to WOA23

docs/developers_guide/ocean/test_groups/global_ocean.rst

@@ -1406,9 +1406,8 @@ The test case is made up of 10 steps:
     ice-shelf melt flux) compsets.
 
 :py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.remap_sea_surface_salinity_restoring.RemapSeaSurfaceSalinityRestoring`
-    is used to remap sea-surface salinity from the Polar science center
-    Hydrographic Climatology (PHC) to the MPAS mesh.  This dataset is used in
-    E3SM for compsets with data atmospheric/land forcing.
+    is used to remap sea-surface salinity from the World Ocean Atlas (2023) to the MPAS mesh.  
+    This dataset is used in E3SM for compsets with data atmospheric/land forcing.
 
 :py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.remap_iceberg_climatology.RemapIcebergClimatology`
     is used to remap freshwater fluxes from an iceberg climatology from

docs/developers_guide/ocean/test_groups/utility.rst

@@ -114,3 +114,30 @@ avoid this problem, we perform extrapolation in 4 steps.
 
 The resulting file is ready to be placed in compass' initial condition database
 (see :ref:`dev_step_input_download` for details on databases).
+
+create_salin_restoring
+----------------------
+The class :py:class:`compass.ocean.tests.utility.create_salin_restoring.CreateSalinRestoring`
+defines a test case for creating a monthly average sea surface salinity dataset based on the 
+`WOA 2023 <https://www.ncei.noaa.gov/products/world-ocean-atlas>`_ data.  It also extrapolates
+the twelve months of data into ice-shelf cavities and across continents.
+
+salinity_restoring
+------------------
+
+The class :py:class:`compass.ocean.tests.utility.create_salin_restoring.Salinity`
+defines a step to download and combine January through December sea surface salinity into a single
+file that serves as the base dataset for salinity restoring in forced ocean sea-ice cases (FOSI).  
+The surface level of WOA 2023 data is utilized.
+
+The reference date for each month of data is assumed to be the 15th of each month.  In a simulation,
+this implies that for a model start time of January 1, the salinity is restored to the average of 
+the December and January sea surface salinities.
+
+extrap_salin
+------------
+
+The class :py:class:`compass.ocean.tests.utility.create_salin_restoring.ExtrapSalin`
+defines a step to extrapolate the combined January through December sea surface salinities 
+into missing ocean regions such as ice-shelf cavities and across continents.  Since this is only
+extrapolation of surface values, masks are not utilized.

docs/users_guide/ocean/test_groups/utility.rst

@@ -32,3 +32,11 @@ ice-shelf cavities and coastal regions, then into land, grounded ice and below
 bathymetry.  It is provided mainly for developers to update for use on
 future datasets and is not intended for users, so we do not provide full
 documentation here.
+
+create_salin_restoring
+----------------------
+The ``ocean/utility/create_salin_restoring`` test case is used to download monthly 
+average `WOA 2023 <https://www.ncei.noaa.gov/products/world-ocean-atlas>`_ data, 
+extracts the surface layer and extrapolates into ice-shelf cavities and across
+continents.  It is provided mainly for developers to update the salinity restoring
+data and is not intended for users, so we do not provide full documentation here.