From fc6cdb90b05ff260621607370693ecdd6ccaf419 Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Fri, 21 Feb 2025 14:22:53 -0600 Subject: [PATCH] Update docs --- docs/users_guide/config/regions.rst | 8 ++++---- docs/users_guide/tasks/timeSeriesOHCAnomaly.rst | 4 ++-- docs/users_guide/tasks/timeSeriesSST.rst | 4 ++-- docs/users_guide/tasks/timeSeriesSalinityAnomaly.rst | 4 ++-- docs/users_guide/tasks/timeSeriesTemperatureAnomaly.rst | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/users_guide/config/regions.rst b/docs/users_guide/config/regions.rst index aa2a25729..e41fe60aa 100644 --- 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 index 4ec726ef8..35ea82255 100644 --- 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 index 3ba29f8c4..19a6dffcc 100644 --- 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 index 8ad608e82..6b0cb597f 100644 --- 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 index 4251efae6..a30827584 100644 --- 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