From ca6ecd799a51cf60852eff0ae3888f2a75b11783 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 14 Nov 2024 16:17:11 -0700 Subject: [PATCH 01/51] marine_and_cryosphere directories --- .../GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py | 31 ++++--------------- ...idStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py | 31 ++++--------------- ...ridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 26 +++------------- .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 31 ++++--------------- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 27 +++------------- .../GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py | 27 +++------------- .../PlotDataPlane_obsHYCOM_coordTripolar.py | 27 +++------------- ...intStat_fcstGFS_obsASCAT_satelliteWinds.py | 1 - ...at_fcstGFS_obsJASON3_satelliteAltimetry.py | 5 ++- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 31 ++++--------------- ...tStat_fcstRTOFS_obsARGO_climoWOA23_temp.py | 2 +- ...rScript_fcstRTOFS_obsAOML_calcTransport.py | 31 +++++-------------- 12 files changed, 50 insertions(+), 220 deletions(-) diff --git a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py index b01f741b64..bcc42c1ebf 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py @@ -1,6 +1,6 @@ """ Grid-Stat and MODE: Sea Ice Validation -==================================================================================================== +====================================== model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS _obsNCEP_sea_ice.conf @@ -99,31 +99,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - PAth to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE** All of these items must be found under the [dir] section. +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: +# +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. #################################################################################################### # Expected Output diff --git a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py index 808040c6d8..d77aac2fe2 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py @@ -71,8 +71,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf @@ -110,31 +110,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 4911eaea6d..0f4c8510a9 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 @@ -121,30 +121,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 90c0c7932e..5f2d2bb42b 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 @@ -81,8 +81,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf @@ -120,31 +120,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstRTOFS_obsOSTIA_iceCover.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstRTOFS_obsOSTIA_iceCover.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 1533bc0446..57105b826d 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 @@ -122,31 +122,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 990676e1f1..5b60bef8e2 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 @@ -122,31 +122,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 c4270bf3ab..ba70086a1b 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 @@ -108,31 +108,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in PlotDataPlane_obsHYCOM_coordTripolar.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in PlotDataPlane_obsHYCOM_coordTripolar.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d69ddc2051..66416135f8 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 @@ -109,7 +109,6 @@ # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. -# ############################################################################## # Expected Output 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 993daea910..4b64b4bec4 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 @@ -63,8 +63,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf @@ -109,7 +109,6 @@ # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. -# ############################################################################## # Expected Output 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 b9ab4d09ef..bec23327e0 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 @@ -61,8 +61,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf @@ -91,31 +91,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in PointStat_fcstGFS_obsNDBC_WaveHeight.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in PointStat_fcstGFS_obsNDBC_WaveHeight.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 5365334185..6a495a6d8c 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 @@ -75,7 +75,7 @@ # METplus Configuration # --------------------- # -# METplus first loads all of the default configuration files found in parm/metplus_config, then it loads any configuration files passed to METplus via the command line with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf +# METplus first loads all of the default configuration files found in parm/metplus_config, then it loads any configuration files passed to METplus via the command line, i.e. parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf 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 f71426327c..2b257addbe 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 @@ -1,6 +1,6 @@ """ UserScript: Python Script to compute cable transport -======================================================= +==================================================== model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf @@ -85,8 +85,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf @@ -115,29 +115,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_fcstRTOFS_obsAOML_calcTransport.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstRTOFS_obsAOML_calcTransport.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. # ############################################################################## From e4c23930e5c6e80108529f254bc17bf6c50d8bb9 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 14 Nov 2024 16:51:31 -0700 Subject: [PATCH 02/51] fixing underlining --- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4b64b4bec4..d944a73e47 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 @@ -71,7 +71,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. From 644fde740a08367d7fa9feeaf7273826edacc543 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 15 Nov 2024 09:10:56 -0700 Subject: [PATCH 03/51] trying to fix warning msg. --- ...PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) 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 d944a73e47..b602e09ad6 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 @@ -36,7 +36,8 @@ # # | **Observations:** JASON-3 satellite data # -# | **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 +# | **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 # | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information. ############################################################################## @@ -44,7 +45,6 @@ # ------------------ # # This use case calls Python Embedding during PointStat, which is the only tool used. -# ############################################################################## # METplus Workflow @@ -98,7 +98,6 @@ # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py - ############################################################################## # Running METplus # --------------- @@ -120,10 +119,10 @@ # # Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. # Output for this use case will be found in model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry (relative to **OUTPUT_BASE**) -# and will contain the following files: +# and will contain the following files:: # -# * point_stat_swh_120000L_20240102_120000V.stat -# * point_stat_wind_120000L_20240102_120000V.stat +# * point_stat_swh_120000L_20240102_120000V.stat +# * point_stat_wind_120000L_20240102_120000V.stat ############################################################################## # Keywords @@ -141,4 +140,3 @@ # # # sphinx_gallery_thumbnail_path = '_static/marine_and_cryosphere-PointStat_fcstGFS_obsJASON3_satelliteAltimetry.png' - From 2a207bf44b7907e1bb66617cc3d0848badb940c3 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 15 Nov 2024 09:20:57 -0700 Subject: [PATCH 04/51] trying to fix warning msg. again --- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 2 -- 1 file changed, 2 deletions(-) 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 b602e09ad6..2cd77ae453 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,7 +5,6 @@ model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf """ - ############################################################################## # .. contents:: # :depth: 1 @@ -56,7 +55,6 @@ # The use case processes the following run time: # # | **Valid:** 2024-01-02 12Z 12hr lead -# | ############################################################################## # METplus Configuration From 0301884ea6b220dec9ca22ce3ea374d387f0285d Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Fri, 15 Nov 2024 10:01:49 -0700 Subject: [PATCH 05/51] Removing space before i.e. --- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 2cd77ae453..3d5e115901 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 @@ -62,7 +62,7 @@ # # METplus first loads all of the configuration files found in parm/metplus_config, # then it loads any configuration files passed to METplus via the command line, -# i.e. parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.conf From d32187458a44c484f37a22ebe5751eba0c06ab95 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 15 Nov 2024 14:10:40 -0700 Subject: [PATCH 06/51] updating medium_range and pbl directories --- ...GFS_obsGFS_FeatureRelative_SeriesByLead.py | 1 + .../GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py | 30 +++------------ .../GridStat_fcstGFS_obsGFS_Sfc_MultiField.py | 31 +++------------- ...tat_fcstGFS_obsGFS_climoNCEP_MultiField.py | 37 +++++-------------- ...GFS_obsGFS_FeatureRelative_SeriesByLead.py | 30 +++------------ ...FS_obsGDAS_UpperAir_MultiField_PrepBufr.py | 30 +++------------ ..._fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py | 30 +++------------ ...GFS_obsGFS_FeatureRelative_SeriesByInit.py | 23 ++++-------- ...GFS_obsGFS_FeatureRelative_SeriesByLead.py | 22 ++++------- ...riesByLead_PyEmbed_Multiple_Diagnostics.py | 22 ++++------- .../UserScript_fcstGEFS_Difficulty_Index.py | 23 ++++-------- ...ointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py | 27 +++----------- 12 files changed, 75 insertions(+), 231 deletions(-) create mode 120000 docs/use_cases/model_applications/medium_range/.#MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py 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 new file mode 120000 index 0000000000..812fafd765 --- /dev/null +++ b/docs/use_cases/model_applications/medium_range/.#MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py @@ -0,0 +1 @@ +lisag@petrichor.93684 \ No newline at end of file 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 2f2e660d74..afb2c2ea4b 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 @@ -66,8 +66,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. -c parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf @@ -99,30 +99,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstGEFS_obsCADB_BinaryObsPOE:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 560f626c7d..d6f39c4da7 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 @@ -64,8 +64,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf @@ -91,31 +91,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 9deb21e508..789476a7bc 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 @@ -71,8 +71,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf @@ -106,31 +106,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output @@ -142,10 +123,10 @@ # # Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. # Output for this use case will be found in gather_by_date/stat_analysis/grid2grid/anom (relative to **OUTPUT_BASE**) -# and will contain the following files: +# and will contain the following files:: # -# * 00Z/GFS/GFS_20170613.stat -# * 06Z/GFS/GFS_20170613.stat +# * 00Z/GFS/GFS_20170613.stat +# * 06Z/GFS/GFS_20170613.stat ############################################################################## # Keywords 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 a81bd997c8..fd44709664 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 @@ -5,7 +5,6 @@ model_applicaitons/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf """ - ############################################################################## # .. contents:: # :depth: 1 @@ -118,36 +117,17 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf, then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf -# /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf /path/to/user_system.conf + # If the 'convert' executable is not in the user's path, specify the full # path to the executable here # # * **CONVERT = /usr/bin/convert** # -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# CONVERT = /path/to/convert -# +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 6e832e8cd1..96bf5a3984 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 @@ -62,8 +62,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf @@ -98,30 +98,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 6b82d74e97..19be4bfdda 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 @@ -65,8 +65,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf @@ -101,30 +101,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 ac478abb56..855c2f0511 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 @@ -111,8 +111,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf @@ -154,23 +154,17 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: +# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: # # * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases # * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions # * **MET_INSTALL_DIR** - Path to location where MET is installed locally # -# # and for the [exe] section, you will need to define the location of # NON-MET executables. If the executable is in the user's path, METplus will find it from # the name. If the executable is not in the path, specify the full @@ -200,9 +194,8 @@ # CONVERT = /path/to/convert # # **NOTE:** The INPUT_BASE, OUTPUT_BASE, and MET_INSTALL_DIR must be located under the [dir] section, while the RM, CUT, TR, NCAP2, CONVERT, and NCDUMP must be located under the [exe] section. - - - +# +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 816ba64c2b..6ed3872bf2 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 @@ -94,8 +94,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf @@ -137,18 +137,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf, then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf -# -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: +# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: # # * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases # * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions @@ -183,8 +177,8 @@ # CONVERT = /path/to/convert # # **NOTE:** The INPUT_BASE, OUTPUT_BASE, and MET_INSTALL_DIR must be located under the [dir] section, while the RM, CUT, TR, NCAP2, CONVERT, and NCDUMP must be located under the [exe] section. - - +# +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 eb540068f2..a4209d20de 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 @@ -159,8 +159,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_Multiple_Diagnostics.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_Multiple_Diagnostics.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf @@ -243,21 +243,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf, -# then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf /path/to/user_system.conf # -# run_metplus.py \ -# /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf \ -# /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf:: -# -# run_metplus.py \ -# /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: +# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: # # * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases # * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions @@ -278,6 +269,7 @@ # [exe] # CONVERT = /path/to/convert # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d80a47143e..989248e1c8 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 @@ -5,7 +5,6 @@ model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf """ - ############################################################################## # .. contents:: # :depth: 1 @@ -102,8 +101,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf @@ -132,21 +131,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in UserScript_fcstGEFS_Difficulty_Index.conf, -# then a user-specific system configuration file:: -# -# run_metplus.py \ -# -c /path/to/METplus/parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf \ -# -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstGEFS_Difficulty_Index.conf:: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# run_metplus.py \ -# -c /path/to/METplus/parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf /path/to/user_system.conf # -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: +# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: # # * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases # * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions @@ -172,6 +162,7 @@ # CONVERT = /path/to/convert # NCDUMP = /path/to/ncdump # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 fe121953a1..cf851dc1e5 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 @@ -69,8 +69,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf @@ -109,27 +109,12 @@ # Running METplus # --------------- # -# It is recommended to run this use case by: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# Passing in PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf -c /path/to/user_system.conf -# -# The following METplus configuration variables must be set correctly to run this example.: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output From aa8fac0a3bfc512c6aa7ee4db718cb9efe11d475 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Fri, 15 Nov 2024 14:18:39 -0700 Subject: [PATCH 07/51] deleting empty file --- ...SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py | 1 - 1 file changed, 1 deletion(-) delete mode 120000 docs/use_cases/model_applications/medium_range/.#MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py 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 deleted file mode 120000 index 812fafd765..0000000000 --- a/docs/use_cases/model_applications/medium_range/.#MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py +++ /dev/null @@ -1 +0,0 @@ -lisag@petrichor.93684 \ No newline at end of file From 47c05e5cc41b2fd77ab2392d21ad1af163f63b17 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 15 Nov 2024 14:31:46 -0700 Subject: [PATCH 08/51] removing lots of old text --- ...GFS_obsGFS_FeatureRelative_SeriesByInit.py | 36 ------------------- ...GFS_obsGFS_FeatureRelative_SeriesByLead.py | 36 ------------------- ...riesByLead_PyEmbed_Multiple_Diagnostics.py | 21 ----------- .../UserScript_fcstGEFS_Difficulty_Index.py | 26 -------------- 4 files changed, 119 deletions(-) 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 855c2f0511..01437c3fe9 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 @@ -159,42 +159,6 @@ # # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.conf /path/to/user_system.conf # -# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of -# NON-MET executables. If the executable is in the user's path, METplus will find it from -# the name. If the executable is not in the path, specify the full -# path to the executable here (i.e. CONVERT = /usr/bin/convert) The following executables are required -# for performing series analysis use cases: -# -# If the executables are in the path: -# -# * **CONVERT = convert** -# -# **NOTE:** All of these executable items must be located under the [exe] section. -# -# -# If the executables are not in the path, they need to be defined: -# -# * **CONVERT = /path/to/convert** -# -# **NOTE:** All of these executable items must be located under the [exe] section. -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# [exe] -# CONVERT = /path/to/convert -# -# **NOTE:** The INPUT_BASE, OUTPUT_BASE, and MET_INSTALL_DIR must be located under the [dir] section, while the RM, CUT, TR, NCAP2, CONVERT, and NCDUMP must be located under the [exe] section. -# # See :ref:`running-metplus` for more information. ############################################################################## 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 6ed3872bf2..094db91967 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 @@ -142,42 +142,6 @@ # # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf /path/to/user_system.conf # -# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of -# NON-MET executables. If the executable is in the user's path, METplus will find it from -# the name. If the executable is not in the path, specify the full -# path to the executable here (i.e. CONVERT = /usr/bin/convert) The following executables are required -# for performing series analysis use cases: -# -# If the executables are in the path: -# -# * **CONVERT = convert** -# -# **NOTE:** All of these executable items must be located under the [exe] section. -# -# -# If the executables are not in the path, they need to be defined: -# -# * **CONVERT = /path/to/convert** -# -# **NOTE:** All of these executable items must be located under the [exe] section. -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# [exe] -# CONVERT = /path/to/convert -# -# **NOTE:** The INPUT_BASE, OUTPUT_BASE, and MET_INSTALL_DIR must be located under the [dir] section, while the RM, CUT, TR, NCAP2, CONVERT, and NCDUMP must be located under the [exe] section. -# # See :ref:`running-metplus` for more information. ############################################################################## 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 a4209d20de..c63beae4e1 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 @@ -248,27 +248,6 @@ # # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.conf /path/to/user_system.conf # -# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of NON-MET executables. -# If the executable is in the user's path, METplus will find it from the name. -# If the executable is not in the path, specify the full path to the executable here (i.e. CONVERT = /usr/bin/convert) -# The following executables are required for performing series analysis use cases: -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# [exe] -# CONVERT = /path/to/convert -# # See :ref:`running-metplus` for more information. ############################################################################## 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 989248e1c8..6f888260fa 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 @@ -136,32 +136,6 @@ # # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.conf /path/to/user_system.conf # -# Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of NON-MET executables. -# If the executable is in the user's path, METplus will find it from the name. -# If the executable is not in the path, specify the full path to the executable here (i.e. RM = /bin/rm) -# The following executables are required for performing series analysis use cases: -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# [exe] -# RM = /path/to/rm -# CUT = /path/to/cut -# TR = /path/to/tr -# NCAP2 = /path/to/ncap2 -# CONVERT = /path/to/convert -# NCDUMP = /path/to/ncdump -# # See :ref:`running-metplus` for more information. ############################################################################## From 19a532ec4af211599e98a0d6011b2b2a536df611 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 15 Nov 2024 15:06:43 -0700 Subject: [PATCH 09/51] precipitation files --- .../EnsembleStat_fcstWOFS_obsWOFS.py | 31 ++++--------------- .../GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py | 7 +++-- .../GridStat_fcstGFS_obsCCPA_GRIB.py | 29 +++-------------- .../GridStat_fcstHREFmean_obsStgIV_Gempak.py | 31 ++++--------------- .../GridStat_fcstHREFmean_obsStgIV_NetCDF.py | 31 ++++--------------- .../GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py | 31 ++++--------------- ...stHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py | 31 ++++--------------- .../precipitation/MTD_fcstHRRR-TLE_obsMRMS.py | 31 ++++--------------- ...tat_fcstMULTI_obsMETAR_PtypeComparisons.py | 31 ++++--------------- ...ntStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py | 30 ++++-------------- 10 files changed, 57 insertions(+), 226 deletions(-) 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 ae705d3859..f83af729a4 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -63,8 +63,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf @@ -99,32 +99,13 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in EnsembleStat_fcstWOFS_obsWOFS.py then a user-specific system configuration file:: # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf -c /path/to/user_system.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf /path/to/user_system.conf # -# 2) Modifying the configurations in parm/metplus_config, then passing in EnsembleStat_fcstWOFS_obsWOFS.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. -# - +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output # --------------- 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 07f6bcef7b..daf8bcd7b0 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 @@ -108,11 +108,12 @@ # Running METplus # --------------- # -# The command to run this use case is:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf +# The command to run this use case is::# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 4429c6f35c..c94fc359ce 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 @@ -69,7 +69,7 @@ # # METplus first loads all of the configuration files found in parm/metplus_config, # then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf +# i.e. parm/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf @@ -95,31 +95,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstGFS_obsCCPA_GRIB.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstGFS_obsCCPA_GRIB:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 b90848efb2..c5a24dd318 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 @@ -87,8 +87,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf @@ -115,31 +115,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstHREFmean_obsStgIV_Gempak.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstHREFmean_obsStgIV_Gempak.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d8aac61a8e..6c79cd6122 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 @@ -67,8 +67,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf @@ -96,31 +96,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstHREFmean_obsStgIV_NetCDF.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstHREFmean_obsStgIV_NetCDF.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 35295f31b3..1629c1a3e5 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 @@ -81,8 +81,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf @@ -108,31 +108,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d26c2916f6..97c086a886 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 @@ -65,8 +65,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf @@ -92,31 +92,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 63434e3f52..3d04142b23 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 @@ -65,8 +65,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf @@ -92,31 +92,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in MTD_fcstHRRR-TLE_obsMRMS.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in MTD_fcstHRRR-TLE_obsMRMS.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/MTD_fcstHRRR-TLE_obsMRMS.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 860b68d00f..77622e23f7 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 @@ -67,8 +67,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf @@ -103,31 +103,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/PointStat_fcstMULTI_obsMETAR_PtypeComparisons.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 20ab30ab2a..d5bc586ff4 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 @@ -69,8 +69,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. -c parm/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf @@ -91,30 +91,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output From bb5d13156e1c39365d2360f8f0952676703b4866 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 18 Nov 2024 13:48:09 -0700 Subject: [PATCH 10/51] removing junk file --- ...SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py | 1 - 1 file changed, 1 deletion(-) delete mode 120000 docs/use_cases/model_applications/medium_range/.#MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py 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 deleted file mode 120000 index 812fafd765..0000000000 --- a/docs/use_cases/model_applications/medium_range/.#MTD_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py +++ /dev/null @@ -1 +0,0 @@ -lisag@petrichor.93684 \ No newline at end of file From 20c6f869a78516f2d9f9f4fc9ab533ba08d08b80 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 18 Nov 2024 14:44:01 -0700 Subject: [PATCH 11/51] removing extra # --- .../precipitation/EnsembleStat_fcstWOFS_obsWOFS.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 f83af729a4..340654a37f 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -102,8 +102,7 @@ # Pass the use case configuration file to the run_metplus.py script along # with any user-specific system configuration files if desired:: # -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf /path/to/user_system.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. ############################################################################## From a4783838721a6fa1b4e6351e5cd833109c2b48e5 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 18 Nov 2024 14:48:40 -0700 Subject: [PATCH 12/51] add return --- .../precipitation/EnsembleStat_fcstWOFS_obsWOFS.py | 1 + 1 file changed, 1 insertion(+) 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 340654a37f..7a13573224 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -105,6 +105,7 @@ # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. + ############################################################################## # Expected Output # --------------- From edea917ad8a1a519596e68f26ad0bdf386303ab5 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 18 Nov 2024 16:41:16 -0700 Subject: [PATCH 13/51] updating 3 dirs s2s, space_weather and unstructured_grids --- ...lysis_fcstNMME_obsCPC_seasonal_forecast.py | 27 ++---------- ...Stat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py | 30 +++---------- ...MS_climoStandardized_MultiStatisticTool.py | 30 +++---------- .../s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py | 24 ++--------- ...UserScript_fcstS2S_obsERAI_CrossSpectra.py | 43 +++---------------- ...UserScript_obsPrecip_obsOnly_Hovmoeller.py | 42 ++---------------- .../UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 25 ++--------- .../UserScript_obsERA_obsOnly_PhaseDiagram.py | 25 ++--------- ...Mask_fcstGloTEC_FcstOnly_solar_altitude.py | 31 +++---------- .../GridStat_fcstGloTEC_obsGloTEC_vx7.py | 31 +++---------- ...alysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py | 28 +++--------- 11 files changed, 56 insertions(+), 280 deletions(-) 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 03ec94aa68..a2728ae79e 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 @@ -226,32 +226,13 @@ ############################################################################## # Running METplus # --------------- -# This use case can be run two ways: # -# 1) Passing in GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 a2dd52a3ea..48f7956129 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 @@ -67,8 +67,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. -c parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf @@ -88,30 +88,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 189c4244b4..8446ba51fc 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 @@ -70,8 +70,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. -c parm/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf @@ -93,30 +93,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 da3d889692..6e86c40d40 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 @@ -171,29 +171,13 @@ ############################################################################## # Running METplus # --------------- -# This use case can be run two ways: # -# 1) Passing in TCGen_fcstGFSO_obsBDECKS_GDF_TDF.conf then a user-specific system configuration file:: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in TCGen_fcstGFSO_obsBDECKS_GDF_TDF.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 26c49ac4c4..3bb4026fac 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 @@ -59,8 +59,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf @@ -94,43 +94,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_fcstS2S_obsERAI_CrossSpectra.conf, -# then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstS2S_obsERAI_CrossSpectra.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of NON-MET executables. -# If the executable is in the user's path, METplus will find it from the name. -# If the executable is not in the path, specify the full path to the executable here (i.e. RM = /bin/rm) -# The following executables are required for performing series analysis use cases: -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# [exe] -# RM = /path/to/rm -# CUT = /path/to/cut -# TR = /path/to/tr -# NCAP2 = /path/to/ncap2 -# CONVERT = /path/to/convert -# NCDUMP = /path/to/ncdump +# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf -c /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d9bd4f7858..f96b84c316 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 @@ -91,46 +91,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_obsPrecip_obsOnly_Hovmoeller.conf, -# then a user-specific system configuration file:: -# -# run_metplus.py \ -# /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf \ -# /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_obsPrecip_obsOnly_Hovmoeller.conf:: -# -# run_metplus.py \ -# /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of NON-MET executables. -# If the executable is in the user's path, METplus will find it from the name. -# If the executable is not in the path, specify the full path to the executable here (i.e. RM = /bin/rm) -# The following executables are required for performing series analysis use cases: -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# [exe] -# RM = /path/to/rm -# CUT = /path/to/cut -# TR = /path/to/tr -# NCAP2 = /path/to/ncap2 -# CONVERT = /path/to/convert -# NCDUMP = /path/to/ncdump +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 ba3f5ce819..3197771a97 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 @@ -104,29 +104,12 @@ # Running METplus # --------------- # -# This use case is run in the following ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_obsCFSR_obsOnly_MJO_ENSO.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_obsCFSR_obsOnly_MJO_ENSO.py:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.conf -# -# The following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 73003a21f6..a877bd4d10 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 @@ -103,29 +103,12 @@ # Running METplus # --------------- # -# This use case is run in the following ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_obsERA_obsOnly_PhaseDiagram.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_obsERA_obsOnly_PhaseDiagram.py:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.conf -# -# The following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 27c1be883b..53e683563e 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 @@ -102,8 +102,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf @@ -119,31 +119,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in the use case config file then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in the use case config file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 c9bce17227..7e2f0266d7 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 @@ -96,8 +96,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf @@ -123,31 +123,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstGloTEC_obsGloTEC_vx7.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstGloTEC_obsGloTEC_vx7.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 a832fb3469..f151962b86 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 @@ -78,8 +78,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf @@ -117,28 +117,12 @@ # Running METplus # --------------- # -# It is recommended to run this use case by: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# Passing in StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.conf -c /path/to/user_system.conf -# -# The following METplus configuration variables must be set correctly to run this example.: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. -# - +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output From 7eab965433a3d176844a391037123f4cec161abf Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 19 Nov 2024 11:36:01 -0700 Subject: [PATCH 14/51] updating short_range files --- ...eStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py | 31 +++---------- ...sProd_fcstHRRR_fcstOnly_SurrogateSevere.py | 12 +++-- ...Stat_fcstFV3_obsGOES_BrightnessTempDmap.py | 31 +++---------- ...fcstHRRR_obsPracPerfect_SurrogateSevere.py | 30 +++---------- ...HRRR_obsPracPerfect_SurrogateSevereProb.py | 30 +++---------- ...ETdbLoad_fcstFV3_obsGoes_BrightnessTemp.py | 29 +++--------- .../MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py | 6 +-- ...S_obsGOES_MRMS_BrightnessTemp_Lightning.py | 2 +- .../MODE_fcstFV3_obsGOES_BrightnessTemp.py | 31 +++---------- ...MODE_fcstFV3_obsGOES_BrightnessTempObjs.py | 31 +++---------- .../MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py | 31 +++---------- ...2Grid_obsLSR_ObsOnly_PracticallyPerfect.py | 31 +++---------- ...stFV3_fcstOnly_PhysicsTendency_Planview.py | 35 +++------------ ...ly_PhysicsTendency_VerticalCrossSection.py | 31 +++---------- ...cstOnly_PhysicsTendency_VerticalProfile.py | 31 +++---------- ...format_Aggregate_Plot_ecnt_spread_skill.py | 44 +++---------------- 16 files changed, 89 insertions(+), 347 deletions(-) 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 3d6aa362a0..b13b013b6b 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 @@ -73,8 +73,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf @@ -100,31 +100,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 abf6423f17..851b70eafe 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 @@ -69,8 +69,9 @@ # METplus Configuration # --------------------- # -# METplus first loads all of the configurations found in parm/metplus_config. -# Then it loads any configuration files passed to METplus by the command line. +# METplus first loads all of the configuration files found in parm/metplus_config, +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf @@ -96,9 +97,12 @@ # Running METplus # --------------- # -# The command to run this use case is:: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf +# +# See :ref:`running-metplus` for more information. ################################################################################################### # Expected Output 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 4777555ae1..f6f0123fd3 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 @@ -59,8 +59,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf @@ -86,31 +86,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 3ada074574..5e7297c6a9 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 @@ -55,8 +55,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf @@ -82,30 +82,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 9c0797589a..1ddb3aa72d 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 @@ -57,8 +57,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf @@ -84,30 +84,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 e04bd25933..818112a145 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 @@ -66,7 +66,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf @@ -92,30 +93,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: -# -# 1) Passing in METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf followed by a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config and then passing in METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path to directory where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d16970c04e..120437e7cf 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 @@ -86,8 +86,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line: -# parm/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf @@ -116,7 +116,7 @@ # Pass the use case configuration file to the run_metplus.py script # along with any user-specific system configuration files if desired:: # -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf /path/to/user_system.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. 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 dcb4c2f091..19717ddafa 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 @@ -131,7 +131,7 @@ # Pass the use case configuration file to the run_metplus.py script # along with any user-specific system configuration files if desired:: # -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.conf /path/to/user_system.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODEMultivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. 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 d5aa9d0a7f..d5e768fa3a 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 @@ -58,8 +58,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf @@ -85,31 +85,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in MODE_fcstFV3_obsGOES_BrightnessTemp.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in MODE_fcstFV3_obsGOES_BrightnessTemp.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 1f09749490..abbaa1f077 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 @@ -61,8 +61,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf @@ -93,31 +93,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 8d2141a524..6a56ecab57 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 @@ -64,8 +64,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf @@ -91,31 +91,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in MODE_fcstHRRRE_obsMRMS_Hail_GRIB2.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstHRRRE_obsMRMS_Hail_GRIB2.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in MODE_fcstHRRRE_obsMRMS_Hail_GRIB2.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstHRRRE_obsMRMS_Hail_GRIB2.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstHRRRE_obsMRMS_Hail_GRIB2.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 f16f62027b..ba3c202d3f 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 @@ -64,8 +64,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf @@ -103,31 +103,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 d54b65d845..48955ce776 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 @@ -92,7 +92,7 @@ # # METplus first loads all of the configuration files found in # parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line +# then it loads any configuration files passed to METplus via the command line, # i.e. # parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf # @@ -115,37 +115,12 @@ # Running METplus # --------------- # -# This use case can be run in the following way: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf -# then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf /path/to/user_system.conf # -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in -# UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.conf -# -# The former method is recommended. Whether you add them to a user-specific -# configuration file or modify the metplus_config files, the following -# variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are -# unpacked (See Datasets section to obtain tarballs). This is not required -# to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must -# be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 c63347862f..99d76b9ebb 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 @@ -89,8 +89,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf @@ -112,31 +112,12 @@ # Running METplus # --------------- # -# This use case can be run in the following way: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 b7e9819335..950dfbf9da 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 @@ -98,8 +98,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# i.e. parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf @@ -121,31 +121,12 @@ # Running METplus # --------------- # -# This use case can be run in the following way: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf then a user-specific system configuration file:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf:: -# -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 a1018a4d09..99116bbd2a 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 @@ -123,8 +123,8 @@ # --------------------- # # METplus first loads all the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf @@ -172,44 +172,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf, -# then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# and for the [exe] section, you will need to define the location of NON-MET executables. -# If the executable is in the user's path, METplus will find it from the name. -# If the executable is not in the path, specify the full path to the executable here (i.e. RM = /bin/rm) -# The following executables are required for performing series analysis use cases: -# -# Example User Configuration File:: -# -# [config] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# -# [exe] -# RM = /path/to/rm -# CUT = /path/to/cut -# TR = /path/to/tr -# NCAP2 = /path/to/ncap2 -# CONVERT = /path/to/convert -# NCDUMP = /path/to/ncdump +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output From e78e80c1fbc0f562365fbf1326162298a81223e2 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 19 Nov 2024 12:03:13 -0700 Subject: [PATCH 15/51] adding tc_and_extra_tc files --- ...otter_fcstGFS_obsGFS_UserScript_ExtraTC.py | 27 ++++------------ .../GridStat_fcstHAFS_obsTDR_NetCDF.py | 30 ++++-------------- .../Plotter_fcstGFS_obsGFS_ExtraTC.py | 31 ++++--------------- .../TCGen_fcstGFS_obsBDECK_2021season.py | 31 ++++--------------- ...at_fcstADECK_obsBDECK_ATCF_BasicExample.py | 27 ++++------------ .../TCRMW_fcstGFS_fcstOnly_gonzalo.py | 31 ++++--------------- ...CII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py | 30 ++++-------------- 7 files changed, 42 insertions(+), 165 deletions(-) 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 548f43f168..fed48b6ba0 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 @@ -80,8 +80,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c /path/to/TCPairs_extra_tropical.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. /path/to/TCPairs_extra_tropical.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.conf @@ -124,27 +124,12 @@ # Running METplus # --------------- # -# It is recommended to run this use case by: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# Passing in TCPairs_extra_tropical.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.conf -c /path/to/user_system.conf -# -# The following METplus configuration variables must be set correctly to run this example.: -# -# * **INPUT_BASE** - Path to directory where EMC data files (csv) are read (See Datasets section to obtain tarballs). -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 ffe70b5c8a..a8c35e1d30 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 @@ -69,8 +69,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf @@ -113,30 +113,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in GridStat_fcstHAFS_obsTDR_NetCDF.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications//tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications//tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstHAFS_obsTDR_NetCDF.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 6e287843b1..f21b38571b 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 @@ -58,8 +58,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf @@ -85,31 +85,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in Plotter_fcstGFS_obsGFS_ExtraTC.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in Plotter_fcstGFS_obsGFS_ExtraTC.conf:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 6d1a1a41af..9a43046afb 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 @@ -64,8 +64,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf @@ -91,31 +91,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in the use case configuration file then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in use case configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/model_applications/tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 a446986a1c..24c992472f 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 @@ -86,8 +86,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c /path/to/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. /path/to/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf @@ -114,27 +114,12 @@ # Running METplus # --------------- # -# It is recommended to run this use case by: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# Passing in TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf -c /path/to/user_system.conf -# -# The following METplus configuration variables must be set correctly to run this example.: -# -# * **INPUT_BASE** - Path to directory where Adeck and Bdeck ATCF format files are read (See Datasets section to obtain tarballs). -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf -c /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 b0a48525bf..9c8f059250 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 @@ -58,8 +58,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf @@ -85,31 +85,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in the use case configuration file then a user-specific system configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in use case configuration file:: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# run_metplus.py /path/to/METplus/parm/model_applications/tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.conf /path/to/user_system.conf # +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output 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 8872623f89..6aa8b97984 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 @@ -61,8 +61,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf @@ -121,30 +121,12 @@ # Running METplus # --------------- # -# This use case can be run two ways: +# Pass the use case configuration file to the run_metplus.py script along +# with any user-specific system configuration files if desired:: # -# 1) Passing in UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf then a user-specific system configuration file:: +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications//tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf /path/to/user_system.conf # -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications//tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf -c /path/to/user_system.conf -# -# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf: -# -# run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.conf -# -# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly: -# -# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases -# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions -# * **MET_INSTALL_DIR** - Path to location where MET is installed locally -# -# Example User Configuration File:: -# -# [dir] -# INPUT_BASE = /path/to/sample/input/data -# OUTPUT_BASE = /path/to/output/dir -# MET_INSTALL_DIR = /path/to/met-X.Y -# -# **NOTE:** All of these items must be found under the [dir] section. +# See :ref:`running-metplus` for more information. ############################################################################## # Expected Output From 4373b74dcaf7bb1b1f5a6612560ae4da7083f77a Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 19 Nov 2024 12:12:09 -0700 Subject: [PATCH 16/51] removing defunct -c option --- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 4 ++-- .../GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py | 4 ++-- .../PlotDataPlane_obsHYCOM_coordTripolar.py | 4 ++-- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 2 +- .../TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.py | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) 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 57105b826d..c4032d6f58 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 @@ -83,8 +83,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf 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 5b60bef8e2..1095140cc3 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 @@ -83,8 +83,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf 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 ba70086a1b..22f3e8eba3 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 @@ -79,8 +79,8 @@ # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line -# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf +# then it loads any configuration files passed to METplus via the command line, +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf 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 bec23327e0..ab4d9c6133 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 @@ -62,7 +62,7 @@ # # METplus first loads all of the configuration files found in parm/metplus_config, # then it loads any configuration files passed to METplus via the command line, -# i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf +# i.e. parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf 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 24c992472f..3bfd2104a0 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 @@ -117,7 +117,7 @@ # Pass the use case configuration file to the run_metplus.py script along # with any user-specific system configuration files if desired:: # -# run_metplus.py /path/to/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf -c /path/to/user_system.conf +# run_metplus.py /path/to/TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. From 593d274688025b527a5cb33ccb011924afad5098 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 20 Nov 2024 10:24:54 -0700 Subject: [PATCH 17/51] added dropdown menus for marine_and_cryosphere --- ...idStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py | 2 +- ...ridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 19 ++++++++++++++---- .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 19 ++++++++++++++---- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 19 ++++++++++++++---- .../GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py | 20 +++++++++++++++---- .../PlotDataPlane_obsHYCOM_coordTripolar.py | 19 +++++++++++++----- ...intStat_fcstGFS_obsASCAT_satelliteWinds.py | 19 +++++++++++++++--- ...at_fcstGFS_obsJASON3_satelliteAltimetry.py | 18 +++++++++++++++-- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 19 +++++++++++++++++- ...tStat_fcstRTOFS_obsARGO_climoWOA23_temp.py | 20 ++++++++++++++++--- ...rScript_fcstRTOFS_obsAOML_calcTransport.py | 15 +++++++++----- 11 files changed, 153 insertions(+), 36 deletions(-) diff --git a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py index d4b7a0e4e7..d9c58bd3a2 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py @@ -86,7 +86,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. 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 0f4c8510a9..381fe99c80 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 @@ -90,7 +90,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -100,6 +100,8 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: GridStatConfig_wrapped +# # .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -111,11 +113,20 @@ # # This use case uses one Python script to read forecast, observation, and climatology data # -# parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/read_rtofs_ghrsst_woa.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/read_rtofs_ghrsst_woa.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/read_rtofs_ghrsst_woa.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/read_rtofs_ghrsst_woa.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 5f2d2bb42b..7f0dd4d226 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 @@ -89,7 +89,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -99,6 +99,8 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: GridStatConfig_wrapped +# # .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -110,11 +112,20 @@ # # This use case uses one Python script to read forecast and observation data # -# parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover/read_ice_data.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover/read_ice_data.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover/read_ice_data.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover/read_ice_data.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 c4032d6f58..df2ed42daf 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 @@ -91,7 +91,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -101,6 +101,8 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: GridStatConfig_wrapped +# # .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -112,11 +114,20 @@ # # This use case uses one Python script to read forecast and observation data # -# parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 1095140cc3..aa2f924918 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 @@ -91,7 +91,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -101,6 +101,8 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: GridStatConfig_wrapped +# # .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -112,11 +114,21 @@ # # This use case uses one Python script to read forecast and observation data # -# parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss/read_rtofs_smos_woa.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss/read_rtofs_smos_woa.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss/read_rtofs_smos_woa.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss/read_rtofs_smos_woa.py + +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 22f3e8eba3..b03b77e52c 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 @@ -87,7 +87,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # This tool does not use a MET configuration file. # @@ -98,11 +98,20 @@ # # This use case uses one Python script to read input data, passed through two times # -# parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar/read_tripolar_grid.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar/read_tripolar_grid.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar/read_tripolar_grid.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar/read_tripolar_grid.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus @@ -111,7 +120,7 @@ # Pass the use case configuration file to the run_metplus.py script along # with any user-specific system configuration files if desired:: # -# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf /path/to/user_system.conf +# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. 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 66416135f8..64f641ea3a 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 @@ -69,7 +69,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -79,6 +79,8 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: PointStatConfig_wrapped +# # .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -95,9 +97,20 @@ # in the code describing an alternate method that may be improved upon to allow different sattellites to have their own station IDs. # The location of the code is parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py +# .. dropdown:: +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 3d5e115901..6fb4210aaf 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 @@ -79,6 +79,8 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: PointStatConfig_wrapped +# # .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -93,8 +95,20 @@ # and where the data came from, passed as JASON (JASON-3), SARAL, or SENTINEL (Sentinel-6a). # The location of the code is parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 ab4d9c6133..3d9b1dedf3 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 @@ -69,7 +69,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -79,6 +79,11 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# +# .. dropdown:: GridStatConfig_wrappedAscii2NcConfig_wrapped +# +# .. dropdown:: PointStatConfig_wrapped +# # .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -87,6 +92,18 @@ # .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +############################################################################## +# Python Embedding +# ---------------- +# +#This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. + ############################################################################## # Running METplus # --------------- 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 6a495a6d8c..6f48cb714d 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 @@ -92,6 +92,10 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: Ascii2NcConfig_wrapped +# +# .. dropdown:: PointStatConfig_wrapped +# # .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash @@ -106,10 +110,20 @@ # # This use case uses one Python script to read observation data. # -# parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 2b257addbe..cf29974efb 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 @@ -93,11 +93,17 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # None. All of the processing is completed in the UserScript # +############################################################################## +# Python Embedding +# ---------------- +# +#This use case does not use Python embedding. + ############################################################################## # User Script # ---------------- @@ -105,11 +111,10 @@ # This use case uses one Python script to read forecast and observation data # as well as processing the desired statistics. # -# parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py -# -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py # +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py ############################################################################## # Running METplus From e51e53f46f564cd24de83d28a831157e0dfabe8f Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 20 Nov 2024 14:26:48 -0700 Subject: [PATCH 18/51] fixing problems and dropdowns for medium_range --- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 15 ++-- ...rScript_fcstRTOFS_obsAOML_calcTransport.py | 9 ++- .../GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py | 31 +++++++-- .../GridStat_fcstGFS_obsGFS_Sfc_MultiField.py | 18 ++++- ...tat_fcstGFS_obsGFS_climoNCEP_MultiField.py | 22 ++++-- ...ridStat_fcstGFS_obsOMI_TotalColumnOzone.py | 22 ++++-- ...GFS_obsGFS_FeatureRelative_SeriesByLead.py | 24 ++++--- ...FS_obsGDAS_UpperAir_MultiField_PrepBufr.py | 22 ++++-- ..._fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py | 22 ++++-- ...GFS_obsGFS_FeatureRelative_SeriesByInit.py | 32 +++++---- ...GFS_obsGFS_FeatureRelative_SeriesByLead.py | 32 +++++---- ...riesByLead_PyEmbed_Multiple_Diagnostics.py | 69 ++++++++++--------- .../UserScript_fcstGEFS_Difficulty_Index.py | 15 +++- 13 files changed, 210 insertions(+), 123 deletions(-) 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 3d9b1dedf3..8e3186c33e 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 @@ -79,24 +79,21 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# # .. dropdown:: GridStatConfig_wrappedAscii2NcConfig_wrapped # -# .. dropdown:: PointStatConfig_wrapped -# -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped +# .. dropdown:: PointStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## # Python Embedding # ---------------- # -#This use case does not use Python embedding. +# This use case does not use Python embedding. ############################################################################## # User Scripting 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 cf29974efb..5b4dceda5a 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 @@ -95,18 +95,17 @@ # MET Configuration # ----------------- # -# None. All of the processing is completed in the UserScript -# +# None. All of the processing is completed in the UserScript. ############################################################################## # Python Embedding # ---------------- # -#This use case does not use Python embedding. +# This use case does not use Python embedding. ############################################################################## -# User Script -# ---------------- +# User Scripting +# -------------- # # This use case uses one Python script to read forecast and observation data # as well as processing the desired statistics. 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 afb2c2ea4b..c1cb4d204f 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 @@ -77,24 +77,41 @@ # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: GridStatConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding # ---------------- # # This use case calls a Python script to parse the user-requested percentile from the forecast dataset. -# This is controlled in the forecast VAR1 variable setting and is provided in -# parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE/Tmax_fcst_embedded.py +# This is controlled in the forecast VAR1 variable setting and is provided in the below file. +# +# .. dropdown:: parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE/Tmax_fcst_embedded.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE/Tmax_fcst_embedded.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE/Tmax_fcst_embedded.py # +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on `Python embedding `_ +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. +# ############################################################################## # Running METplus # --------------- 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 d6f39c4da7..abcc536417 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 @@ -82,10 +82,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 789476a7bc..ae07a0b4b1 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 @@ -89,18 +89,26 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **GridStatConfig_wrapped** +# .. dropdown:: GridStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. dropdown:: StatAnalysisConfig_wrapped # -# **StatAnalysisConfig_wrapped** +# .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 798937d43c..e408af43ca 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 @@ -80,22 +80,30 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding # ---------------- # -# This use case uses one Python embedding script with GridStat to read the input observation data +# This use case uses one Python embedding script with GridStat to read the input observation data. +# +# .. dropdown:: parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone/read_omi-aura_l3-omto3e.py # -# parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone/read_omi-aura_l3-omto3e.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone/read_omi-aura_l3-omto3e.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone/read_omi-aura_l3-omto3e.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on `Python embedding `_ +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 fd44709664..d9c7a18f7a 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 @@ -99,19 +99,27 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **MTDConfig_wrapped** +# .. dropdown:: MTDConfig_wrapped # -# .. note:: See the :ref:`MTD MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped +# .. dropdown:: SeriesAnalysisConfig_wrapped # -# **SeriesAnalysisConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`SeriesAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 96bf5a3984..9d88a64daf 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 @@ -81,18 +81,26 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **PB2NCConfig_wrapped** +# .. dropdown:: PB2NCConfig_wrapped # -# .. note:: See the :ref:`PB2NC MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped +# .. dropdown:: PointStatConfig_wrapped** # -# **PointStatConfig_wrapped** +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 19be4bfdda..3559de6a73 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 @@ -84,18 +84,26 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **PB2NCConfig_wrapped** +# .. dropdown:: PB2NCConfig_wrapped # -# .. note:: See the :ref:`PB2NC MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped +# .. dropdown:: PointStatConfig_wrapped # -# **PointStatConfig_wrapped** +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 01437c3fe9..1f8cb4f626 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 @@ -129,26 +129,32 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **TCPairsConfig_wrapped** +# .. dropdown:: TCPairsConfig_wrapped # -# .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped -# -# **TCStatConfig_wrapped** +# .. dropdown:: TCStatConfig_wrapped # -# .. note:: See the :ref:`TCStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped +# .. dropdown:: SeriesAnalysisConfig_wrapped # -# **SeriesAnalysisConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`SeriesAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 094db91967..fa918e10f7 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 @@ -112,26 +112,32 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **TCPairsConfig_wrapped** +# .. dropdown:: TCPairsConfig_wrapped # -# .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped -# -# **TCStatConfig_wrapped** +# .. dropdown:: TCStatConfig_wrapped # -# .. note:: See the :ref:`TCStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped +# .. dropdown:: SeriesAnalysisConfig_wrapped # -# **SeriesAnalysisConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`SeriesAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 c63beae4e1..41ab664a02 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 @@ -178,26 +178,20 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **TCPairsConfig_wrapped** +# .. dropdown:: TCPairsConfig_wrapped # -# .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped -# -# **TCStatConfig_wrapped** -# -# .. note:: See the :ref:`TCStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped +# .. dropdown:: TCStatConfig_wrapped # -# **SeriesAnalysisConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # -# .. note:: See the :ref:`SeriesAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## # Python Embedding @@ -206,38 +200,45 @@ # This use case uses four Python embedding scripts to read input data, two for the forecast data and two for the analysis data. # The multiple datatype input requires the two-script approach. # -# parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_fcst.py -# -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_fcst.py +# .. dropdown:: parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_fcst.py # -# parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_fcst.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_fcst.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_fcst.py +# .. dropdown:: parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_fcst.py # -# parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_fcst.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_fcst.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_fcst.py +# .. dropdown:: parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_fcst.py # +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_fcst.py # +# .. dropdown:: parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_analysis.py # -# parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_analysis.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_analysis.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_ivt_analysis.py +# .. dropdown:: parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_analysis.py # -# parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_analysis.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_analysis.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_pv_analysis.py +# .. dropdown:: parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_analysis.py # -# parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_analysis.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_analysis.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics/gfs_sept_analysis.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 6f888260fa..8c159a1f8f 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 @@ -121,11 +121,20 @@ # # This use case uses a Python embedding script to read input data # -# parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index/wind_difficulty_index.py +# .. dropdown:: parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index/wind_difficulty_index.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index/wind_difficulty_index.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index/wind_difficulty_index.py # +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus From b774e98c84e7eff0e8790366ee29c5924e440de5 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 20 Nov 2024 14:33:15 -0700 Subject: [PATCH 19/51] fixing new problems --- .../medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 c1cb4d204f..a6724ae48a 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 @@ -30,7 +30,7 @@ ############################################################################## # Datasets -# --------------------- +# -------- # # | **Forecast:** 85th percentile of Temperature maximum, from GEFS # @@ -75,7 +75,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus # configuration file. See :ref:`How METplus controls MET config file settings` for more details. @@ -111,7 +111,7 @@ # -------------- # # User Scripting is not used in this use case. -# + ############################################################################## # Running METplus # --------------- From b96ea0443336b384b0a396eacb3811362807be8d Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 20 Nov 2024 15:42:46 -0700 Subject: [PATCH 20/51] dropdowns for pbl and precip --- ...ointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py | 29 +++++++++----- .../EnsembleStat_fcstWOFS_obsWOFS.py | 29 +++++++++----- .../GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py | 20 ++++++++-- .../GridStat_fcstGFS_obsCCPA_GRIB.py | 18 +++++++-- .../GridStat_fcstHREFmean_obsStgIV_Gempak.py | 18 +++++++-- .../GridStat_fcstHREFmean_obsStgIV_NetCDF.py | 18 +++++++-- .../GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py | 18 +++++++-- ...stHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py | 20 ++++++++-- .../precipitation/MTD_fcstHRRR-TLE_obsMRMS.py | 20 ++++++++-- ...tat_fcstMULTI_obsMETAR_PtypeComparisons.py | 26 ++++++++----- ...ntStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py | 38 +++++++++++++++---- 11 files changed, 195 insertions(+), 59 deletions(-) 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 cf851dc1e5..f4dff21ae2 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 @@ -42,7 +42,7 @@ ############################################################################## # METplus Components -# -------------------- +# ------------------ # # This use case utilizes GenVxMask and the METplus PointStat tool to compare PBLH # from AMDAR data to model output. The python embedding script "calc_amdar_pblh.py" @@ -52,7 +52,8 @@ ############################################################################## # METplus Workflow -# -------------------- +# ---------------- +# # GenVxMask and PointStat are called in this example. The following run times are processed: # # | **Valid:** 2022-07-01_20Z @@ -87,23 +88,31 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# .. dropdown:: met_config/PointStatConfig_wrapped # +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## # Python Embedding -# ----------------- +# ---------------- # # This use case uses a Python embedding script to read input data # -# parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed/calc_amdar_pblh.py +# .. dropdown:: parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed/calc_amdar_pblh.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed/calc_amdar_pblh.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed/calc_amdar_pblh.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 7a13573224..f36bc2b627 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -71,7 +71,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -81,19 +81,30 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **EnsembleStatConfig_wrapped** +# .. dropdown:: EnsembleStatConfig_wrapped # -# .. note:: See the :ref:`EnsembleStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped +# .. dropdown:: GridStatConfig_wrapped # -# **GridStatConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 59d0e68075..923afc22c4 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 @@ -89,7 +89,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -99,10 +99,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GenEnsProd MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: met_config/GenEnsProdConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 cc32ba20f3..39cee2157d 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 @@ -86,10 +86,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 c5a24dd318..e45a8dbfb5 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 @@ -106,10 +106,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 6c79cd6122..f4bff38638 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 @@ -87,10 +87,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 1629c1a3e5..13b55f96de 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 @@ -99,10 +99,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 97c086a886..34a25f6433 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 @@ -73,7 +73,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -83,10 +83,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`MTD MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: MTDConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 3d04142b23..d3388898d1 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 @@ -73,7 +73,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -83,10 +83,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`MTD MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: MTDConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 77622e23f7..43a391b94e 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 @@ -75,7 +75,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -85,19 +85,27 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **PB2NCConfig_wrapped** +# .. dropdown:: **PB2NCConfig_wrapped** # -# .. note:: See the :ref:`PB2NC MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped +# .. dropdown:: **PointStatConfig_wrapped** # -# **PointStatConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 d5bc586ff4..288dacb429 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 @@ -27,7 +27,7 @@ ############################################################################## # Datasets -# --------------------- +# -------- # # | **Forecast:** 24 URMA 1 hour precipitation accumulation files # @@ -78,14 +78,38 @@ ############################################################################## # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped -# +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` +# +# .. dropdown: Ascii2NcConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped +# +# .. dropdown: +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus From 071e38021838ac529bea467cd92b383bdf195a0b Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 20 Nov 2024 15:55:52 -0700 Subject: [PATCH 21/51] adding double colons --- .../precipitation/EnsembleStat_fcstWOFS_obsWOFS.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) 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 f36bc2b627..66923fe1d6 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -78,7 +78,8 @@ # # **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 currently not supported by METplus you'd like to control, please refer to: +# If there is a setting in the MET configuration file that is currently +# not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # # .. dropdown:: EnsembleStatConfig_wrapped @@ -127,7 +128,7 @@ # # Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. # Output for this use case will be found in WOFS/grid_stat (relative to **OUTPUT_BASE**) -# The following folder/file combination will be created: +# The following folder/file combination will be created:: # # * 20200615/1700/grid_stat_WOFS_PCP_1700_A1_000000L_20200615_180000V_pairs.nc # * 20200615/1700/grid_stat_WOFS_PCP_1700_A1_000000L_20200615_180000V.stat From 8d25d20c1140ea1bc11524fe970e60e98fe6eb93 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Wed, 20 Nov 2024 16:12:33 -0700 Subject: [PATCH 22/51] Attempting to resolve errors --- .../precipitation/EnsembleStat_fcstWOFS_obsWOFS.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 66923fe1d6..fdc8e5f287 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -30,7 +30,7 @@ # Datasets # -------- # -# * Forecast dataset: WoFS Ensemble +# * Forecast dataset: WoFS Ensemble # ############################################################################### @@ -39,7 +39,7 @@ # # This use case runs PCP-Combine on each ensemble member, then runs # Ensemble-Stat on the output. Finally, it runs Grid-Stat on the output from -# Ensemble-Stat +# Ensemble-Stat. ############################################################################### # METplus Workflow @@ -95,6 +95,7 @@ # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on # `Python embedding `_ + ############################################################################## # Python Embedding # ---------------- @@ -133,7 +134,6 @@ # * 20200615/1700/grid_stat_WOFS_PCP_1700_A1_000000L_20200615_180000V_pairs.nc # * 20200615/1700/grid_stat_WOFS_PCP_1700_A1_000000L_20200615_180000V.stat - ############################################################################## # Keywords # -------- From db1c1fed1aec2200140df0488902be7fae210fbc Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 21 Nov 2024 12:06:15 -0700 Subject: [PATCH 23/51] dropdowns for s2s and s2s_mjo --- ...lysis_fcstNMME_obsCPC_seasonal_forecast.py | 24 +++++++---- ...Stat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py | 26 ++++++++++-- ...MS_climoStandardized_MultiStatisticTool.py | 40 ++++++++++++++++--- .../s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py | 24 ++++++----- ...UserScript_fcstS2S_obsERAI_CrossSpectra.py | 18 ++++----- ...UserScript_obsPrecip_obsOnly_Hovmoeller.py | 9 +++-- .../UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 27 +++++++++++-- 7 files changed, 125 insertions(+), 43 deletions(-) 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 a2728ae79e..d6a236eed2 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 @@ -209,19 +209,27 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **GridStatConfig_wrapped** +# .. dropdown:: GridStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. dropdown:: SeriesAnalysisConfig_wrapped # -# **SeriesAnalysisConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- # -# .. note:: See the :ref:`SeriesAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 48f7956129..b8d6355d35 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 @@ -78,11 +78,31 @@ # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` +# +# .. dropdown:: GridStatConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 8446ba51fc..01927ca8eb 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 @@ -79,15 +79,43 @@ ############################################################################## # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped -# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` +# +# .. dropdown:: SeriesAnalysisConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped +# +# .. dropdown:: GenEnsProdConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped +# +# .. dropdown:: GridStatConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 6e86c40d40..638dd7a498 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 @@ -148,13 +148,10 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **TCGenConfig_wrapped** -# -# .. note:: See the :ref:`TCGen MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCGenConfig_wrapped +# .. dropdown:: TCGenConfig_wrapped # +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCGenConfig_wrapped ############################################################################## # Python Embedding @@ -162,11 +159,20 @@ # # This use case uses a Python embedding script to create output graphics # -# parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF/UserScript_fcstGFSO_obsBDECKS_GDF_TDF.py +# .. dropdown:: parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF/UserScript_fcstGFSO_obsBDECKS_GDF_TDF.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF/UserScript_fcstGFSO_obsBDECKS_GDF_TDF.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF/UserScript_fcstGFSO_obsBDECKS_GDF_TDF.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 3bb4026fac..1fb494dfb7 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 @@ -64,31 +64,29 @@ # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.conf -# ############################################################################# # MET Configuration -# --------------------- +# ----------------- # # There are no MET tools used in this use case. -# ############################################################################## # Python Embedding # ---------------- # -# There is no python embedding in this use case -# +# There is no python embedding in this use case. ############################################################################## -# Python Scripts -# ---------------- +# User Scripting +# -------------- # -# This use case uses a Python script to perform plotting +# This use case uses a Python script to perform plotting. # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra/cross_spectra_plot.py +# .. dropdown:: UserScript_fcstS2S_obsERAI_CrossSpectra/cross_spectra_plot.py # +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra/cross_spectra_plot.py ############################################################################## # Running METplus 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 e05b51418c..b5e55f4f8c 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 @@ -79,21 +79,24 @@ # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf -# ############################################################################# # MET Configuration -# --------------------- +# ----------------- # # There are no MET tools used in this use case. -# ############################################################################## # Python Embedding # ---------------- # # There is no python embedding in this use case + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 3197771a97..a7bd6813cc 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 @@ -83,10 +83,18 @@ # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` +# +# .. dropdown:: mjo_enso_driver +# +# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py ############################################################################## # Python Scripts @@ -96,9 +104,20 @@ # the generation of a text file and a plot for the indices: # parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py: # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py +# .. dropdown:: +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus From b269ea38e22b825f4fa89c11cec592e8bea72670 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 21 Nov 2024 15:27:38 -0700 Subject: [PATCH 24/51] adding dropdowns for short_range files --- ...eStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py | 20 ++++++++--- ...sProd_fcstHRRR_fcstOnly_SurrogateSevere.py | 18 ++++++++-- ...Stat_fcstFV3_obsGOES_BrightnessTempDmap.py | 18 ++++++++-- ...fcstHRRR_obsPracPerfect_SurrogateSevere.py | 18 ++++++++-- ...HRRR_obsPracPerfect_SurrogateSevereProb.py | 18 ++++++++-- ...ETdbLoad_fcstFV3_obsGoes_BrightnessTemp.py | 32 +++++++++++++++-- .../MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py | 20 ++++++++--- ...S_obsGOES_MRMS_BrightnessTemp_Lightning.py | 8 ++--- .../MODE_fcstFV3_obsGOES_BrightnessTemp.py | 20 ++++++++--- ...MODE_fcstFV3_obsGOES_BrightnessTempObjs.py | 24 +++++++++---- .../MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py | 20 ++++++++--- ...2Grid_obsLSR_ObsOnly_PracticallyPerfect.py | 34 ++++++++++++++----- ...stFV3_fcstOnly_PhysicsTendency_Planview.py | 11 ++++++ ...ly_PhysicsTendency_VerticalCrossSection.py | 22 ++++++------ ...cstOnly_PhysicsTendency_VerticalProfile.py | 13 ++++++- ...format_Aggregate_Plot_ecnt_spread_skill.py | 32 +++++++++-------- 16 files changed, 254 insertions(+), 74 deletions(-) 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 b13b013b6b..dd5c4f75ea 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 @@ -81,7 +81,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -91,10 +91,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`EnsembleStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: EnsembleStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 851b70eafe..f07b8d51d2 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 @@ -88,10 +88,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GenEnsProd MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GenEnsProdConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ################################################################################################### # Running METplus 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 f6f0123fd3..6e7b8b42ec 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 @@ -77,10 +77,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 5e7297c6a9..e39127f7b1 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 @@ -73,10 +73,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 1ddb3aa72d..1b34cf6a08 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 @@ -75,10 +75,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 818112a145..86f38487d5 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 @@ -72,6 +72,20 @@ # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf +############################################################################## +# MET Configuration +# ----------------- +# [UPDATE_SECTION_CONTENT] +# +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. +# +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` + ############################################################################## # XML Configuration # ----------------- @@ -86,8 +100,22 @@ # section of the User's Guide for more information on the values # substituted in the file below: # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/METdbLoad/METdbLoadConfig.xml +# .. dropdown:: METdbLoadConfig.xml +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/METdbLoad/METdbLoadConfig.xml + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 120437e7cf..2d945d18dc 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 @@ -94,7 +94,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -104,10 +104,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 19717ddafa..e6a62f8f6d 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 @@ -98,7 +98,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -119,10 +119,10 @@ # This use case does not use any Python Embedding. ############################################################################## -# Python Scripting -# ---------------- +# User Scripting +# -------------- # -# This use case does not use any Python Scripting. +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 d5e768fa3a..b0919278ea 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 @@ -66,7 +66,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -76,10 +76,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 abbaa1f077..bb494af9fb 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 @@ -79,15 +79,27 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 6a56ecab57..28db8f5249 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 @@ -72,7 +72,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -82,10 +82,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 ba3c202d3f..c13d140e0a 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 @@ -73,19 +73,26 @@ ############################################################################## # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped +# **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 currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` +# +# .. dropdown:: Ascii2NcConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # # See the following files for more information about the environment variables set in this configuration file. # # parm/use_cases/met_tool_wrapper/Point2Grid/Point2Grid.py # parm/use_cases/met_tool_wrapper/RegridDataPlane/RegridDataPlane.py -# ############################################################################## # Python Embedding @@ -93,11 +100,20 @@ # # This use case uses a Python embedding script to read input data # -# parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect/read_ascii_storm.py +# .. dropdown:: parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect/read_ascii_storm.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect/read_ascii_storm.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect/read_ascii_storm.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 48955ce776..a6a836a607 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 @@ -110,6 +110,17 @@ # See :ref:`How METplus controls MET config file settings` # for more details. +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 99d76b9ebb..f6c9db015d 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 @@ -47,9 +47,6 @@ # # | **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. -# - - ############################################################################## # External Dependencies @@ -64,16 +61,12 @@ # * pandas # * shapely # * xarray -# - - ############################################################################## # METplus Components # ------------------ # # This use case runs the METplotpy cross_section_vert.py script to generate the plan views. -# ############################################################################## # METplus Workflow @@ -81,7 +74,6 @@ # # This use case does not loop but plots physics tendency data that has been # subsetted to one date: 2019-06-15. -# ############################################################################## @@ -94,11 +86,10 @@ # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf -# ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # No MET tools are used in this use case. # @@ -106,7 +97,18 @@ # See :ref:`How METplus controls MET config file settings` for more details. # # .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 950dfbf9da..f90faf99bd 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 @@ -107,7 +107,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # No MET tools are used in this use case. # @@ -115,7 +115,18 @@ # See :ref:`How METplus controls MET config file settings` for more details. # # .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 99116bbd2a..982d63d06e 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 @@ -132,41 +132,45 @@ ############################################################################# # MET Configuration -# --------------------- +# ----------------- # # There are no MET tools used in this use case. The use case uses MET .stat # output as input for the reformatting step. -# ############################################################################## # Python Embedding # ---------------- # -# There is no python embedding in this use case -# +# This use case does not use Python embedding. ############################################################################## -# Python Scripts -# ---------------- -# This use case uses Python scripts to invoke the METdataio reformatter, the METcalcpy aggregator, and the METplotpy -# line plot. +# User Scripting +# -------------- + +# This use case uses Python scripts to invoke the METdataio reformatter, the METcalcpy aggregator, +# and the METplotpy line plot. # # The following Python script (from METdataio) is used to reformat the MET .stat ECNT linetype data # into a format that can be used by the aggregating script. # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/reformat_ecnt_linetype.py +# .. dropdown:: parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/reformat_ecnt_linetype.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/reformat_ecnt_linetype.py # # This Python script (from METcalcpy) is used to calculate aggregation statistics for the ECNT linetype. # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/aggregate_ecnt.py +# .. dropdown:: parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/aggregate_ecnt.py +# +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/aggregate_ecnt.py # # Finally,this Python script (from METplotpy) is used to generate a spread-skill plot using the METplotypy line plot code. # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py +# .. dropdown::,parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py # +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py ############################################################################## # Running METplus From 5cfbece464555c84943d5cb8305957a3ede90399 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 22 Nov 2024 10:56:30 -0700 Subject: [PATCH 25/51] final dropdown directories --- ...Mask_fcstGloTEC_FcstOnly_solar_altitude.py | 13 +++++- .../GridStat_fcstGloTEC_obsGloTEC_vx7.py | 18 ++++++-- ...otter_fcstGFS_obsGFS_UserScript_ExtraTC.py | 20 +++++---- .../GridStat_fcstHAFS_obsTDR_NetCDF.py | 45 +++++++++++++------ .../Plotter_fcstGFS_obsGFS_ExtraTC.py | 18 ++++++-- .../TCGen_fcstGFS_obsBDECK_2021season.py | 20 +++++++-- ...at_fcstADECK_obsBDECK_ATCF_BasicExample.py | 24 ++++++++-- .../TCRMW_fcstGFS_fcstOnly_gonzalo.py | 20 +++++++-- ...CII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py | 33 +++++++------- ...alysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py | 23 +++++++--- 10 files changed, 171 insertions(+), 63 deletions(-) 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 53e683563e..374a567061 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 @@ -110,10 +110,21 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # None. GenVxMask does not use configuration files. + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 7e2f0266d7..e4c3af319b 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 @@ -114,10 +114,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 b0c9a703f4..04e90c7471 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 @@ -11,7 +11,7 @@ # :local: # :backlinks: none -########################################### +############################################################################## # Scientific Objective # -------------------- # @@ -98,10 +98,10 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped ############################################################################## # Python Embedding @@ -113,12 +113,16 @@ # the user input. These storms are put into separate storm files, to better mimic how TC storms are # typically passed to TCPairs. # -# parm/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC/extract_opc_decks.py -# -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC/extract_opc_decks.py +# .. dropdown:: parm/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC/extract_opc_decks.py # +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC/extract_opc_decks.py +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 a8c35e1d30..dda48a0aba 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 @@ -78,36 +78,55 @@ ############################################################################## # 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. +# METplus sets environment variables based on user settings in the METplus +# configuration file. See :ref:`How METplus controls MET config file settings` for more details. # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!** # -# Note the following variables are referenced in the MET configuration file. +# If there is a setting in the MET configuration file that is currently +# not supported by METplus you’d like to control, please refer to: +# :ref:`Overriding Unsupported MET config file settings` # +# .. dropdown:: GridStatConfig_wrapped # +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding # ---------------- # -# This use case uses a Python embedding script to read input data +# This use case uses a Python embedding script to read input data. # -# parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/read_tdr.py +# .. dropdown:: parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/read_tdr.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/read_tdr.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/read_tdr.py # # The above script imports another script called tdr_utils.py in the same directory: # -# parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/tdr_utils.py +# .. dropdown:: parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/tdr_utils.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/tdr_utils.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/tdr_utils.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 f21b38571b..e941bbfca0 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 @@ -76,10 +76,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 9a43046afb..36b77a0520 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 @@ -72,7 +72,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -82,10 +82,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`TC-Gen MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: TCGenConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCGenConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCGenConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 3bfd2104a0..8e36dca061 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 @@ -104,11 +104,27 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped -# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped +# +# .. dropdown:: TCStatConfig_wrapped +# +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 9c8f059250..a7b7b55e84 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 @@ -66,7 +66,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -76,10 +76,22 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`TCRMW MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: TCRMWConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/TCRMWConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/TCRMWConfig_wrapped + +############################################################################## +# Python Embedding +# ---------------- +# +# This use case does not use Python embedding. + +############################################################################## +# User Scripting +# -------------- +# +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 6aa8b97984..339e2e3428 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 @@ -77,7 +77,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus configuration file. # See :ref:`How METplus controls MET config file settings` for more details. @@ -87,18 +87,14 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# **Ascii2NcConfig_wrapped** -# -# .. note:: See the :ref:`ASCII2NC MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped +# .. dropdown:: Ascii2NcConfig_wrapped # -# **PointStatConfig_wrapped** +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: PointStatConfig_wrapped # -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## # Python Embedding @@ -106,16 +102,21 @@ # # This use case uses two Python embedding scripts: one to download the data (hrd_frd_sonde_find_tar.py) and the other to process it (hrd_frd_sonde_for_ascii2nc.py). # -# parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_find_tar.py +# .. dropdown:: parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_find_tar.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_find_tar.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_find_tar.py # -# parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_for_ascii2nc.py +# .. dropdown:: parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_for_ascii2nc.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_for_ascii2nc.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_for_ascii2nc.py + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus 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 f151962b86..b904adab03 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 @@ -96,22 +96,31 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. note:: See the :ref:`StatAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. dropdown:: STATAnalysisConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped +# .. highlight:: bash +# .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped ############################################################################## # Python Embedding # ---------------- # -# This use case uses a Python embedding script to read input data +# This use case uses a Python embedding script to read input data. +# +# .. dropdown:: parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed/ugrid_lfric_mpr.py # -# parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed/ugrid_lfric_mpr.py +# .. highlight:: python +# .. literalinclude:: ../../../../parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed/ugrid_lfric_mpr.py # -# .. highlight:: python -# .. literalinclude:: ../../../../parm/use_cases/model_applications/unstructured_grids/StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed/ugrid_lfric_mpr.py +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on +# `Python embedding `_ + +############################################################################## +# User Scripting +# -------------- # +# User Scripting is not used in this use case. ############################################################################## # Running METplus From e86223843edb9fe8b4dbdd7555fd485fa0868fc2 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 10:03:41 -0700 Subject: [PATCH 26/51] Update docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py removing note Co-authored-by: Julie Prestopnik --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 1 - 1 file changed, 1 deletion(-) 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 381fe99c80..b754c1cdbe 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 @@ -102,7 +102,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped From 2651435e2142544dca6a8f6dd2caeb0ee5332e5c Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 10:11:13 -0700 Subject: [PATCH 27/51] Apply suggestions from code review adding all of the suggestions Co-authored-by: Julie Prestopnik --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 1 - .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 2 -- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 2 -- 3 files changed, 5 deletions(-) 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 b754c1cdbe..fe54b5b1d0 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 @@ -103,7 +103,6 @@ # .. dropdown:: GridStatConfig_wrapped # # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 7f0dd4d226..c9509f3ea3 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 @@ -101,9 +101,7 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 df2ed42daf..3f0041c370 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 @@ -103,9 +103,7 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## From 3e175818224b0abd4cf014bc6157897b3bb68a01 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 10:23:27 -0700 Subject: [PATCH 28/51] Update GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py ensuring literal include is in dropdown menu --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 fe54b5b1d0..7c2dda7552 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 @@ -102,8 +102,7 @@ # # .. dropdown:: GridStatConfig_wrapped # -# -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding From 5bcbc00ee2247160ca5c91f5b4c1dec333a713c0 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 10:26:53 -0700 Subject: [PATCH 29/51] Update GridStat_fcstRTOFS_obsOSTIA_iceCover.py ensuring literal include is in dropdown --- .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 c9509f3ea3..201f87e0b1 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 @@ -101,8 +101,7 @@ # # .. dropdown:: GridStatConfig_wrapped # -# -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding From 8ed88ecb2659eb2846ab27330caaa1d589b3a8cc Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 10:28:18 -0700 Subject: [PATCH 30/51] ensuring literal include is in dropdown menu --- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 3f0041c370..6d84e86302 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 @@ -103,8 +103,7 @@ # # .. dropdown:: GridStatConfig_wrapped # -# -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding From 6ef5d57dfeaf39ad39f46a3b04a9d17e41e50afd Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 2 Dec 2024 11:54:41 -0700 Subject: [PATCH 31/51] marine_and_cryosphere MET Configuration dropdown fixes --- .../GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py | 1 - .../GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py | 1 - .../GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py | 5 +---- .../PlotDataPlane_obsHYCOM_coordTripolar.py | 1 - .../PointStat_fcstGFS_obsASCAT_satelliteWinds.py | 5 +---- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 5 +---- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 2 -- .../PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py | 10 +++------- 8 files changed, 6 insertions(+), 24 deletions(-) diff --git a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py index efbb329c9d..fb528e6c12 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py @@ -114,7 +114,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped # # .. dropdown:: MODEConfig_wrapped diff --git a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py index d9c58bd3a2..a850b6c6bf 100644 --- a/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py +++ b/docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.py @@ -98,7 +98,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 aa2f924918..718ca11965 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 @@ -103,10 +103,7 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding 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 b03b77e52c..bd12b0b473 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 @@ -90,7 +90,6 @@ # ----------------- # # This tool does not use a MET configuration file. -# ############################################################################## # Python Embedding 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 64f641ea3a..66bd29fafd 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 @@ -81,10 +81,7 @@ # # .. dropdown:: PointStatConfig_wrapped # -# .. note:: See the :ref:`GridStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## # Python Embedding 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 93a1033601..d75f60f5ef 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 @@ -86,10 +86,7 @@ # # .. dropdown:: PointStatConfig_wrapped # -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: -# -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## # Python Embedding 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 8e3186c33e..abbe17225f 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 @@ -81,12 +81,10 @@ # # .. dropdown:: GridStatConfig_wrappedAscii2NcConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # # .. dropdown:: PointStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## 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 6f48cb714d..2b919664b8 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 @@ -94,15 +94,11 @@ # # .. dropdown:: Ascii2NcConfig_wrapped # -# .. dropdown:: PointStatConfig_wrapped -# -# .. note:: See the :ref:`PointStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: +# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped +# .. dropdown:: PointStatConfig_wrapped # -# .. highlight:: bash -# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped +# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## # Python Embedding From 8c674ba440871f189bdc86c2e35a6e4168165318 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 2 Dec 2024 14:55:01 -0700 Subject: [PATCH 32/51] remaining dropdown directories for MET Configuration --- .../medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py | 1 - .../medium_range/GridStat_fcstGFS_obsGFS_Sfc_MultiField.py | 1 - .../GridStat_fcstGFS_obsGFS_climoNCEP_MultiField.py | 1 - .../GridStat_fcstGFS_obsOMI_TotalColumnOzone.py | 1 - ...sAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py | 2 -- ...ointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.py | 1 - .../PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.py | 1 - ...sAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.py | 3 --- ...sAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py | 3 --- ...ureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.py | 3 --- .../pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py | 1 - .../precipitation/EnsembleStat_fcstWOFS_obsWOFS.py | 6 ------ .../precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py | 1 - .../precipitation/GridStat_fcstGFS_obsCCPA_GRIB.py | 1 - .../precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.py | 1 - .../precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.py | 1 - .../precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.py | 1 - .../MTD_fcstHRRR-TLE_FcstOnly_RevisionSeries_GRIB.py | 1 - .../precipitation/MTD_fcstHRRR-TLE_obsMRMS.py | 1 - .../PointStat_fcstMULTI_obsMETAR_PtypeComparisons.py | 6 ++---- ...Stat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.py | 2 -- .../s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py | 1 - ...FSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.py | 3 --- .../s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py | 1 - .../s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 4 ++-- .../EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.py | 1 - .../GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.py | 1 - .../GridStat_fcstFV3_obsGOES_BrightnessTempDmap.py | 1 - .../GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.py | 1 - .../GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.py | 1 - .../short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.py | 1 - .../short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.py | 1 - .../short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.py | 1 - .../short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.py | 2 -- .../short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.py | 1 - .../Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py | 6 ------ .../UserScript_fcstFV3_fcstOnly_PhysicsTendency_Planview.py | 5 ----- ...fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.py | 5 ----- ...ript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.py | 5 ----- .../space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.py | 1 - .../CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.py | 1 - .../tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.py | 1 - .../tc_and_extra_tc/Plotter_fcstGFS_obsGFS_ExtraTC.py | 1 - .../tc_and_extra_tc/TCGen_fcstGFS_obsBDECK_2021season.py | 1 - .../TCPairs_TCStat_fcstADECK_obsBDECK_ATCF_BasicExample.py | 2 -- .../tc_and_extra_tc/TCRMW_fcstGFS_fcstOnly_gonzalo.py | 1 - .../UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py | 1 - .../StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py | 1 - 48 files changed, 4 insertions(+), 86 deletions(-) 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 a6724ae48a..93fbd1ca7c 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 @@ -88,7 +88,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 abcc536417..bb0b0ebed4 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 @@ -84,7 +84,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 ae07a0b4b1..9ce32cb092 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 @@ -91,7 +91,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped # # .. dropdown:: StatAnalysisConfig_wrapped 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 e408af43ca..c00bd3daac 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 @@ -82,7 +82,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 d9c7a18f7a..7ad8939ece 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 @@ -101,12 +101,10 @@ # # .. dropdown:: MTDConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped # # .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## 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 9d88a64daf..cba9ca5ed5 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 @@ -83,7 +83,6 @@ # # .. dropdown:: PB2NCConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # # .. dropdown:: PointStatConfig_wrapped** 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 3559de6a73..4402590b60 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 @@ -86,7 +86,6 @@ # # .. dropdown:: PB2NCConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # # .. dropdown:: PointStatConfig_wrapped 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 1f8cb4f626..0a95fbcb72 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 @@ -131,17 +131,14 @@ # # .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # # .. dropdown:: TCStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # # .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## 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 fa918e10f7..337f898f11 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 @@ -114,17 +114,14 @@ # # .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # # .. dropdown:: TCStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # # .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## 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 41ab664a02..1f2a250b42 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 @@ -180,17 +180,14 @@ # # .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # # .. dropdown:: TCStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # # .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## 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 f4dff21ae2..e970786c54 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 @@ -90,7 +90,6 @@ # # .. dropdown:: met_config/PointStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## 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 fdc8e5f287..5c230dd1cc 100644 --- a/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py +++ b/docs/use_cases/model_applications/precipitation/EnsembleStat_fcstWOFS_obsWOFS.py @@ -84,17 +84,11 @@ # # .. dropdown:: EnsembleStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped -# -# For more information on the basic requirements to utilize Python Embedding in METplus, -# please refer to the MET User’s Guide section on -# `Python embedding `_ ############################################################################## # Python Embedding 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 923afc22c4..287ccbb0fa 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 @@ -101,7 +101,6 @@ # # .. dropdown:: met_config/GenEnsProdConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped ############################################################################## 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 39cee2157d..9c3310a120 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 @@ -88,7 +88,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 e45a8dbfb5..11feed8b5a 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 @@ -108,7 +108,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 f4bff38638..1442b2ce1d 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 @@ -89,7 +89,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 13b55f96de..21c33a1dcc 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 @@ -101,7 +101,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 34a25f6433..bd5eafbff2 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 @@ -85,7 +85,6 @@ # # .. dropdown:: MTDConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped ############################################################################## 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 d3388898d1..e8fd067970 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 @@ -85,7 +85,6 @@ # # .. dropdown:: MTDConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped ############################################################################## 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 43a391b94e..9aee485076 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 @@ -85,14 +85,12 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. dropdown:: **PB2NCConfig_wrapped** +# .. dropdown:: PB2NCConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # -# .. dropdown:: **PointStatConfig_wrapped** +# .. dropdown:: PointStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## 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 d6a236eed2..f2340d854a 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 @@ -211,12 +211,10 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped # # .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## 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 b8d6355d35..4e08ffda6b 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 @@ -89,7 +89,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 01927ca8eb..f759dc94ee 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 @@ -92,17 +92,14 @@ # # .. dropdown:: SeriesAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped # # .. dropdown:: GenEnsProdConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 638dd7a498..1169d68017 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 @@ -150,7 +150,6 @@ # # .. dropdown:: TCGenConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCGenConfig_wrapped ############################################################################## 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 a7bd6813cc..23d0f90c21 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 @@ -81,7 +81,7 @@ ############################################################################## # MET Configuration -# --------------------- +# ----------------- # # METplus sets environment variables based on user settings in the METplus # configuration file. See :ref:`How METplus controls MET config file settings` for more details. @@ -98,7 +98,7 @@ ############################################################################## # Python Scripts -# ---------------- +# -------------- # # The MJO-ENSO driver script orchestrates the calculation of the MaKE and MaKI indices and # the generation of a text file and a plot for the indices: 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 dd5c4f75ea..bfa6375b7d 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 @@ -93,7 +93,6 @@ # # .. dropdown:: EnsembleStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped ############################################################################## 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 f07b8d51d2..096d63f344 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 @@ -90,7 +90,6 @@ # # .. dropdown:: GenEnsProdConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped ############################################################################## 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 6e7b8b42ec..5f687915ab 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 @@ -79,7 +79,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 e39127f7b1..8788d060c0 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 @@ -75,7 +75,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 1b34cf6a08..e17d815b81 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 @@ -77,7 +77,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 86f38487d5..604ee3ac80 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 @@ -75,7 +75,6 @@ ############################################################################## # MET Configuration # ----------------- -# [UPDATE_SECTION_CONTENT] # # METplus sets environment variables based on user settings in the METplus # configuration file. See :ref:`How METplus controls MET config file settings` for more details. 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 2d945d18dc..ef17d78820 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 @@ -106,7 +106,6 @@ # # .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped ############################################################################## 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 b0919278ea..d738aed669 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 @@ -78,7 +78,6 @@ # # .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped ############################################################################## 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 bb494af9fb..013c28a475 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 @@ -81,12 +81,10 @@ # # .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 28db8f5249..019cfb6551 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 @@ -84,7 +84,6 @@ # # .. dropdown:: MODEConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped ############################################################################## 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 c13d140e0a..c7a95b479b 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 @@ -86,13 +86,7 @@ # # .. dropdown:: Ascii2NcConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped -# -# See the following files for more information about the environment variables set in this configuration file. -# -# parm/use_cases/met_tool_wrapper/Point2Grid/Point2Grid.py -# parm/use_cases/met_tool_wrapper/RegridDataPlane/RegridDataPlane.py ############################################################################## # Python Embedding 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 a6a836a607..be714f4e3a 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 @@ -104,11 +104,6 @@ # ----------------- # # No MET tools are used in this use case. -# -# METplus sets environment variables based on user settings in the METplus -# configuration file. -# See :ref:`How METplus controls MET config file settings` -# for more details. ############################################################################## # Python Embedding 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 f6c9db015d..737d607273 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 @@ -92,11 +92,6 @@ # ----------------- # # No MET tools are used in this use case. -# -# METplus sets environment variables based on user settings in the METplus configuration file. -# See :ref:`How METplus controls MET config file settings` for more details. -# -# .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: ############################################################################## # Python Embedding 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 f90faf99bd..f35badb5a5 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 @@ -110,11 +110,6 @@ # ----------------- # # No MET tools are used in this use case. -# -# METplus sets environment variables based on user settings in the METplus configuration file. -# See :ref:`How METplus controls MET config file settings` for more details. -# -# .. note:: See the :ref:`MODE MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: ############################################################################## # Python Embedding 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 e4c3af319b..06c7e02cb8 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 @@ -116,7 +116,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 04e90c7471..1fcb93b8b7 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 @@ -100,7 +100,6 @@ # # .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped ############################################################################## 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 dda48a0aba..7ec3a1ea44 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 @@ -91,7 +91,6 @@ # # .. dropdown:: GridStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## 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 e941bbfca0..e3b8edd2f8 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 @@ -78,7 +78,6 @@ # # .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped ############################################################################## 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 36b77a0520..a2fcb10437 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 @@ -84,7 +84,6 @@ # # .. dropdown:: TCGenConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCGenConfig_wrapped ############################################################################## 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 8e36dca061..f89923ba80 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 @@ -106,12 +106,10 @@ # # .. dropdown:: TCPairsConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # # .. dropdown:: TCStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped ############################################################################## 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 a7b7b55e84..2cbe3287d4 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 @@ -78,7 +78,6 @@ # # .. dropdown:: TCRMWConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCRMWConfig_wrapped ############################################################################## 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 339e2e3428..48c56963f2 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 @@ -89,7 +89,6 @@ # # .. dropdown:: Ascii2NcConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # # .. dropdown:: PointStatConfig_wrapped 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 b904adab03..38883e1b8a 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 @@ -98,7 +98,6 @@ # # .. dropdown:: STATAnalysisConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped ############################################################################## From 1841a6ffa3186593e8cd9b9d1770319b6b147af4 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 15:24:01 -0700 Subject: [PATCH 33/51] Julie changing dropdowns Co-authored-by: Julie Prestopnik --- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 abbe17225f..8b596a1d89 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 @@ -79,7 +79,7 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. dropdown:: GridStatConfig_wrappedAscii2NcConfig_wrapped +# .. dropdown:: Ascii2NcConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # From 50806ba8e737941d630c1a661fe10f6286678a08 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 2 Dec 2024 15:24:29 -0700 Subject: [PATCH 34/51] HEAD needed to be removed --- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 3 --- 1 file changed, 3 deletions(-) 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 d75f60f5ef..75c10144c7 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 @@ -106,15 +106,12 @@ # please refer to the MET User’s Guide section on # `Python embedding `_ -<<<<<<< HEAD ############################################################################## # User Scripting # -------------- # # User Scripting is not used in this use case. -======= ->>>>>>> 2b546121d8fc91ab72e92307c6cd4a2b53e8e1ad ############################################################################## # Running METplus # --------------- From 1e08d75e70a1edc8b9822ff137eceb1fa94ba220 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:09:07 -0700 Subject: [PATCH 35/51] There are not MET tools used in this use case --- .../UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) 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 23d0f90c21..722debb4b5 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 @@ -83,19 +83,8 @@ # MET Configuration # ----------------- # -# METplus sets environment variables based on user settings in the METplus -# configuration file. See :ref:`How METplus controls MET config file settings` for more details. -# -# **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 currently -# not supported by METplus you’d like to control, please refer to: -# :ref:`Overriding Unsupported MET config file settings` -# -# .. dropdown:: mjo_enso_driver -# -# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py - +# There are no MET tools used in this use case. + ############################################################################## # Python Scripts # -------------- From 75d7f65cbc50f7adf955e7b04342ca45656706a0 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:10:58 -0700 Subject: [PATCH 36/51] There are no MET tools used in this use case --- .../METdbLoad_fcstFV3_obsGoes_BrightnessTemp.py | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) 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 604ee3ac80..172c32bedb 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 @@ -76,14 +76,7 @@ # MET Configuration # ----------------- # -# METplus sets environment variables based on user settings in the METplus -# configuration file. See :ref:`How METplus controls MET config file settings` for more details. -# -# **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 currently -# not supported by METplus you’d like to control, please refer to: -# :ref:`Overriding Unsupported MET config file settings` +# There are no MET tools used in this use case. ############################################################################## # XML Configuration From c17a6d5b6b13f45cb1b52b848b7eaf846a865817 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:25:17 -0700 Subject: [PATCH 37/51] Apply suggestions from code review Co-authored-by: Julie Prestopnik --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 2 +- .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 2 +- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 2 +- .../GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py | 2 +- .../PlotDataPlane_obsHYCOM_coordTripolar.py | 2 +- .../PointStat_fcstGFS_obsASCAT_satelliteWinds.py | 2 +- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 2 +- .../medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE.py | 4 ++-- .../medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone.py | 2 +- ...atureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.py | 2 +- .../medium_range/UserScript_fcstGEFS_Difficulty_Index.py | 2 +- .../pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py | 2 +- .../PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py | 4 +--- .../s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py | 2 +- .../s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py | 2 +- .../s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.py | 2 +- .../Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py | 2 +- ...RRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py | 2 +- .../CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.py | 4 ++++ .../tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.py | 4 ++-- .../UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF.py | 3 +++ .../StatAnalysis_fcstLFRIC_UGRID_obsASCII_PyEmbed.py | 2 +- 22 files changed, 29 insertions(+), 24 deletions(-) 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 7c2dda7552..b1a855b2d1 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 @@ -117,7 +117,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_ . ############################################################################## # User Scripting 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 201f87e0b1..4a69d11a1f 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 @@ -116,7 +116,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 6d84e86302..e3979a628a 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 @@ -118,7 +118,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 718ca11965..20a5f0ab67 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 @@ -119,7 +119,7 @@ # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 bd12b0b473..f34aebacf7 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 @@ -104,7 +104,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 66bd29fafd..6dd84259cb 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 @@ -101,7 +101,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 75c10144c7..c3203814f7 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 @@ -104,7 +104,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 93fbd1ca7c..3e4a26ba65 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 @@ -95,7 +95,7 @@ # ---------------- # # This use case calls a Python script to parse the user-requested percentile from the forecast dataset. -# This is controlled in the forecast VAR1 variable setting and is provided in the below file. +# This is controlled in the forecast VAR1 variable setting and is provided in: # # .. dropdown:: parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE/Tmax_fcst_embedded.py # @@ -103,7 +103,7 @@ # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGEFS_obsCADB_BinaryObsPOE/Tmax_fcst_embedded.py # # For more information on the basic requirements to utilize Python Embedding in METplus, -# please refer to the MET User’s Guide section on `Python embedding `_ +# please refer to the MET User’s Guide section on `Python embedding `_. ############################################################################## # User Scripting 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 c00bd3daac..11a694be01 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 @@ -96,7 +96,7 @@ # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/GridStat_fcstGFS_obsOMI_TotalColumnOzone/read_omi-aura_l3-omto3e.py # # For more information on the basic requirements to utilize Python Embedding in METplus, -# please refer to the MET User’s Guide section on `Python embedding `_ +# please refer to the MET User’s Guide section on `Python embedding `_. ############################################################################## # User Scripting 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 1f2a250b42..3c94db37ae 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 @@ -229,7 +229,7 @@ # # # For more information on the basic requirements to utilize Python Embedding in METplus, -# please refer to the MET User’s Guide section on `Python embedding `_ +# please refer to the MET User’s Guide section on `Python embedding `_. ############################################################################## # User Scripting 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 8c159a1f8f..97091fa0f7 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 @@ -128,7 +128,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 e970786c54..1daf99d344 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 @@ -105,7 +105,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 288dacb429..dc37d517dc 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 @@ -91,12 +91,10 @@ # # .. dropdown: Ascii2NcConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # -# .. dropdown: +# .. dropdown: PointStatConfig_wrapped # -# .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped ############################################################################## 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 1169d68017..921b883d85 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 @@ -165,7 +165,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 1fb494dfb7..4c970ae76f 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 @@ -75,7 +75,7 @@ # Python Embedding # ---------------- # -# There is no python embedding in this use case. +# There is no Python embedding in this use case. ############################################################################## # User Scripting 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 b5e55f4f8c..a0f11a3910 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 @@ -90,7 +90,7 @@ # Python Embedding # ---------------- # -# There is no python embedding in this use case +# There is no Python embedding in this use case. ############################################################################## # User Scripting 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 c7a95b479b..165f8f6689 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 @@ -101,7 +101,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 982d63d06e..e3d2620338 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 @@ -167,7 +167,7 @@ # # Finally,this Python script (from METplotpy) is used to generate a spread-skill plot using the METplotypy line plot code. # -# .. dropdown::,parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py +# .. dropdown:: parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py 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 1fcb93b8b7..83a75b770b 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 @@ -116,6 +116,10 @@ # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC/extract_opc_decks.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on `Python embedding `_. + ############################################################################## # User Scripting 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 7ec3a1ea44..219a9342c7 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 @@ -104,7 +104,7 @@ # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/read_tdr.py # -# The above script imports another script called tdr_utils.py in the same directory: +# The read_tdr.py script above imports another script called tdr_utils.py in the same directory: # # .. dropdown:: parm/use_cases/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF/tdr_utils.py # @@ -113,7 +113,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # Python Embedding 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 48c56963f2..9fc24578f4 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 @@ -110,6 +110,9 @@ # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/tc_and_extra_tc/UserScript_ASCII2NC_PointStat_fcstHAFS_obsFRD_NetCDF/hrd_frd_sonde_for_ascii2nc.py +# +# For more information on the basic requirements to utilize Python Embedding in METplus, +# please refer to the MET User’s Guide section on `Python embedding `_. ############################################################################## # User Scripting 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 38883e1b8a..290a1b8d5d 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 @@ -113,7 +113,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting From ec55a9217d53a3bf00717eafce77240f0fdef0d3 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 3 Dec 2024 09:56:30 -0700 Subject: [PATCH 38/51] Per #2741, few small changes --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 2 +- .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 2 +- .../s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 2 +- ...Multivar_fcstRRFS_obsGOES_MRMS_BrightnessTemp_Lightning.py | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) 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 b1a855b2d1..33894257d8 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 @@ -117,7 +117,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ . +# `Python embedding `_. ############################################################################## # User Scripting 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 c3203814f7..2924a718bd 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 @@ -99,7 +99,7 @@ # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py # -# .. highlight:: bash +# .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py # # For more information on the basic requirements to utilize Python Embedding in METplus, 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 722debb4b5..d63dba7a04 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 @@ -100,7 +100,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 e6a62f8f6d..cd3233ff8c 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 @@ -116,13 +116,13 @@ # Python Embedding # ---------------- # -# This use case does not use any Python Embedding. +# This use case does not use any Python embedding. ############################################################################## # User Scripting # -------------- # -# User Scripting is not used in this use case. +# This use case does not use additional scripts. ############################################################################## # Running METplus From 21a5aba06be7690bec3ae25afa217ed540e5d480 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 4 Dec 2024 15:55:58 -0700 Subject: [PATCH 39/51] updates from pull request discussion --- .../UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) 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 d63dba7a04..ff3e596ca4 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 @@ -86,7 +86,13 @@ # There are no MET tools used in this use case. ############################################################################## -# Python Scripts +# Python Embedding +# ---------------- +# +# Python Embedding is not used in this use case. + +############################################################################## +# User Scripting # -------------- # # The MJO-ENSO driver script orchestrates the calculation of the MaKE and MaKI indices and @@ -97,16 +103,6 @@ # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py -# -# For more information on the basic requirements to utilize Python Embedding in METplus, -# please refer to the MET User’s Guide section on -# `Python embedding `_. - -############################################################################## -# User Scripting -# -------------- -# -# User Scripting is not used in this use case. ############################################################################## # Running METplus From 994fe8a17e8c7cc4e17f0b0ce970f96f11663891 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:09:01 -0700 Subject: [PATCH 40/51] removing space Co-authored-by: Julie Prestopnik --- .../s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 ff3e596ca4..ef05bd6ebb 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 @@ -89,7 +89,7 @@ # Python Embedding # ---------------- # -# Python Embedding is not used in this use case. +# Python Embedding is not used in this use case. ############################################################################## # User Scripting From aaaae624f98956a0e333b7552f0d9d061b6d492b Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:09:34 -0700 Subject: [PATCH 41/51] fixing dropdown Co-authored-by: Julie Prestopnik --- .../PointStat_fcstGFS_obsASCAT_satelliteWinds.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 6dd84259cb..d60c7ed6bb 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 @@ -94,7 +94,7 @@ # in the code describing an alternate method that may be improved upon to allow different sattellites to have their own station IDs. # The location of the code is parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py # -# .. dropdown:: +# .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py From 3185c7cf0725fdd4398e98b37c7963d1a5243664 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:13:10 -0700 Subject: [PATCH 42/51] removing bash Co-authored-by: Julie Prestopnik --- .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4a69d11a1f..674af80b4e 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 @@ -107,7 +107,7 @@ # Python Embedding # ---------------- # -# This use case uses one Python script to read forecast and observation data +# This use case uses one Python script to read forecast and observation data. # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover/read_ice_data.py # From c8832ce95ced83ab8a2963ce57970e0c4b633712 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:14:50 -0700 Subject: [PATCH 43/51] update from Julie Co-authored-by: Julie Prestopnik --- .../GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 20a5f0ab67..b3e2485e24 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 @@ -116,7 +116,7 @@ # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss/read_rtofs_smos_woa.py # - +# # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on # `Python embedding `_. From 64a96ba780969095f4dc6d617839f0043a1261ed Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Wed, 4 Dec 2024 16:31:24 -0700 Subject: [PATCH 44/51] Fixing error --- ...stRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 e3d2620338..29426e964e 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,4 +1,4 @@ - """ +""" UserScript: Reformat MET .stat ECNT data, calculate aggregation statistics, and generate a spread skill plot ============================================================================================================ From 1a2d3da245b8e9a9cdea65bea545cfbb49ab1d9e Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:59:30 -0700 Subject: [PATCH 45/51] lots of typos Co-authored-by: Julie Prestopnik --- .../PointStat_fcstGFS_obsGDAS_UpperAir_MultiField_PrepBufr.py | 2 +- .../medium_range/UserScript_fcstGEFS_Difficulty_Index.py | 2 +- .../pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.py | 4 ++-- .../precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py | 2 +- .../PointStat_fcstURMA_obsCOCORAHS_ASCIIprecip.py | 4 ++-- .../s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.py | 2 +- .../s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py | 2 +- .../s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 2 +- ...RRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) 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 cba9ca5ed5..1c4c7721ba 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 @@ -85,7 +85,7 @@ # # .. literalinclude:: ../../../../parm/met_config/PB2NCConfig_wrapped # -# .. dropdown:: PointStatConfig_wrapped** +# .. dropdown:: PointStatConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped 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 97091fa0f7..36daa550c4 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 @@ -119,7 +119,7 @@ # Python Embedding # ---------------- # -# This use case uses a Python embedding script to read input data +# This use case uses a Python embedding script to read input data. # # .. dropdown:: parm/use_cases/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index/wind_difficulty_index.py # 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 1daf99d344..364e885271 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 @@ -88,7 +88,7 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. dropdown:: met_config/PointStatConfig_wrapped +# .. dropdown:: PointStatConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped @@ -96,7 +96,7 @@ # Python Embedding # ---------------- # -# This use case uses a Python embedding script to read input data +# This use case uses a Python embedding script to read input data. # # .. dropdown:: parm/use_cases/model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed/calc_amdar_pblh.py # 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 287ccbb0fa..30f83f4d3e 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 @@ -99,7 +99,7 @@ # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. dropdown:: met_config/GenEnsProdConfig_wrapped +# .. dropdown:: GenEnsProdConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped 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 dc37d517dc..536d932c94 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 @@ -89,11 +89,11 @@ # not supported by METplus you’d like to control, please refer to: # :ref:`Overriding Unsupported MET config file settings` # -# .. dropdown: Ascii2NcConfig_wrapped +# .. dropdown:: Ascii2NcConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/Ascii2NcConfig_wrapped # -# .. dropdown: PointStatConfig_wrapped +# .. dropdown:: PointStatConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped 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 921b883d85..97193c4cb6 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 @@ -156,7 +156,7 @@ # Python Embedding # ---------------- # -# This use case uses a Python embedding script to create output graphics +# This use case uses a Python embedding script to create output graphics. # # .. dropdown:: parm/use_cases/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF/UserScript_fcstGFSO_obsBDECKS_GDF_TDF.py # 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 4c970ae76f..a3c93aaf43 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 @@ -83,7 +83,7 @@ # # This use case uses a Python script to perform plotting. # -# .. dropdown:: UserScript_fcstS2S_obsERAI_CrossSpectra/cross_spectra_plot.py +# .. dropdown:: parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra/cross_spectra_plot.py # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra/cross_spectra_plot.py 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 ef05bd6ebb..5ac9f51768 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 @@ -99,7 +99,7 @@ # the generation of a text file and a plot for the indices: # parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py: # -# .. dropdown:: +# .. dropdown:: parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py 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 29426e964e..36205de762 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 @@ -146,7 +146,7 @@ ############################################################################## # User Scripting # -------------- - +# # This use case uses Python scripts to invoke the METdataio reformatter, the METcalcpy aggregator, # and the METplotpy line plot. # From 0f6998836bb803eb1adaeb5ef19b7f581b6822a5 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 9 Dec 2024 15:54:29 -0700 Subject: [PATCH 46/51] Adding period --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 33894257d8..b9330d0219 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 @@ -108,7 +108,7 @@ # Python Embedding # ---------------- # -# This use case uses one Python script to read forecast, observation, and climatology data +# This use case uses one Python script to read forecast, observation, and climatology data. # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/read_rtofs_ghrsst_woa.py # From 1b57c46632cf65a20a97d80a9e8c1aaec1b24265 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 9 Dec 2024 15:55:43 -0700 Subject: [PATCH 47/51] Adding colon --- .../GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 b9330d0219..417bb52333 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 @@ -146,7 +146,7 @@ # # Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. # Output for thisIce use case will be found in directory 20210503 (relative to **OUTPUT_BASE**) -# and will contain the following files: +# and will contain the following files:: # # * grid_stat_SST_000000L_20210503_000000V.stat # * grid_stat_SST_000000L_20210503_000000V_cnt.txt From 22124b501d1f4b596706f472da88c9bd984b9bf8 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 9 Dec 2024 16:02:32 -0700 Subject: [PATCH 48/51] Added period --- .../GridStat_fcstRTOFS_obsOSTIA_iceCover.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 674af80b4e..a85cf4465f 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 @@ -61,7 +61,7 @@ # ------------------ # # This use case utilizes the METplus GridStat wrapper to generate a -# command to run the MET tool GridStat with Python Embedding for the specified user hemispheres +# command to run the MET tool GridStat with Python Embedding for the specified user hemispheres. ############################################################################## # METplus Workflow From 63d68386547cc756157111ee46fabfe253b3447e Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 9 Dec 2024 16:03:45 -0700 Subject: [PATCH 49/51] Added period --- .../PointStat_fcstGFS_obsNDBC_WaveHeight.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 8b596a1d89..efd0a07616 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 @@ -40,7 +40,7 @@ # ------------------ # # This use case calls ASCII2NC to read in ASCII buoy files and -# then PointStat for verification against GFS model data +# then PointStat for verification against GFS model data. ############################################################################## # METplus Workflow From aad98cbd7d1765ee8d620e9a1597adf469ba033b Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 9 Dec 2024 16:14:09 -0700 Subject: [PATCH 50/51] Added period --- .../precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 30f83f4d3e..e479345827 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 @@ -82,7 +82,7 @@ # --------------------- # # METplus first loads all of the configurations found in parm/metplus_config, -# then it loads any configuration files passed to METplus via the command line +# then it loads any configuration files passed to METplus via the command line. # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf From 8459b623a0f37379a60a362e6b6a0889c528f2b9 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Mon, 9 Dec 2024 16:47:47 -0700 Subject: [PATCH 51/51] typos and more Co-authored-by: Julie Prestopnik --- .../GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py | 2 +- .../PlotDataPlane_obsHYCOM_coordTripolar.py | 2 +- .../PointStat_fcstGFS_obsASCAT_satelliteWinds.py | 1 - .../PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py | 1 - .../PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py | 2 +- .../medium_range/UserScript_fcstGEFS_Difficulty_Index.py | 2 +- .../s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.py | 1 - .../short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.py | 2 +- 8 files changed, 5 insertions(+), 8 deletions(-) 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 e3979a628a..e92136e84b 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 @@ -109,7 +109,7 @@ # Python Embedding # ---------------- # -# This use case uses one Python script to read forecast and observation data +# This use case uses one Python script to read forecast and observation data. # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py # 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 f34aebacf7..dffb3b90dd 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 @@ -95,7 +95,7 @@ # Python Embedding # ---------------- # -# This use case uses one Python script to read input data, passed through two times +# This use case uses one Python script to read input data, passed through two times. # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar/read_tripolar_grid.py # 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 d60c7ed6bb..41e888251c 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 @@ -92,7 +92,6 @@ # an end time in the same format, a message type to code the variables as (currently set for SATWND), and # a variable name to read in. Currently the script puts the same station ID to each observation, but there is space # in the code describing an alternate method that may be improved upon to allow different sattellites to have their own station IDs. -# The location of the code is parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py # 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 2924a718bd..e0371ad2fa 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 @@ -95,7 +95,6 @@ # This use case calls the read_satData.py script to read and pass to PointStat the user-requested variable. # The script needs 3 inputs in the following order: an input file, a variable field to extract, # and where the data came from, passed as JASON (JASON-3), SARAL, or SENTINEL (Sentinel-6a). -# The location of the code is parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry/read_satData.py # 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 2b919664b8..4849d56ed9 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 @@ -113,7 +113,7 @@ # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on -# `Python embedding `_ +# `Python embedding `_. ############################################################################## # User Scripting 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 36daa550c4..5f1c8a4189 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 @@ -134,7 +134,7 @@ # User Scripting # -------------- # -# User Scripting is not used in this use case. +# [UPDATE CONTENT] ############################################################################## # Running METplus 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 5ac9f51768..185ec85f9c 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 @@ -97,7 +97,6 @@ # # The MJO-ENSO driver script orchestrates the calculation of the MaKE and MaKI indices and # the generation of a text file and a plot for the indices: -# parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py: # # .. dropdown:: parm/use_cases/model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO/mjo_enso_driver.py # 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 165f8f6689..2dcacdf0d9 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 @@ -92,7 +92,7 @@ # Python Embedding # ---------------- # -# This use case uses a Python embedding script to read input data +# This use case uses a Python embedding script to read input data. # # .. dropdown:: parm/use_cases/model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect/read_ascii_storm.py #