Added some additional comments to the .conf file

dtcenter · Jun 27, 2024 · 3997306 · 3997306
1 parent 95c4f1d
commit 3997306
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/...se_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO.py b/...se_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO.py
@@ -23,7 +23,7 @@
 # Datasets
 # --------
 #
-#  * GFS 0-24 hour forecasts for 10/2017 - 2/2018
+#  * GFS: 0-24 hour forecasts for 10/2017 - 2/2018
 #  * ERA: 30 year climatology for EOFs and 10/2017 - 2/2018  
 #
 

diff --git a/..._cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO.conf b/..._cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO.conf
@@ -44,27 +44,28 @@ LOOP_ORDER = processes
 # Variable to determine if Zonal and Meridional means are need to be computed on the data used
 # to create EOFS.  Set to True to compute zonal and meridional means.  If set to False, a file 
 # should be provided in EOF_DATA_FILE_NAME that specifies the location of a dataset with zonal
-# and meridional means.  The data should have the coordinates (time, pressure)
+# and meridional means.  The data should have the coordinates (time, pres), and the variable 
+# names should be the same as what are set in OBS_TIME_VAR, OBS_LAT_VAR, and OBS_U_VAR below.
 # Note, this is only for EOF calculation, and not for the data used to create plots.
 COMPUTE_EOF_ZONAL_MERIDIONAL_MEAN = False
 # Ignored if the above is set to True
 EOF_DATA_FILE_NAME = {INPUT_BASE}/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO/erai_zonal_mean_u.nc
 
-# Option to save out the Zonal/Meridional Mean data to be used to compute EOFs
+# Option to save out the Zonal/Meridional Mean data that was computed for the EOF calculation
 SAVE_EOF_ZONAL_MERIDIONAL_MEAN = False
 # Name of the output Zonal/meridional mean file.  Ignored if The above is set to False
 ZONAL_MERIDIONAL_MEAN_EOF_FILE_NAME = {INPUT_BASE}/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO/erai_zonal_mean_u.nc
 
 # Name of forecast variables for time, latitude, longitude, and U, and
-# dimensions for latitude and longitude
+# the dimension names for latitude and longitude
 FCST_TIME_VAR = time 
 FCST_LAT_VAR = latitude
 FCST_U_VAR = u
 FCST_LON_DIM = lon
 FCST_LAT_DIM = lat
 
 # Name of observation variables for time, latitude, longitude, and U and
-# dimensions for latitude and longitude
+# the dimension names for latitude and longitude
 OBS_TIME_VAR = time
 OBS_LAT_VAR = latitude
 OBS_U_VAR = u
@@ -79,8 +80,10 @@ PRES_LEV_MAX = 100
 LAT_MIN = -10
 LAT_MAX = 10
 
+# Name of the model used
 MODEL_NAME = GFS
 
+# Directory where output plots and statistics should be sent
 OUTPUT_DIR = {OUTPUT_BASE}/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO
 
 # Plot Settings
@@ -98,7 +101,7 @@ PLOT_PHASE_CIRCUTS_OUTPUT_NAME = ERA_GFS_QBO_circuits.png
 PLOT_PHASE_SPACE_TITLE = QBO Phase Space from ERA5 (10/2017 - 2/2018)
 PLOT_PHASE_SPACE_OUTPUT_NAME = ERA5_QBO_PhaseSpace.png
 
-# Time Series plot output name
+# Time Series plot titles and output names for 30mb and 50mb
 PLOT_TIME_SERIES_TITLE_30 = ERA5 and GFS Zonal Mean U at 30mb (10/2017 - 2/2018)
 PLOT_TIME_SERIES_OUTPUT_NAME_30 = ERA_GFS_timeseries_30mb_u_201710_201802.png
 PLOT_TIME_SERIES_TITLE_50 = ERA5 and GFS Zonal Mean U at 50mb (10/2017 - 2/2018)

diff --git a/...ons/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO/stratosphere_qbo_driver.py b/...ons/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereQBO/stratosphere_qbo_driver.py
@@ -132,7 +132,7 @@ def main():
 
 
     """
-    Save the Data to be loaded in the calculation of QBO
+    Save the Data for the EOF calculation for future use, if desired
     """
     save_zmm = os.environ.get('SAVE_EOF_ZONAL_MERIDIONAL_MEAN','False')
     if save_zmm.lower() == 'true':