Feature 617 gfdl etc (#1121)

.github/parm/use_case_groups.json

@@ -4,6 +4,11 @@
     "index_list": "0-55",
     "run": false
   },
+  {
+    "category": "met_tool_wrapper",
+    "index_list": "56-57",
+    "run": false
+  },
   {
     "category": "air_quality_and_comp",
     "index_list": "0",

docs/Users_Guide/glossary.rst

@@ -7872,6 +7872,12 @@ METplus Configuration Glossary
 
      | *Used by:* StatAnalysis
 
+   GFDL_TRACKER_KEEP_INTERMEDIATE
+     If True, do not scrub intermediate files created by the tracker. Useful
+     for debugging issues.
+
+     | *Used by:* GFDLTracker
+
    TCMPR_PLOTTER_READ_ALL_FILES
      If True, pass in input directory set by :term:`TCMPR_PLOTTER_TCMPR_DATA_DIR`
      to the script. If False, a list of all files that end with .tcst in the input

docs/Users_Guide/installation.rst

@@ -267,6 +267,8 @@ the process and allow MET to be built with just a few manual changes.
 External Components
 ===================
 
+.. _external-components-gfdl-tracker:
+
 GFDL Tracker
 ------------
 

docs/Users_Guide/quicksearch.rst

@@ -129,6 +129,7 @@ Use Cases by METplus Feature:
    | `Diagnostics <../search.html?q=DiagnosticsUseCase&check_keywords=yes&area=default>`_
    | `Feature Relative  <../search.html?q=FeatureRelativeUseCase&check_keywords=yes&area=default>`_
    | `GempakToCF <../search.html?q=GempakToCFToolUseCase&check_keywords=yes&area=default>`_
+   | `GFDLTracker <../search.html?q=GFDLTrackerToolUseCase&check_keywords=yes&area=default>`_
    | `Looping by Month or Year <../search.html?q=LoopByMonthFeatureUseCase&check_keywords=yes&area=default>`_
    | `List Expansion (using begin_end_incr syntax) <../search.html?q=ListExpansionFeatureUseCase&check_keywords=yes&area=default>`_
    | `Masking for Regions of Interest <../search.html?q=MaskingFeatureUseCase&check_keywords=yes&area=default>`_
@@ -155,6 +156,7 @@ Use Cases by METplus Feature:
    | **Diagnostics**: *DiagnosticsUseCase*
    | **Feature Relative**: *FeatureRelativeUseCase*
    | **GempakToCF**: *GempakToCFToolUseCase*
+   | **GFDL Tracker**: *GFDLTrackerToolUseCase*
    | **Looping by Month or Year**: *LoopByMonthFeatureUseCase*
    | **List Expansion (using begin_end_incr syntax)**: *ListExpansionFeatureUseCase*
    | **Masking for Regions of Interest**: *MaskingFeatureUseCase*

docs/Users_Guide/systemconfiguration.rst

@@ -522,6 +522,8 @@ given use case.
 More information about the variables set in the use case configuration files
 can be found in the :ref:`common_config_variables` section.
 
+.. _running-metplus:
+
 Running METplus
 ===============
 

docs/Users_Guide/wrappers.rst

@@ -986,7 +986,13 @@ Description
 
 Used to call the GFDL Tracker applications to objectively analyze forecast data
 to provide an estimate of the vortex center position (latitude and longitude),
-and track the storm for the duration of the forecast.
+and track the storm for the duration of the forecast. The wrapper copies files
+and uses symbolic links to ensure that input files are named and located in
+the correct place so that the tracker can read them. The wrapper also generates
+index files and other inputs that are required to run the tool and substitutes
+values into template configuration files that are read by the tracker.
+Relevant output files are renamed based on user configuration.
+See :ref:`external-components-gfdl-tracker` for more information.
 
 METplus Configuration
 ---------------------
@@ -1088,6 +1094,7 @@ METplus Configuration
 | :term:`GFDL_TRACKER_USER_WANTS_TO_TRACK_ZETA850`
 | :term:`GFDL_TRACKER_VERBOSE_VERB`
 | :term:`GFDL_TRACKER_VERBOSE_VERB_G2`
+| :term:`GFDL_TRACKER_KEEP_INTERMEDIATE`
 
 .. _gfdl_tracker-nml-conf:
 

docs/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_ETC.py

@@ -0,0 +1,106 @@
+"""
+GFDLTracker: Extra Tropical Cyclone Use Case
+============================================
+
+met_tool_wrapper/GFDLTracker/GFDLTracker_ETC.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+#
+# Setup and run GFDL Tracker applications to track extra tropical cyclones.
+# See :ref:`external-components-gfdl-tracker` for more information.
+# A genesis vitals file is read into the tracker. This file contains
+# information on storms that were tracked in the previous 2 runs so that
+# additional data is attributed to the correct storm.
+#
+
+##############################################################################
+# Datasets
+# --------
+#
+# | **Forecast:** GFS
+#
+# | **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.
+#
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case utilizes the METplus GFDLTracker wrapper to generate a command
+# to run the GFDL Tracker Fortran applications.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# GFDLTracker is the only tool called in this example.
+# It processes the following run time:
+#
+# | **Init:** 2021-07-13 00Z
+# | **Forecast lead**: All available leads (0 - 198 hour)
+# |
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all of the configuration files found in parm/metplus_config,
+# then it loads any configuration files passed to METplus via the command line
+# with the -c option, i.e. -c parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_ETC.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_ETC.conf
+
+##############################################################################
+# GFDL Tracker Configuration
+# --------------------------
+#
+# METplus replaces values in the template configuration files read by the
+# tracker based on user settings in the METplus configuration file.
+#
+# **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!**
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/template.nml
+
+##############################################################################
+# Running METplus
+# ---------------
+#
+# This use case can be run by passing in the conf file to the run script::
+#
+#    run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_ETC.conf
+#
+# See the :ref:`running-metplus` section of the User's Guide for more
+# information on how to run use cases.
+#
+
+##############################################################################
+# Expected Output
+# ---------------
+#
+# A successful run will output the following both to the screen and to the logfile::
+#
+#   INFO: METplus has successfully finished running.
+#
+# 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 gfdl_tracker/etc (relative to **OUTPUT_BASE**)
+# and will contain the following file:
+#
+# * gfs.2021071300.etc.txt
+# * input.202107130000.nml
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * GFDLTrackerToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#

docs/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.py

@@ -0,0 +1,106 @@
+"""
+GFDLTracker: TC Genesis Use Case
+================================
+
+met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+#
+# Setup and run GFDL Tracker applications to track cyclones in TC genesis mode.
+# See :ref:`external-components-gfdl-tracker` for more information.
+# A genesis vitals file is read into the tracker. This file contains
+# information on storms that were tracked in the previous 2 runs so that
+# additional data is attributed to the correct storm.
+#
+
+##############################################################################
+# Datasets
+# --------
+#
+# | **Forecast:** GFS
+#
+# | **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.
+#
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case utilizes the METplus GFDLTracker wrapper to generate a command
+# to run the GFDL Tracker Fortran applications.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# GFDLTracker is the only tool called in this example.
+# It processes the following run time:
+#
+# | **Init:** 2021-07-13 00Z
+# | **Forecast lead**: All available leads (0 - 198 hour)
+# |
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all of the configuration files found in parm/metplus_config,
+# then it loads any configuration files passed to METplus via the command line
+# with the -c option, i.e. -c parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf
+
+##############################################################################
+# GFDL Tracker Configuration
+# --------------------------
+#
+# METplus replaces values in the template configuration files read by the
+# tracker based on user settings in the METplus configuration file.
+#
+# **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!**
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/template.nml
+
+##############################################################################
+# Running METplus
+# ---------------
+#
+# This use case can be run by passing in the conf file to the run script::
+#
+#    run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf
+#
+# See the :ref:`running-metplus` section of the User's Guide for more
+# information on how to run use cases.
+#
+
+##############################################################################
+# Expected Output
+# ---------------
+#
+# A successful run will output the following both to the screen and to the logfile::
+#
+#   INFO: METplus has successfully finished running.
+#
+# 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 gfdl_tracker/genesis (relative to **OUTPUT_BASE**)
+# and will contain the following file:
+#
+# * gfs.2021071300.genesis.txt
+# * input.202107130000.nml
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * GFDLTrackerToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#

docs/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_TC.py

@@ -0,0 +1,103 @@
+"""
+GFDLTracker: Tropical Cyclone Use Case
+======================================
+
+met_tool_wrapper/GFDLTracker/GFDLTracker_TC.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+#
+# Setup and run GFDL Tracker applications to track tropical cyclones.
+# See :ref:`external-components-gfdl-tracker` for more information.
+#
+
+##############################################################################
+# Datasets
+# --------
+#
+# | **Forecast:** HWRF
+#
+# | **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.
+#
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case utilizes the METplus GFDLTracker wrapper to generate a command
+# to run the GFDL Tracker Fortran applications.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# GFDLTracker is the only tool called in this example.
+# It processes the following run time:
+#
+# | **Init:** 2016-09-06 00Z
+# | **Forecast lead**: All available leads (0 - 126 hour)
+# |
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all of the configuration files found in parm/metplus_config,
+# then it loads any configuration files passed to METplus via the command line
+# with the -c option, i.e. -c parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_TC.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_TC.conf
+
+##############################################################################
+# GFDL Tracker Configuration
+# --------------------------
+#
+# METplus replaces values in the template configuration files read by the
+# tracker based on user settings in the METplus configuration file.
+#
+# **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!**
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/template.nml
+
+##############################################################################
+# Running METplus
+# ---------------
+#
+# This use case can be run by passing in the conf file to the run script::
+#
+#    run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_TC.conf
+#
+# See the :ref:`running-metplus` section of the User's Guide for more
+# information on how to run use cases.
+#
+
+##############################################################################
+# Expected Output
+# ---------------
+#
+# A successful run will output the following both to the screen and to the logfile::
+#
+#   INFO: METplus has successfully finished running.
+#
+# 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 gfdl_tracker/tc (relative to **OUTPUT_BASE**)
+# and will contain the following file:
+#
+# * hwrf.2016090600.track.txt
+# * input.201609060000.nml
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * GFDLTrackerToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#