diff --git a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py index c1e39cc16c..4911eaea6d 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py +++ b/docs/use_cases/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/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.py index 402270f33d..90c0c7932e 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.py +++ b/docs/use_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/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py index 4bae915266..1533bc0446 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py +++ b/docs/use_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/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py index c03b5fbba1..990676e1f1 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py +++ b/docs/use_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/docs/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py b/docs/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py index b4e14a9da8..c4270bf3ab 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py @@ -5,6 +5,12 @@ model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -12,6 +18,12 @@ # 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/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py b/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py index 45990492dc..d69ddc2051 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py +++ b/docs/use_cases/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/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py b/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py index af2ec6a88b..993daea910 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py +++ b/docs/use_cases/model_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/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.py b/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.py index 475d02714b..b9ab4d09ef 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.py @@ -5,6 +5,12 @@ model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -12,6 +18,12 @@ # 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/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py b/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py index 91bc23d7b0..5365334185 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py +++ b/docs/use_cases/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/docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py b/docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py index 73709c5a56..f71426327c 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py +++ b/docs/use_cases/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 index d62e5e0ef8..2f2e660d74 100644 --- 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 index 7eb6e7658a..560f626c7d 100644 --- 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/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py b/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py index f9aca4fc8d..9deb21e508 100644 --- a/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py +++ b/docs/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py @@ -1,11 +1,16 @@ """ 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 # -------------------- @@ -13,6 +18,12 @@ # 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 index 71a828ee1d..798937d43c 100644 --- 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 # -------- diff --git a/docs/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py b/docs/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py index 4ff1b3526f..a81bd997c8 100644 --- a/docs/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py +++ b/docs/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py @@ -1,14 +1,17 @@ """ Multi_Tool (MTD): Feature Relative by Lead (with lead groupings) -================================================================================================== +================================================================ -model_applicaitons/medium_range/ -MTD_SeriesAnalysis_fcstGFS -_obsGFS_FeatureRelative -_SeriesByLead.conf +model_applicaitons/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -17,6 +20,12 @@ # from the MET MODE Time Domain (MTD) tool. # +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.py b/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.py index 9aa9944671..6e832e8cd1 100644 --- a/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.py +++ b/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.py @@ -1,12 +1,16 @@ """ Point-Stat: Standard Verification of Global Upper Air -============================================================================= +===================================================== -model_applications/medium_range/PointStat_fcstGFS_obsGDAS -_UpperAir_MultiField -_PrepBufr.conf +model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -17,6 +21,12 @@ # space and Stat-Analysis must be used to compute the Continuous Statistics. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py b/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py index 7d3229ab89..6b82d74e97 100644 --- a/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py +++ b/docs/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py @@ -1,11 +1,16 @@ """ Point-Stat: Standard Verification for CONUS Surface -============================================================================== +=================================================== -model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc -_MultiField_PrepBufr.conf +model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -14,6 +19,12 @@ # of the prediction. Statistics are store as partial sums to save space and Stat-Analysis # must be used to compute Continuous statistics. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.py b/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.py index 0dce153a7b..ac478abb56 100644 --- a/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.py +++ b/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.py @@ -1,12 +1,15 @@ """ Multi_Tool: Feature Relative by Init -=================================================================================== +==================================== -model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS -_obsGFS_FeatureRelative -_SeriesByInit.conf +model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -21,6 +24,12 @@ # method of regional averaging cyclone observations in a fixed grid, which "smooths out" # system features and limits the meaningful metrics that can be gathered. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py b/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py index eb93987e42..816ba64c2b 100644 --- a/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py +++ b/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py @@ -1,13 +1,15 @@ """ Multi_Tool: Feature Relative by Lead (with lead groupings) -================================================================================================== +========================================================== -model_applicaitons/medium_range/ -TCStat_SeriesAnalysis_fcstGFS -_obsGFS_FeatureRelative -_SeriesByLead.conf +model_applicaitons/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -24,6 +26,12 @@ # Specifically, this use case creates bins of forecast lead times as specified by the # given ranges which provides additional insight directly into forecast lead time accuracy. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.py b/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.py index 52808805f9..eb540068f2 100644 --- a/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.py +++ b/docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.py @@ -1,13 +1,15 @@ """ Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields -======================================================================== +======================================================================= -model_applications/medium_range/ -TCStat_SeriesAnalysis_fcstGFS -_obsGFS_FeatureRelative -_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf +model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -35,6 +37,12 @@ # Additionally, the ability to calculate model statistical errors based on user provided diagnostics # allows the user to customize the feature relative analysis to suit their needs. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.py b/docs/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.py index b62d0c6990..d80a47143e 100644 --- a/docs/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.py +++ b/docs/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.py @@ -1,13 +1,17 @@ """ UserScript: Calculate the Difficulty Index -======================================================================== +========================================== -model_applications/medium_range/ -UserScript_fcstGEFS -_Difficulty_Index.conf +model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -37,6 +41,12 @@ # and more information on plotting difficulty index can be found in the `METplotpy documentation # `_. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py b/docs/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py index 16facb9de8..fe121953a1 100644 --- a/docs/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py +++ b/docs/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py @@ -5,6 +5,12 @@ model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -20,6 +26,12 @@ # script. # +############################################################################## +# Version Added +# ------------- +# +# METplus version 6.0 + ############################################################################## # Datasets # -------------------- diff --git a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py index 230881c93c..ae705d3859 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -1,10 +1,16 @@ """ Ensemble-Stat: WoFS -================================================================ +=================== model_application/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -14,6 +20,12 @@ # accumulated precipitation at different neighborhood distances and accumulation # thresholds to provide meaningful analysis output that can provide direction to future WoFS improvement. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py b/docs/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py index b6c80d64cf..07f6bcef7b 100644 --- a/docs/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py +++ b/docs/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py @@ -2,10 +2,15 @@ Gen-Ens-Prod: Basic Post-Processing only ======================================== -model_application/precipitation/GenEnsProd_fcstHRRRE -_FcstOnly_NetCDF.conf +model_application/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -14,6 +19,12 @@ # standard deviation (spread), minimum, maximum, and range fields for use in # other MET tools. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.py b/docs/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.py index 748f87270f..4429c6f35c 100644 --- a/docs/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.py +++ b/docs/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.py @@ -1,11 +1,16 @@ """ Grid-Stat: 24-hour QPF Use Case -================================================ +=============================== -model_applications/precipitation/GridStat_fcstGFS -_obsCCPA_Grib.conf +model_applications/precipitation/GridStat_fcstGFS_obsCCPA_Grib.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -14,6 +19,12 @@ # Climatology Calibrated Precipitation Analysis (CCPA) generated by a global # weather model. +############################################################################## +# Version Added +# ------------- +# +# METplus version 6.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.py b/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.py index cb7c4b384e..b90848efb2 100644 --- a/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.py +++ b/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.py @@ -1,11 +1,16 @@ """ Grid-Stat: 6hr QPF in GEMPAK format -=============================================================================== +=================================== -model_applications/precipitation/GridStat_fcstHREFmean -_obsStgIV_Gempak.conf +model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -13,7 +18,12 @@ # Evaluate the skill of a high resolution multi-model ensemble mean # at predicting 6 hour precipitation accumulation using the NCEP Stage IV # gauge corrected analysis. + +############################################################################## +# Version Added +# ------------- # +# METplus version 3.0 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.py b/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.py index 1d041be785..d8aac61a8e 100644 --- a/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.py +++ b/docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.py @@ -1,11 +1,16 @@ """ Grid-Stat: 6hr QPF in NetCDF format -============================================================================== +=================================== -model_applications/precipitation/GridStat_fcstHREFmean -_obsStgIV_Netcdf.conf +model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Netcdf.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -13,7 +18,12 @@ # Evaluate the skill of a high resolution multi-model ensemble mean # at predicting 6 hour precipitation accumulation using the NCEP Stage IV # gauge corrected analysis. + +############################################################################## +# Version Added +# ------------- # +# METplus version 3.0 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py b/docs/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py index afca6623fb..35295f31b3 100644 --- a/docs/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py +++ b/docs/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py @@ -1,11 +1,16 @@ """ Grid-Stat: 6hr PQPF Probability Verification -========================================================================== +============================================ -model_applications/precipitation/GridStat_fcstHRRR-TLE -_obsStgIV_GRIB.conf +model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -23,7 +28,12 @@ # the input files, so a set of six 1 hour accumulation fields are combined to # create a 6 hour accumulation field. The result is compared to the 6 hour # forecast data. + +############################################################################## +# Version Added +# ------------- # +# METplus version 3.0 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py b/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py index 6152f634d0..d26c2916f6 100644 --- a/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py +++ b/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py @@ -1,11 +1,16 @@ """ MTD: Build Revision Series to Evaluate Forecast Consistency -=========================================================================== +=========================================================== -model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly -_RevisionSeries_GRIB.conf +model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -18,6 +23,12 @@ # consistency either of one case or many. See other HRRR-TLE use cases # for a description of the Time Lagged Ensemble (TLE) field. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.py b/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.py index b37ecc5159..63434e3f52 100644 --- a/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.py +++ b/docs/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.py @@ -1,11 +1,16 @@ """ MTD: 6hr QPF Use Case -================================== +===================== -model_applications/precipitation/MTD_fcstHRRR-TLE -_obsMRMS.conf +model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -16,6 +21,12 @@ # aggregated over a time series. This non-traditional # approach provides alternative information and diagnostics to inform model development. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.py b/docs/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.py index f5be74211c..860b68d00f 100644 --- a/docs/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.py +++ b/docs/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.py @@ -5,6 +5,12 @@ model_application/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -15,7 +21,12 @@ # to compare three separate model outputs for a multi-precipitation type storm # across several valid times and create statistical output that can help modelers # fine-tune curent numerical models to perform better in this forecast situation. + +############################################################################## +# Version Added +# ------------- # +# METplus version 4.1 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py b/docs/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py index 07127dcb1a..20ab30ab2a 100644 --- a/docs/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py +++ b/docs/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py @@ -5,6 +5,12 @@ model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -13,6 +19,12 @@ # but is also remarkably quality controlled. # Utilizing Python embedding, this use case taps into a new vital observation dataset and compares it to a 24 hour precipitation accumulation forecast. +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 + ############################################################################## # Datasets # --------------------- diff --git a/docs/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.py b/docs/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.py index edc2c38834..03ec94aa68 100644 --- a/docs/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.py +++ b/docs/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.py @@ -1,12 +1,16 @@ """ Grid-Stat and Series-Analysis: BMKG APIK Seasonal Forecast -============================================================================= +========================================================== -model_applications/s2s/GridStat_SeriesAnalysis -_fcstNMME_obsCPC -_seasonal_forecast.conf +model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -97,6 +101,12 @@ # location, on the timing within the seasonal cycle, or even on the evolving state of the # coupled system. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py b/docs/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py index 0ea4d90f80..a2dd52a3ea 100644 --- a/docs/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py +++ b/docs/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py @@ -5,6 +5,12 @@ model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -15,9 +21,15 @@ # This use case highlights the inclusion of tercile data for calculating HSS; in particular, how to utilize the hss_ec_value option to # preset the expected values rather than relying on categorical values. +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 + ############################################################################## # Datasets -# --------------------- +# -------- # # | **Forecast:** 29 CFSv2 Ensemble files, 2m temperature fields # @@ -64,7 +76,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on the values in the METplus configuration file. These variables are referenced in the MET configuration file. **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!** If there is a setting in the MET configuration file that is not controlled by an environment variable, you can add additional environment variables to be set only within the METplus environment using the [user_env_vars] section of the METplus configuration files. See the ‘User Defined Config’ section on the ‘System Configuration’ page of the METplus User’s Guide for more information. # diff --git a/docs/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.py b/docs/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.py index 8fce83cef5..189c4244b4 100644 --- a/docs/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.py +++ b/docs/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.py @@ -5,6 +5,12 @@ model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -16,9 +22,15 @@ # how those climatologies can be used by GenEnsProd to normalize each ensemble member to its corresponding climatology, # and calculating probabilistic verfication on s2s data, which is a frequent request from climatological centers. +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 + ############################################################################## # Datasets -# --------------------- +# -------- # # | **Forecast:** 29 CFSv2 Ensemble files, 2m temperature fields # diff --git a/docs/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py b/docs/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py index 89625a4d52..da3d889692 100644 --- a/docs/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py +++ b/docs/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py @@ -1,10 +1,16 @@ """ TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) -============================================================================= +====================================================================== model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -51,6 +57,12 @@ # can also be thought of as the total number of chances that the model had to forecast a genesis event. # +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py b/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py index 855321191d..26c49ac4c4 100644 --- a/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py +++ b/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py @@ -1,12 +1,15 @@ """ UserScript: Compute Cross Spectra and Make a Plot -======================================================================== +================================================= -model_applications/ -s2s/ -UserScript_fcstS2S_obsERAI_CrossSpectra.py +model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ################################################################################# # Scientific Objective @@ -19,6 +22,12 @@ # The space time plot and cross spectra calculations were created by Maria Gehne # at the Physical Sciences Labratory in NOAA. +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.1 + ################################################################################# # Datasets # -------- diff --git a/docs/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.py b/docs/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.py index 2a9046a6ef..d9bd4f7858 100644 --- a/docs/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.py +++ b/docs/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.py @@ -1,13 +1,17 @@ """ UserScript: Make a Hovmoeller plot -======================================================================== +================================== -model_applications/ -s2s/ -UserScript_obsPrecip_obsOnly_Hovmoeller.py +model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.py """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -18,6 +22,12 @@ # The Hovmoeller plot and hovmoeller calculations where created by Maria Gehne at the # Physical Sciences Labratory in NOAA +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py b/docs/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py index ffe6a06e12..ba3f5ce819 100644 --- a/docs/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py +++ b/docs/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py @@ -2,11 +2,14 @@ UserScript: Make MaKE-MaKI plot from calculated MaKE and MaKI indices ===================================================================== -model_applications/ -s2s_mjo/ -UserScript_obsCFSR_obsOnly_MJO_ENSO.py +model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -16,6 +19,12 @@ # # * Lybarger, N.D., C.-S. Shin, and C. Stan, 2020: MJO Wind energy and prediction of El Nino, Journal of Geophysical Research - Oceans, 125, e2020JC016732. doi:10.1029/2020JC016732 +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.py b/docs/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.py index 9a07d4f8ec..73003a21f6 100644 --- a/docs/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.py +++ b/docs/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.py @@ -2,18 +2,26 @@ UserScript: Make a Phase Diagram plot from input RMM or OMI =========================================================== -model_applications/ -s2s_mjo/ -UserScript_obsERA_obsOnly_PhaseDiagram.py +model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.py """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective # -------------------- # # To produce a phase diagram using either OLR based MJO Index (OMI) or the Real-time Multivariate MJO index (RMM) -# + +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py b/docs/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py index 9b175c0e06..3d6aa362a0 100644 --- a/docs/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py +++ b/docs/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py @@ -2,11 +2,15 @@ Ensemble-Stat: Ensemble Statistics using Obs Uncertainty ======================================================== -model_applications/ -short_range/ -EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf +model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -16,6 +20,12 @@ # This example also shows how to compute simple probability fields called # ensemble relative frequency. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.py b/docs/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.py index e7e0407072..abf6423f17 100644 --- a/docs/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.py +++ b/docs/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.py @@ -2,12 +2,15 @@ Surrogate Severe Calculation: PCPCombine, GenEnsProd, and RegridDataPlane ========================================================================= -model_applications/ -short_range/ -GenEnsProd_fcstHRRR_fcstOnly -_SurrogateSevere.conf +model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ################################################################################################### # Scientific Objective # -------------------- @@ -25,7 +28,13 @@ # # For more information, please reference Sobash et al. 2011 (https://journals.ametsoc.org/doi/full/10.1175/WAF-D-10-05046.1). -################################################################################################### +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.1 + +############################################################################### # Datasets # -------- # diff --git a/docs/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.py b/docs/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.py index 27c9d36225..4777555ae1 100644 --- a/docs/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.py +++ b/docs/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.py @@ -1,12 +1,16 @@ """ Grid-Stat: Brightness Temperature Distance Maps -========================================================================= +=============================================== -model_applications/ -short_range/ -GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf +model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -15,6 +19,12 @@ # defined by creating distance maps on the FV3 ensemble members compared to GOES # channel 13 brightness temperature satellite data. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.py b/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.py index 7774241dd6..3ada074574 100644 --- a/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.py +++ b/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.py @@ -2,12 +2,14 @@ Grid-Stat: Surrogate Severe and Practically Perfect Evaluation ============================================================== -model_applications/ -short_range/ -GridStat_fcstHRRR_obsPracPerfect -_SurrogateSevere.conf +model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -16,6 +18,12 @@ # To evaluate the surrogate severe forecasts at predicting Severe weather # using the (12Z - 12Z) practically perfect storm reports. +############################################################################## +# Version Added +# ------------- +# +# METplus version 6.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.py b/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.py index 7a2a3546d4..9c0797589a 100644 --- a/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.py +++ b/docs/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.py @@ -2,12 +2,14 @@ Grid-Stat: Surrogate Severe and Practically Perfect Probabilistic Evaluation ============================================================================ -model_applications/ -short_range/ -GridStat_fcstHRRR_obsPracPerfect -_SurrogateSevereProb.conf +model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -17,6 +19,12 @@ # using the (12Z - 12Z) practically perfect storm reports an obtain # probabilistic output statistics. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.py b/docs/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.py index 8fe6985d95..e04bd25933 100644 --- a/docs/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.py +++ b/docs/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.py @@ -2,11 +2,15 @@ METdbLoad: Brightness Temperature ================================= -model_applications/ -short_range/ -METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf +model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -15,6 +19,12 @@ # dtcenter/METdataio. Specifically, this use case loads distance map output # from grid_stat and mode output into a database. +############################################################################## +# Version Added +# ------------- +# +# METplus version 6.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py b/docs/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py index b7f6c8bb42..d16970c04e 100644 --- a/docs/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py +++ b/docs/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py @@ -1,12 +1,16 @@ """ MODE: Multivariate -========================================================================= +================== -model_applications/ -short_range/ -MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf +model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -28,6 +32,12 @@ # no requested intesities, the parameters MODE_FCST/OBS_MULTIVAR_NAME and/or # MODE_FCST/OBS_MULTIVAR_LEVEL may be used as identifiers for the super-object. +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.py b/docs/use_cases/model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.py index 77209d9cfe..dcb4c2f091 100644 --- a/docs/use_cases/model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.py +++ b/docs/use_cases/model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.py @@ -2,9 +2,7 @@ MODEMultivar: Create objects of brightness temps and radar reflectivity ======================================================================= -model_applications/ -short_range/ -MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.conf +model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.conf """ ############################################################################## diff --git a/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.py b/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.py index 712d14ab4e..d5aa9d0a7f 100644 --- a/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.py +++ b/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.py @@ -1,12 +1,16 @@ """ MODE: Brightness Temperature Verification -========================================================================= +========================================= -model_applications/ -short_range/ -MODE_fcstFV3_obsGOES_BrightnessTemp.conf +model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -20,7 +24,12 @@ # # * Forecast dataset: FV3 Model member data # * Observation dataset: GOES Brightness Temperature + +############################################################################## +# Version Added +# ------------- # +# METplus version 4.0 ############################################################################## # METplus Components diff --git a/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.py b/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.py index 3fbf634497..1f09749490 100644 --- a/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.py +++ b/docs/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.py @@ -1,12 +1,16 @@ """ MODE/Grid-Stat: Brightness Temperature Verification and Distance Maps -========================================================================= +===================================================================== -model_applications/ -short_range/ -MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf +model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -16,6 +20,12 @@ # In addition, distance map information is computed for both the model and observation # using object based brightness temperatures +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py b/docs/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py index 374e84056a..8d2141a524 100644 --- a/docs/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py +++ b/docs/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py @@ -1,12 +1,16 @@ """ MODE: Hail Verification -========================================================================= +======================= -model_applications/ -short_range/ -MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf +model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -19,6 +23,12 @@ # to-one with observed sizes but can only be used to group storms into general # categories. Running MODE allows a user to do this. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py b/docs/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py index e35cb345b5..f16f62027b 100644 --- a/docs/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py +++ b/docs/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py @@ -1,19 +1,28 @@ """ Point2Grid: Calculate Practically Perfect Probabilities -============================================================ +======================================================= -model_applications/ -short_range/ -Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf +model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- # # To use storm reports as observations to calculate # Practically Perfect probabilities. + +############################################################################## +# Version Added +# ------------- # +# METplus version 3.1 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py b/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py index f50b4bd514..d54b65d845 100644 --- a/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py +++ b/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py @@ -2,11 +2,14 @@ UserScript: Physics Tendency Planview Plot ========================================== -model_applications/ -short_range/ -UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf +model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -30,6 +33,12 @@ # /home/username/working/METplus, then clone the METplotpy source # code into the /home/username/working directory). +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py b/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py index dce157d7bf..c63347862f 100644 --- a/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py +++ b/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py @@ -1,10 +1,15 @@ """ UserScript: Physics Tendency Vertical Cross Section plot -========================================================================= +======================================================== model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -27,6 +32,11 @@ # /home/username/working/METplus, then clone the METplotpy source # code into the /home/username/working directory). +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py b/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py index 16629cf3b5..b7e9819335 100644 --- a/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py +++ b/docs/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py @@ -1,10 +1,15 @@ """ UserScript: Physics Tendency Vertical Profile plot -========================================================================= +================================================== model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ############################################################################## # Scientific Objective @@ -27,7 +32,11 @@ # /home/username/working/METplus, then clone the METplotpy source # code into the /home/username/working directory). - +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.0 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py b/docs/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py index c48e6c6cec..a1018a4d09 100755 --- a/docs/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py +++ b/docs/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py @@ -1,12 +1,15 @@ -""" + """ UserScript: Reformat MET .stat ECNT data, calculate aggregation statistics, and generate a spread skill plot -====================================================================================================================== +============================================================================================================ -model_applications/ -short_range/ -UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py +model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ################################################################################# # Scientific Objective @@ -17,7 +20,12 @@ # and METplotpy). The METdataio METreformat module extracts the ECNT linetype data and # performs reformatting, the METcalcpy agg-stat module performs aggregation, and the # METplotpy line plot is used to generate the spread skill plot. + +############################################################################## +# Version Added +# ------------- # +# METplus version 6.0 ################################################################################# # Datasets @@ -40,7 +48,6 @@ # **This tarball should be unpacked into the directory corresponding to the value of INPUT_BASE** in the # `User Configuration File `_ # section. -# ############################################################################# # External Dependencies diff --git a/docs/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.py b/docs/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.py index 7090ccca1c..27c1be883b 100644 --- a/docs/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.py +++ b/docs/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.py @@ -2,10 +2,15 @@ GenVxMask: Solar Altitude ========================= -model_applications/space_weather/GenVxMask_fcstGloTEC_solar -_altitude.conf +model_applications/space_weather/GenVxMask_fcstGloTEC_solar_altitude.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Overview # -------- @@ -33,7 +38,6 @@ # maximum of 90 degrees (directly overhead) at noon at latitudes near the equator. # [Source: https://sciencing.com/solar-altitude-23364.html] - ############################################################################## # Scientific Objective # -------------------- @@ -42,6 +46,11 @@ # This use case applies a solar altitude mask (solar altitude restriction) to the # input grid, creating a separate masked output file for each time level of the input file. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.1 ############################################################################## # Datasets diff --git a/docs/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.py b/docs/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.py index 14a0cd0b5d..c9bce17227 100644 --- a/docs/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.py +++ b/docs/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.py @@ -1,11 +1,16 @@ """ Grid-Stat: Analysis validation -============================================================================== +============================== -GridStat_fcstGloTEC -_obsGloTEC_vx7.conf +GridStat_fcstGloTEC_obsGloTEC_vx7.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Overview # -------- @@ -27,6 +32,12 @@ # * Example of using masks covering latitudinal bands of interest to the space weather community: equatorial region, mid-latitude region, and polar region # * Example of masking using the values of a quality flag which vary at each time step and grid point +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Scientific Objective # -------------------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.py b/docs/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.py index 22edf8e333..548f43f168 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.py @@ -5,6 +5,12 @@ model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ########################################### # Scientific Objective # -------------------- @@ -14,6 +20,12 @@ # paired up by TCPairs, and global storm tracks # for the valid date of interest will be plotted by CyclonePlotter (PlateCaree projection) +############################################################################## +# Version Added +# ------------- +# +# METplus version 5.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.py b/docs/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.py index 3a19f8abd0..ffe70b5c8a 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.py @@ -1,11 +1,16 @@ """ Grid-Stat: Verification of TC forecasts against merged TDR data -============================================================================== +=============================================================== -model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR -_NetCDF.conf +model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -15,6 +20,12 @@ # available every 0.5 km AGL. So, the TC forecasts need to be in height coordinates # to compare with the TDR data. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.py b/docs/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.py index a0fbb57a1d..6e287843b1 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.py @@ -1,10 +1,16 @@ """ Cyclone Plotter: From TC-Pairs Output -=========================================================================== +===================================== + +model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf -model_applications/tc_and_extra_tc/Plotter_fcstGFS -_obsGFS_ExtraTC.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -12,6 +18,12 @@ # The date and hour associated with each storm track indicates the first time # the storm was tracked in the model. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.py b/docs/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.py index d66e08cb21..6d1a1a41af 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.py @@ -5,6 +5,12 @@ model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -14,6 +20,12 @@ # file and shape file formats. TC-Gen will output deterministic and probabilistic categorical counts and statistics and genesis matched pairs, which is a specific # line type for TC-Gen. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.py b/docs/use_cases/model_applications/tc_and_extra_tc/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.py index f60d401898..a446986a1c 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.py @@ -5,6 +5,12 @@ model_applications/tc_and_extra_tc/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ########################################### # Scientific Objective # -------------------- @@ -14,6 +20,12 @@ # errors, as well as wind, sea level pressure, and distance to land values for # each input dataset. Then TC-stat will filter TC-pairs output based on user criteria. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.py b/docs/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.py index ccad94908b..b0a48525bf 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.py @@ -2,16 +2,27 @@ TCRMW: Hurricane Gonzalo ======================== -model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly -_gonzolo.conf +model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- # # The TC-RMW tool regrids tropical cyclone model data onto a moving range-azimuth grid centered on points along the storm track. This capability replicates the NOAA Hurricane Research Division DIA-Post module. +############################################################################## +# Version Added +# ------------- +# +# METplus version 3.1 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py b/docs/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py index 8b24b5a671..8872623f89 100644 --- a/docs/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py +++ b/docs/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py @@ -1,11 +1,16 @@ """ Point-Stat: Standard Verification for CONUS Surface -============================================================================== +=================================================== -model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD -_NetCDF.conf +model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none + ############################################################################## # Scientific Objective # -------------------- @@ -14,6 +19,12 @@ # of the prediction. Statistics are store as partial sums to save space and Stat-Analysis # must be used to compute Continuous statistics. +############################################################################## +# Version Added +# ------------- +# +# METplus version 4.0 + ############################################################################## # Datasets # -------- diff --git a/docs/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py b/docs/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py index b56d112988..a832fb3469 100644 --- a/docs/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py +++ b/docs/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py @@ -5,6 +5,11 @@ model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf """ +############################################################################## +# .. contents:: +# :depth: 1 +# :local: +# :backlinks: none ########################################### # Scientific Objective @@ -31,7 +36,12 @@ # for this use case thins the observation data in order to reduce the run time. # It is also noted that the observations for this use case were fabricated and # correlated observation-forecast pairs are not expected. + +############################################################################## +# Version Added +# ------------- # +# METplus version 5.0 ############################################################################## # Datasets