Edit typo

docs/use_cases/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.py

@@ -89,18 +89,18 @@
 # METplus Workflow
 # ----------------
 #
-# **Beginning time (VALID_BEG):** 20170101
+# **Beginning time (VALID_BEG):** 01-01-2017
 #
-# **End time (VALID_END):** 20181231
+# **End time (VALID_END):** 12-31-2018
 #
 # **Increment between beginning and end times (VALID_INCREMENT):** 1 day
 #
 # **Sequence of forecast leads to process (LEAD_SEQ):** 0
 #
 # This use case does not loop, but the UserScript to create and EOF filelist is run once and the OMI driver script is 
 # run once for both the model and observations across the entire time period.  The 3 optional pre-processing steps 
-# loop by valid time. The Phase diagram plots are created over a different time frame than the calculation, 01-01-2017
-# to 03-31-2017 for both plots.
+# loop by valid time when they are turned on. The Phase diagram plots are created over a different time frame than the 
+# calculation, 01-01-2017 to 03-31-2017 for both plots.
 
 ##############################################################################
 # METplus Configuration

docs/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.py

@@ -87,9 +87,9 @@
 # METplus Workflow
 # ----------------
 #
-# **Beginning time calculation (VALID_BEG):** 19790101
+# **Beginning time calculation (VALID_BEG):** 01-01-1979
 #
-# **End time calculation (VALID_END):** 20121230
+# **End time calculation (VALID_END):** 12-30-2012
 #
 # **Increment between beginning and end times (VALID_INCREMENT):** 1 day
 #

docs/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.py

@@ -60,11 +60,11 @@
 #
 # This use case calls UserScript 5 times and Regrid-Data-Plane multiple times.  These UserScript calls do 
 # not loop.  The first call creates a list of the mean daily annual data files for OLR, U850, and U200. It 
-# is done separately since the mean daily annual files are span across all years whereas the RMM calculation 
+# is done separately since the mean daily annual files span across all years whereas the RMM calculation 
 # can proceed on a different time frame.  The second, third, and fourth calls to UserScript run the pre-processing 
-# on OLR, U850, and U200 using a harmonic analysis program in python.  Then, RegridDataPlane is run for all valid 
-# times for the 3 variables.  This step cuts the grid to only include -15 to 15 latitude.  The last (fifth) call 
-# to UserScript runs the RMM calculation once on the observations.
+# to compute anomalies OLR, U850, and U200 using a harmonic analysis program in python.  Then, RegridDataPlane is 
+# run for all valid times for the 3 variables.  This step cuts the grid to only include -15 to 15 latitude.  Finally, 
+# the last (fifth) call to UserScript runs the RMM calculation once on the observations.
 #
 # There are four optional pre-processing steps.  These steps are turned off due to data size and processing
 # time.  Two of the steps are calls to PcP-Combine to compute the mean daily annual data for OLR, wind 
@@ -94,9 +94,9 @@
 # METplus Workflow
 # ----------------
 #
-# **Beginning time (VALID_BEG):** 2000010100
+# **Beginning time (VALID_BEG):** 01-01-2000
 #
-# **End time (VALID_END):** 2002123000
+# **End time (VALID_END):** 12-30-2002
 #
 # **Increment between beginning and end times (INIT_INCREMENT):** 1 day
 #

docs/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias.py

@@ -8,6 +8,12 @@
 
 """
 
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -22,67 +28,78 @@
 # In addition this use case also demonstrates how to read semi-structured grids into
 # MET.  Specifically zonal mean data is read into Series-Analysis in the second step
 # of this use case.
-#
 
 ##############################################################################
 # Version Added
 # -------------
 #
 # METplus version 6.0
-#
 
 ##############################################################################
 # Datasets
 # --------
 #
-# Forecast dataset: GFS 24 hour forecasts for February 2018
-# Observation dataset: ERA reanalysis for February 2018
+# **Forecast:** GFS 24 hour forecasts for February 2018
 #
+# **Observation:** ERA reanalysis for February 2018
+#
+# **Climatology:** None
+#
+# **Location:** All of the input data required for this use case can be 
+# found in a sample data tarball. Each use case category will have 
+# one or more sample data tarballs. It is only necessary to download 
+# the tarball with the use case’s dataset and not the entire collection 
+# of sample data. Click here to access the METplus releases page and download sample data 
+# for the appropriate release: https://github.com/dtcenter/METplus/releases
+# This tarball should be unpacked into the directory that you will 
+# set the value of INPUT_BASE. See :ref:`running-metplus` section for more information.
 
 ##############################################################################
 # METplus Components
 # ------------------
 #
-# This use case calls UserScript first, then Series-Analysis, and then UserScript
+# This use case calls UserScript first, Series-Analysis, and then UserScript
 # a second time.  The first call to UserScript runs zonal_mean_driver.py.  This script
 # computes zonal and meridional mean data from the directional_means program in 
 # METplotpy.  Then, Series-Analysis is run on the zonal mean output to compute
 # continuous statistics.  Finally, the second call to UserScript runs bias_plot_driver.py
 # which creates bias plots for temperature and wind.
 #
+# METcalcpy, METplotpy, and METdataio are needed for this use case to run.  The metcalcpy 
+# scripts accessed include the following:
+# * metcalcpy/contributed/zonal_meridional/recipes.py 
+#
+# The METplotpy scripts accessed include the following:
+# * metplotpy/stratosphere_diagnostics/stratosphere_plots.py
+#
+# The METdataio scripts accessed include the following:
+# * METreadnc/util/read_netcdf.py
 
 ##############################################################################
 # METplus Workflow
 # ----------------
 #
-# This use case does not loop.  The two calls to UserScript are run once.  Series-
-# Analysis is also run once.
+# **Beginning time (INIT_BEG):** 02-01-2018
 #
-# METcalcpy version 3.0, METplotpy version 3.0, and METdataio version 2.1 are needed 
-# for this use case to run.  The metcalcpy scripts accessed include the following:
-# * metcalcpy/contributed/zonal_meridional/recipes.py 
+# **End time (INIT_END):** 02-28-2018
 #
-# The METplotpy scripts accessed include the following:
-# * metplotpy/stratosphere_diagnostics/stratosphere_plots.py
+# **Increment between beginning and end times (INIT_INCREMENT):** 30 days
 #
-# The METdataio scripts accessed include the following:
-# * METreadnc/util/read_netcdf.py
+# **Sequence of forecast leads to process (LEAD_SEQ):** 24
 #
+# This use case does not loop.  The two calls to UserScript are run once.  Series-
+# Analysis is also run once.
 
 ##############################################################################
 # METplus Configuration
 # ---------------------
 #
 # METplus first loads all of the configuration files found in parm/metplus_config,
-# then it loads any configuration files passed to METplus via the command line
+# then it loads any configuration files passed to METplus via the command line,
 # i.e. parm/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias.conf.
-# The files UserScript_fcstGFS_obsERA_StratosphereBias/HELP_driver.py and 
-# UserScript_fcstGFS_obsERA_StratosphereBias/HELP_driver.py run the python programs and the
-# variables for both are set in the [user_env_vars] section of the .conf file. 
 #
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias.conf
-#
 
 #############################################################################
 # MET Configuration
@@ -96,13 +113,10 @@
 # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to:
 # :ref:`Overriding Unsupported MET config file settings<met-config-overrides>`
 #
-# **SeriesAnalysisConfig_wrapped**
-#
-# .. note:: See the :ref:`Series-Analysis MET Configuration<series-analysis-met-conf>` section of the User's Guide for more information on the environment variables used in the file below:
-#
-# .. highlight:: bash
-# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped
+# .. dropdown:: SeriesAnalysisConfig_wrapped
 #
+#   .. highlight:: bash
+#   .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped
 
 ##############################################################################
 # Python Embedding
@@ -112,9 +126,10 @@
 # this script include the filename to be read in, variable name, and the axis over which the mean is taken.  The script 
 # returns a numpy array containing the zonal mean data (semi structured grid).
 #
-# .. highlight:: bash
-# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias/read_met_axis_mean.py
+# .. dropdown:: read_met_axis_mean.py
 #
+#   .. highlight:: bash
+#   .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias/read_met_axis_mean.py
 
 ##############################################################################
 # Python Scripting
@@ -132,7 +147,6 @@
 #        run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias.conf /path/to/user_system.conf
 #
 # See :ref:`running-metplus` for more information.
-#
 
 ##############################################################################
 # Expected Output