Feature 2741 add version (#2793)

* adding contents and version * adding contents and version * pbl and precip directory updates * s2s directory updates * short_range directory updates * adding contents and version numbers to last 3 directories * Removing "UPDATE_SECTION_CONTENT" text --------- Co-authored-by: Julie Prestopnik <[email protected]>
dtcenter · Nov 14, 2024 · 3a22fd9 · 3a22fd9
1 parent 368c90b
commit 3a22fd9
Show file tree

Hide file tree

Showing 66 changed files with 840 additions and 158 deletions.
diff --git a/...ases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py b/...ases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py
@@ -5,6 +5,12 @@
 model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -13,6 +19,12 @@
 # which was already being done in a closed system. By producing the same output via METplus, this use case
 # provides standardization and reproducible results.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 6.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...se_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.py b/...se_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.py
@@ -5,6 +5,12 @@
 model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -13,6 +19,12 @@
 # which was already being done in a closed system. By producing the same output via METplus, this use case
 # provides standardization and reproducible results.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 4.1
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/..._cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py b/..._cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py
@@ -5,6 +5,12 @@
 model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -13,6 +19,12 @@
 # which was already being done in a closed system. By producing the same output via METplus, this use case
 # provides standardization and reproducible results.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 4.1
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/..._cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py b/..._cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py
@@ -5,6 +5,12 @@
 model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -13,6 +19,12 @@
 # which was already being done in a closed system. By producing the same output via METplus, this use case
 # provides standardization and reproducible results.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 6.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...se_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py b/...se_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py
@@ -5,13 +5,25 @@
 model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
 #
 # By producing a postscript image from a file that utilizes a tripolar coordinate system, this use case shows METplus can utilize
 # python embedding to ingest and utilize file structures on the same coordinate system.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 4.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...ses/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py b/...ses/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py
@@ -5,6 +5,12 @@
 model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -13,6 +19,12 @@
 # Python embedding is utilized to pull user-selected variables and time frames from a runtime directory. 
 # Those point values are then compared to GFS data over two masked regions over ocean regions.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 6.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...odel_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py b/...odel_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py
@@ -5,6 +5,13 @@
 model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf
 
 """
+
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -15,6 +22,12 @@
 # up to verify using JASON-3 data, the Python script called on via Python Embedding is capabile
 # of processing SARAL and Sentinel-6a datasets as well.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 6.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...se_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.py b/...se_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.py
@@ -5,13 +5,25 @@
 model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
 #
 # This use case utilizes the new ASCII2NC method to natively read in NDBC ASCII files, a common source of sea surface data
 # for operational entities. These values are then compared to GFS' new wave height output, which it incorporated from Wave Watch III.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 5.1
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...s/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py b/...s/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py
@@ -5,6 +5,12 @@
 model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -13,6 +19,12 @@
 # netCDF files, a common source of ocean profile data for operational entities. These
 # values are then used by the PointStat tool to verify RTOFS ocean temperature forecast at 50 m depth.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 5.1
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...es/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py b/...es/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py
@@ -5,6 +5,13 @@
 model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf
 
 """
+
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -18,6 +25,12 @@
 # For the use case 3 days of data are utilized. The valid date is passed though an argument. The valid date 
 # is the last processed day i.e. the code grabs 3 previous days of data.    
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 5.1
+
 ##############################################################################
 # Datasets
 # ---------------------

diff --git a/docs/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py b/docs/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py
@@ -5,6 +5,12 @@
 model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -16,6 +22,12 @@
 # allowed the use case to more closely replicate in-house verificaiton that already existed.
 # A final note that because the POE forecast file is a non-standard netCDF, Python Embedding was used to extract the desired field
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 5.1
+
 ##############################################################################
 # Datasets
 # ---------------------

diff --git a/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.py b/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.py
@@ -1,11 +1,16 @@
 """
 Grid-Stat: Standard Verification of Surface Fields
-================================================================================
+==================================================
 
-model_applications/medium_range/GridStat_fcstGFS_obsGFS
-_Sfc_MultiField.conf
+model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -14,6 +19,12 @@
 # the skill of the prediction.  Statistics stored only as partial sums to save space.
 # Stat-Analysis must be used to compute Continuous Statistics.
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 3.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/...use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py b/...use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py
@@ -1,18 +1,29 @@
 """
 Grid-Stat: Compute Anomaly Correlation using Climatology  
-============================================================================
+========================================================
 
-model_applications/medium_range/GridStat_fcstGFS_obsGFS
-_climoNCEP_MultiField.conf
+model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
 # To provide useful statistical information on the relationship between observation
 # data in gridded format to a gridded forecast. These values can be used to help
 # correct model deviations from observed values. 
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 3.0
+
 ##############################################################################
 # Datasets
 # --------

diff --git a/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone.py b/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone.py
@@ -1,11 +1,16 @@
 """
 Grid-Stat: Using Python Embedding for Total Column Ozone
-================================================================================
+========================================================
 
-model_applications/medium_range/GridStat_fcstGFS_obsOMI
-_TotalColumnOzone.conf
+model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone.conf
 
 """
+##############################################################################
+# .. contents::
+#   :depth: 1
+#   :local:
+#   :backlinks: none
+
 ##############################################################################
 # Scientific Objective
 # --------------------
@@ -14,6 +19,12 @@
 # data covers a 36 hour period and is compared to the average of the gridded forecast
 # files (all from the same initialization time). 
 
+##############################################################################
+# Version Added
+# -------------
+#
+# METplus version 6.0
+
 ##############################################################################
 # Datasets
 # --------