short_range/UserScript files

dtcenter · Dec 9, 2024 · 74008be · 74008be
1 parent 461c2c5
commit 74008be
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 58 deletions.
diff --git a/...es/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py b/...es/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py
@@ -43,21 +43,27 @@
 # Datasets
 # --------
 #
-#  * Forecast dataset: FV3 3-D history file with physics and dynamics tendencies
-#  * Grid specification: FV3 2-D grid specification file with latitude and longitude of each grid point
-#
-#  **Location:** All the input data required for this use case can be
-#  found in the met_test sample data tarball. Click here to access the METplus
-#  releases page and download sample data for the appropriate release:
-#  https://github.com/dtcenter/METplus/releases
-#  The tarball should be unpacked into the directory that you will set
-#  the value of INPUT_BASE. See the "Running METplus" section below for more
-#  information.
-
+# **Forecast:** FV3 3-D history file with physics and dynamics tendencies.
+#
+# **Observation:** 
+#
+# **Climatology:**
+#
+# **Location:** All of the input data required for this use case can be 
+# found in a sample data tarball. Each use case category will have 
+# one or more sample data tarballs. It is only necessary to download 
+# the tarball with the use case’s dataset and not the entire collection 
+# of sample data. Click here to access the METplus releases page and download sample data 
+# for the appropriate release: https://github.com/dtcenter/METplus/releases
+# This tarball should be unpacked into the directory that you will 
+# set the value of INPUT_BASE. See :ref:`running-metplus` section for more information.
+#
+# **Grid specification:** FV3 2-D grid specification file with latitude and longitude of each grid point.
 
 ##############################################################################
 # External Dependencies 
 # ---------------------
+#
 # You will need to use a compatible version of Python (for this METplus
 # version) that has the following packages
 # installed:
@@ -70,8 +76,6 @@
 #  * shapely
 #  * xarray
 
-
-
 ##############################################################################
 # METplus Components
 # ------------------
@@ -82,7 +86,9 @@
 ##############################################################################
 # METplus Workflow
 # ----------------
-# 
+#
+# **Beginning time (VALID_BEG):** 2019
+#
 # This use case does not loop but plots physics tendency data that has been
 # subsetted to one date: 2019-06-15.
 

diff --git a/...lications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py b/...lications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py
@@ -42,14 +42,22 @@
 # Datasets
 # --------
 #
-# | Forecast dataset: FV3 3-D history file with physics and dynamics tendencies
-# | Grid specification: FV3 2-D grid specification file with latitude and longitude of each grid point
+# **Forecast:** FV3 3-D history file with physics and dynamics tendencies
 #
-# | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases
-# | The tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
+# **Observation:** 
 #
-
-
+# **Climatology:** 
+#
+# **Location:** All of the input data required for this use case can be 
+# found in a sample data tarball. Each use case category will have 
+# one or more sample data tarballs. It is only necessary to download 
+# the tarball with the use case’s dataset and not the entire collection 
+# of sample data. Click here to access the METplus releases page and download sample data 
+# for the appropriate release: https://github.com/dtcenter/METplus/releases
+# This tarball should be unpacked into the directory that you will 
+# set the value of INPUT_BASE. See :ref:`running-metplus` section for more information.
+#
+# **Grid specification:** FV3 2-D grid specification file with latitude and longitude of each grid point
 
 ##############################################################################
 # External Dependencies 
@@ -64,25 +72,21 @@
 #  * pandas
 #  * shapely
 #  * xarray
-#
-
-
 
 ##############################################################################
 # METplus Components
 # ------------------
 #
 # This use case runs the METplotpy cross_section_vert.py script to generate the plan views.
-#
 
 ##############################################################################
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 2019
+#
 # This use case does not loop but plots physics tendency data that has been
 # subsetted to one date: 2019-06-15.
-# 
-
 
 ##############################################################################
 # METplus Configuration

diff --git a/...l_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py b/...l_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py
@@ -42,8 +42,10 @@
 # Datasets
 # --------
 #
-#  * Forecast dataset: FV3 3-D history file with physics and dynamics tendencies
-#  * Grid specification: FV3 2-D grid specification file with latitude and longitude of each grid point
+# **Forecast:** FV3 3-D history file with physics and dynamics tendencies
+#
+# **Grid specification:** FV3 2-D grid specification file with latitude and longitude of each grid point
+#
 #  * Mid-CONUS Shapefiles: 
 #
 #    * MID_CONUS.cpg
@@ -53,11 +55,18 @@
 #    * MID_CONUS.shp
 #    * MID_CONUS.shx
 #
-# | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases
-# | The tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
+# **Observation:** 
 #
-
-
+# **Climatology:** 
+#
+# **Location:** All of the input data required for this use case can be 
+# found in a sample data tarball. Each use case category will have 
+# one or more sample data tarballs. It is only necessary to download 
+# the tarball with the use case’s dataset and not the entire collection 
+# of sample data. Click here to access the METplus releases page and download sample data 
+# for the appropriate release: https://github.com/dtcenter/METplus/releases
+# This tarball should be unpacked into the directory that you will 
+# set the value of INPUT_BASE. See :ref:`running-metplus` section for more information.
 
 ##############################################################################
 # External Dependencies 
@@ -72,26 +81,21 @@
 #  * pandas
 #  * shapely
 #  * xarray
-#
-
-
 
 ##############################################################################
 # METplus Components
 # ------------------
 #
 # This use case runs the METplotpy vert_profile_fv3.py script to generate the vertical profile plot.
-#
 
 ##############################################################################
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 2019
 #
-# | This use case does not loop but plots physics tendency data that has been
-# | subsetted to one date: 2019-06-15.
-# |
-
+# This use case does not loop but plots physics tendency data that has been
+# subsetted to one date: 2019-06-15.
 
 ##############################################################################
 # METplus Configuration

diff --git a/...ons/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py b/...ons/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py
@@ -31,27 +31,29 @@
 # Datasets
 # --------
 #
-#  * Forecast dataset: RRFS GEFS (Rapid Refresh Forecast System Global Ensemble Forecast System)
-#  * Observation dataset: None
+# **Forecast:** RRFS GEFS (Rapid Refresh Forecast System Global Ensemble Forecast System)
 #
-#  **Input**: MET .stat files from MET ensemble-stat tool for RRFS for 20220506
+# **Observation:** None
 #
-#  **Location**: All the input data required for this use case can be found in the met_test sample data tarball
-#  (**sample_data-short_range.tgz**).
+# **Input**: MET .stat files from MET ensemble-stat tool for RRFS for 20220506
 #
-#  Click here to see the METplus releases page and download sample data for the appropriate
-#  release: https://github.com/dtcenter/METplus/releases
+# **Location**: All the input data required for this use case can be found in the met_test sample data tarball
+# (**sample_data-short_range.tgz**).
 #
-#  See `Running METplus <https://metplus.readthedocs.io/en/develop/Users_Guide/getting_started.html#running-metplus>`_
-#  section for more information.
+# Click here to see the METplus releases page and download sample data for the appropriate
+# release: https://github.com/dtcenter/METplus/releases
 #
-#  **This tarball should be unpacked into the directory corresponding to the value of INPUT_BASE** in the
-#  `User Configuration File <https://metplus.readthedocs.io/en/develop/Users_Guide/systemconfiguration.html#user-configuration-file>`_
-#  section.
+# See `Running METplus <https://metplus.readthedocs.io/en/develop/Users_Guide/getting_started.html#running-metplus>`_
+# section for more information.
+#
+# **This tarball should be unpacked into the directory corresponding to the value of INPUT_BASE** in the
+# `User Configuration File <https://metplus.readthedocs.io/en/develop/Users_Guide/systemconfiguration.html#user-configuration-file>`_
+# section.
 
 #############################################################################
 # External Dependencies
 # ---------------------
+#
 # You will need to use the version of Python that is required for the METplus version
 # in use.  Refer to the Installation section of the User's Guide for basic Python requirements:
 # https://metplus.readthedocs.io/en/latest/Users_Guide/installation.html
@@ -74,8 +76,6 @@
 #  * plotly
 #  * matplotlib
 
-
-
 ##############################################################################
 # METplus Components
 # ------------------
@@ -103,20 +103,18 @@
 # Define the OUTPUT_BASE, INPUT_BASE, and MET_INSTALL_DIR settings in the user
 # configuration file. For instructions on how to set up the user configuration file, refer to the `User ConfigurationFile
 # <https://metplus.readthedocs.io/en/develop/Users_Guide/systemconfiguration.html#user-configuration-file>`_ section.
-#
-
 
 ##############################################################################
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20220506_000000
+#
 # This use case reads in the MET .stat output that contains the ECNT linetype (from
 # the MET ensemble-stat tool).  The .stat output *MUST* reside under one directory.
 # If .stat files are spread among multiple directories, these must be consolidated under a
 # single directory.
 # The use case loops over three processes: reformatting, aggregating, and plotting.
-#
-
 
 ##############################################################################
 # METplus Configuration