Update docs

MPAS-Dev · Feb 22, 2025 · 82b6a96 · 82b6a96
1 parent f8c40ee
commit 82b6a96
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 12 deletions.
diff --git a/docs/developers_guide/api.rst b/docs/developers_guide/api.rst
@@ -94,6 +94,9 @@ Ocean tasks
    WoaTransects
    WoceTransects
 
+Ocean subtasks
+--------------
+
 .. currentmodule:: mpas_analysis.ocean.compute_anomaly_subtask
 
 .. autosummary::
@@ -116,6 +119,19 @@ Ocean tasks
    PlotHovmollerSubtask
 
 
+Ocean utilities
+---------------
+
+.. currentmodule:: mpas_analysis.ocean.utility
+
+.. autosummary::
+   :toctree: generated/
+
+   add_standard_regions_and_subset
+   get_standard_region_names
+   compute_zmid
+
+
 Sea ice tasks
 -------------
 

diff --git a/docs/users_guide/config/regions.rst b/docs/users_guide/config/regions.rst
@@ -15,10 +15,10 @@ within MPAS-Analysis using region mask files::
 
   # list of region names (needs to be in the same order as region indices in
   # time-series stats)
-  regions = ['arctic', 'equatorial', 'so', 'nino3', 'nino4', 'nino3.4', 'global']
-  # list of plot titles (needs to be in the same order as region indices in
-  # time-series stats)
-  plotTitles = ['Arctic', 'Equatorial (15S-15N)', 'Southern Ocean', 'Nino 3',
+  regionShortNames = ['arctic', 'equatorial', 'so', 'nino3', 'nino4', 'nino3.4',
+                      'global']
+  # list of full names (e.g. for plot titles) same order as regionShortNames
+  regionNames = ['Arctic', 'Equatorial (15S-15N)', 'Southern Ocean', 'Nino 3',
                 'Nino 4', 'Nino 3.4', 'Global Ocean']
 
 

diff --git a/docs/users_guide/tasks/timeSeriesOHCAnomaly.rst b/docs/users_guide/tasks/timeSeriesOHCAnomaly.rst
@@ -21,8 +21,8 @@ The following configuration options are available for this task::
   ## options related to plotting time series of ocean heat content (OHC)
   ## anomalies from year 1
 
-  # list of regions to plot from the region list in [regions] below
-  regions = ['global']
+  # list of region shrot names to plot from the region list in [regions] above
+  regionShortNames = ['global']
 
   # approximate depths (m) separating plots of the upper, middle and lower ocean
   depths = [700, 2000]

diff --git a/docs/users_guide/tasks/timeSeriesSST.rst b/docs/users_guide/tasks/timeSeriesSST.rst
@@ -20,8 +20,8 @@ The following configuration options are available for this task::
   [timeSeriesSST]
   ## options related to plotting time series of sea surface temperature (SST)
 
-  # list of regions to plot from the region list in [regions] below
-  regions = ['global']
+  # list of region shrot names to plot from the region list in [regions] above
+  regionShortNames = ['global']
 
   # Number of points over which to compute moving average (e.g., for monthly
   # output, movingAveragePoints=12 corresponds to a 12-month moving average

diff --git a/docs/users_guide/tasks/timeSeriesSalinityAnomaly.rst b/docs/users_guide/tasks/timeSeriesSalinityAnomaly.rst
@@ -20,8 +20,8 @@ The following configuration options are available for this task::
   [hovmollerSalinityAnomaly]
   ## options related to plotting time series of salinity vs. depth
 
-  # list of regions to plot from the region list in [regions] below
-  regions = ['global']
+  # list of region shrot names to plot from the region list in [regions] above
+  regionShortNames = ['global']
 
   # Number of points over which to compute moving average(e.g., for monthly
   # output, movingAveragePoints=12 corresponds to a 12-month moving average

diff --git a/docs/users_guide/tasks/timeSeriesTemperatureAnomaly.rst b/docs/users_guide/tasks/timeSeriesTemperatureAnomaly.rst
@@ -20,8 +20,8 @@ The following configuration options are available for this task::
   [hovmollerTemperatureAnomaly]
   ## options related to plotting time series of potential temperature vs. depth
 
-  # list of regions to plot from the region list in [regions] below
-  regions = ['global']
+  # list of region shrot names to plot from the region list in [regions] above
+  regionShortNames = ['global']
 
   # Number of points over which to compute moving average(e.g., for monthly
   # output, movingAveragePoints=12 corresponds to a 12-month moving average