Update develop-ref after #876

docs/Users_Guide/glossary.rst

@@ -4917,11 +4917,6 @@ METplus Configuration Glossary
 
      | *Used by:*  TCGen
 
-   TC_GEN_OPS_HIT_TDIFF
-     Specify the value of ops_hit_tdiff in the MET configuration file.
-
-     | *Used by:*  TCGen
-
    TC_GEN_DISCARD_INIT_POST_GENESIS_FLAG
      Specify the value of discard_init_post_genesis_flag in the MET configuration file.
 
@@ -6211,3 +6206,28 @@ METplus Configuration Glossary
      Specify the value for 'init_str_exc_val' in the MET configuration file for TCStat.
 
      | *Used by:* TCStat
+
+   TC_GEN_GENESIS_MATCH_POINT_TO_TRACK
+     Specify the value for 'genesis_match_point_to_track' in the MET configuration file for TCGen.
+
+     | *Used by:* TCGen
+
+   TC_GEN_GENESIS_MATCH_WINDOW_BEG
+     Specify the value for 'genesis_match_window.beg' in the MET configuration file for TCGen.
+
+     | *Used by:* TCGen
+
+   TC_GEN_GENESIS_MATCH_WINDOW_END
+     Specify the value for 'genesis_match_window.end' in the MET configuration file for TCGen.
+
+     | *Used by:* TCGen
+
+   TC_GEN_OPS_HIT_WINDOW_BEG
+     Specify the value for 'ops_hit_window.beg' in the MET configuration file for TCGen.
+
+     | *Used by:* TCGen
+
+   TC_GEN_OPS_HIT_WINDOW_END
+     Specify the value for 'ops_hit_window.end' in the MET configuration file for TCGen.
+
+     | *Used by:* TCGen

docs/Users_Guide/wrappers.rst

@@ -3693,10 +3693,14 @@ Configuration
 | :term:`TC_GEN_BASIN_MASK`
 | :term:`TC_GEN_DLAND_THRESH`
 | :term:`TC_GEN_GENESIS_MATCH_RADIUS`
+| :term:`TC_GEN_GENESIS_MATCH_POINT_TO_TRACK`
+| :term:`TC_GEN_GENESIS_MATCH_WINDOW_BEG`
+| :term:`TC_GEN_GENESIS_MATCH_WINDOW_END`
 | :term:`TC_GEN_DEV_HIT_RADIUS`
 | :term:`TC_GEN_DEV_HIT_WINDOW_BEGIN`
 | :term:`TC_GEN_DEV_HIT_WINDOW_END`
-| :term:`TC_GEN_OPS_HIT_TDIFF`
+| :term:`TC_GEN_OPS_HIT_WINDOW_BEG`
+| :term:`TC_GEN_OPS_HIT_WINDOW_END`
 | :term:`TC_GEN_DISCARD_INIT_POST_GENESIS_FLAG`
 | :term:`TC_GEN_DEV_METHOD_FLAG`
 | :term:`TC_GEN_OPS_METHOD_FLAG`
@@ -4033,6 +4037,30 @@ Below the file contents are descriptions of each environment variable referenced
    * - :term:`TC_GEN_GENESIS_MATCH_RADIUS`
      - genesis_match_radius
 
+**${METPLUS_GENESIS_MATCH_POINT_TO_TRACK}**
+
+.. list-table::
+   :widths: 5 5
+   :header-rows: 0
+
+   * - METplus Config(s)
+     - MET Config File
+   * - :term:`TC_GEN_GENESIS_MATCH_POINT_TO_TRACK`
+     - genesis_match_point_to_track
+
+**${METPLUS_GENESIS_MATCH_WINDOW_DICT}**
+
+.. list-table::
+   :widths: 5 5
+   :header-rows: 0
+
+   * - METplus Config(s)
+     - MET Config File
+   * - :term:`TC_GEN_GENESIS_MATCH_WINDOW_BEG`
+     - genesis_match_window.beg
+   * - :term:`TC_GEN_GENESIS_MATCH_WINDOW_END`
+     - genesis_match_window.end
+
 **${METPLUS_DEV_HIT_RADIUS}**
 
 .. list-table::
@@ -4044,16 +4072,18 @@ Below the file contents are descriptions of each environment variable referenced
    * - :term:`TC_GEN_DEV_HIT_RADIUS`
      - dev_hit_radius
 
-**${METPLUS_OPS_HIT_TDIFF}**
+**${METPLUS_OPS_HIT_WINDOW_DICT}**
 
 .. list-table::
    :widths: 5 5
    :header-rows: 0
 
    * - METplus Config(s)
      - MET Config File
-   * - :term:`TC_GEN_OPS_HIT_TDIFF`
-     - ops_hit_tdiff
+   * - :term:`TC_GEN_OPS_HIT_WINDOW_BEG`
+     - ops_hit_window.beg
+   * - :term:`TC_GEN_OPS_HIT_WINDOW_END`
+     - ops_hit_window.end
 
 **${METPLUS_DISCARD_INIT_POST_GENESIS_FLAG}**
 

docs/use_cases/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_OPC.py

@@ -9,10 +9,10 @@
 # Scientific Objective
 # --------------------
 #
-# Once this method is complete, a forecast and reference track analysis file
-# for the valid date of interest (YYYYMMDDHH) will have been created {OUTPUT_BASE}/decks, 
-# forecast and reference tracks paired up {OUTPUT_BASE}/tc_pairs and global storm tracks 
-# for the valid date of interest will be plotted {OUTPUT_BASE}/cyclone (PlateCaree projection)
+# Once this method is complete, a user-created extra TC track file
+# for the valid date of interest (YYYYMMDDHH) will have been created, 
+# paired up by TCPairs, and global storm tracks 
+# for the valid date of interest will be plotted by CyclonePlotter (PlateCaree projection)
 
 ##############################################################################
 # Datasets
@@ -44,17 +44,17 @@
 # METplus Components
 # ------------------
 #
-# This use case utilizes the METplus TCPairs wrapper to search for
-# files that are valid at a given run time and generate a command to run
-# the MET tool tc_pairs. It then uses the CyclonePlotter wrapper to create
-# a global plot of storm tracks for the desired day of interest (YYYYMMDDHH)
+# This use case utilizes Python user script-created output files that are accessible via the TCPairs wrapper.
+# Due to the nature of the source file (already tracked extra TCs), the TCPairs wrapper is passed the "Adeck" file for each storm twice:
+# once as the adeck or forecast file, and once as the bdeck or analysis file. Essentially, TCPairs is matching a forecast to itself.
+# It then uses the CyclonePlotter wrapper to create a global plot of storm tracks for the desired day of interest (YYYYMMDDHH).
 
 ##############################################################################
 # METplus Workflow
 # ----------------
 #
 # TCPairs is the first tool called in this example. It processes the following
-# run times:
+# run times for each storm file:
 #
 # | **Init/Valid:** 2020100700
 # |
@@ -95,7 +95,11 @@
 # 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.
+# Because the source file already contains "analysis" tracks for the extra TCs,
+# this Python script only needs to output storm tracks that have a valid time matching
+# 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_OPC/extract_opc_decks.py
 #
@@ -142,11 +146,12 @@
 # Output for this use case will be found in **tc_pairs/201412** (relative to **OUTPUT_BASE**)
 # and will contain the following files:
 #
-# * decks/adeck.2020100700.dat
-# * decks/bdeck.2020100700.dat
-# * tc_pairs/tc_pairs.2020100700.dat
+# * decks/adeck/adeck.2020100700.xxxx.dat
+# * tc_pairs/tc_pairs.2020100700.xxxx.tcst
 # * cyclone/20201007.png
 # * cyclone/20201007.txt
+#
+# where "xxxx" is the unique four digit storm identifier for TCPairs wrapper to use.
 
 ##############################################################################
 # Keywords

internal_tests/pytests/tc_gen/test_tc_gen_wrapper.py

@@ -142,9 +142,6 @@
           'TC_GEN_DEV_HIT_WINDOW_END': '30'},
          {'METPLUS_DEV_HIT_WINDOW_DICT': 'dev_hit_window = {beg = -30;end = 30;}'}),
 
-        ({'TC_GEN_OPS_HIT_TDIFF': '49'},
-         {'METPLUS_OPS_HIT_TDIFF': 'ops_hit_tdiff = 49;'}),
-
         ({'TC_GEN_DISCARD_INIT_POST_GENESIS_FLAG': 'False'},
          {'METPLUS_DISCARD_INIT_POST_GENESIS_FLAG': 'discard_init_post_genesis_flag = FALSE;'}),
 
@@ -239,6 +236,34 @@
         ({'TC_GEN_NC_PAIRS_GRID': 'G004'},
          {'METPLUS_NC_PAIRS_GRID': 'nc_pairs_grid = "G004";'}),
 
+        ({'TC_GEN_GENESIS_MATCH_POINT_TO_TRACK': 'False', },
+         {'METPLUS_GENESIS_MATCH_POINT_TO_TRACK': 'genesis_match_point_to_track = FALSE;'}),
+
+        ({'TC_GEN_GENESIS_MATCH_WINDOW_BEG': '-1', },
+         {
+             'METPLUS_GENESIS_MATCH_WINDOW_DICT': 'genesis_match_window = {beg = -1;}'}),
+
+        ({'TC_GEN_GENESIS_MATCH_WINDOW_END': '2', },
+         {
+             'METPLUS_GENESIS_MATCH_WINDOW_DICT': 'genesis_match_window = {end = 2;}'}),
+
+        ({
+             'TC_GEN_GENESIS_MATCH_WINDOW_BEG': '-2',
+             'TC_GEN_GENESIS_MATCH_WINDOW_END': '1',
+         },
+         {'METPLUS_GENESIS_MATCH_WINDOW_DICT': 'genesis_match_window = {beg = -2;end = 1;}'}),
+        ({'TC_GEN_OPS_HIT_WINDOW_BEG': '1', },
+         {'METPLUS_OPS_HIT_WINDOW_DICT': 'ops_hit_window = {beg = 1;}'}),
+
+        ({'TC_GEN_OPS_HIT_WINDOW_END': '47', },
+         {'METPLUS_OPS_HIT_WINDOW_DICT': 'ops_hit_window = {end = 47;}'}),
+
+        ({
+             'TC_GEN_OPS_HIT_WINDOW_BEG': '1',
+             'TC_GEN_OPS_HIT_WINDOW_END': '47',
+         },
+         {'METPLUS_OPS_HIT_WINDOW_DICT': 'ops_hit_window = {beg = 1;end = 47;}'}),
+
     ]
 )
 def test_tc_gen(metplus_config, config_overrides, env_var_values):

metplus/wrappers/tc_gen_wrapper.py

@@ -53,7 +53,7 @@ class TCGenWrapper(CommandBuilder):
         'METPLUS_GENESIS_MATCH_RADIUS',
         'METPLUS_DEV_HIT_RADIUS',
         'METPLUS_DEV_HIT_WINDOW_DICT',
-        'METPLUS_OPS_HIT_TDIFF',
+        'METPLUS_OPS_HIT_WINDOW_DICT',
         'METPLUS_DISCARD_INIT_POST_GENESIS_FLAG',
         'METPLUS_DEV_METHOD_FLAG',
         'METPLUS_OPS_METHOD_FLAG',
@@ -65,6 +65,8 @@ class TCGenWrapper(CommandBuilder):
         'METPLUS_DLAND_FILE',
         'METPLUS_BASIN_FILE',
         'METPLUS_NC_PAIRS_GRID',
+        'METPLUS_GENESIS_MATCH_POINT_TO_TRACK',
+        'METPLUS_GENESIS_MATCH_WINDOW_DICT',
     ]
 
     OUTPUT_FLAGS = ['fho',
@@ -210,9 +212,7 @@ def create_c_dict(self):
                             data_type='int',
                             metplus_configs=['TC_GEN_DEV_HIT_RADIUS'])
         self.handle_dev_hit_window()
-        self.add_met_config(name='ops_hit_tdiff',
-                            data_type='int',
-                            metplus_configs=['TC_GEN_OPS_HIT_TDIFF'])
+        self.handle_ops_hit_window()
         self.add_met_config(name='discard_init_post_genesis_flag',
                             data_type='bool',
                             metplus_configs=[
@@ -246,6 +246,12 @@ def create_c_dict(self):
         self.add_met_config(name='nc_pairs_grid',
                             data_type='string',
                             metplus_configs=['TC_GEN_NC_PAIRS_GRID'])
+        self.add_met_config(
+            name='genesis_match_point_to_track',
+            data_type='bool',
+            metplus_configs=['TC_GEN_GENESIS_MATCH_POINT_TO_TRACK']
+        )
+        self.handle_genesis_match_window()
 
         # get INPUT_TIME_DICT values since wrapper only runs
         # once (doesn't look over time)
@@ -291,6 +297,38 @@ def handle_dev_hit_window(self):
         )
         self.handle_met_config_dict(dict_name, dict_items)
 
+    def handle_ops_hit_window(self):
+        dict_name = 'ops_hit_window'
+        dict_items = []
+        dict_items.append(
+            self.get_met_config(name='beg',
+                       data_type='int',
+                       metplus_configs=['TC_GEN_OPS_HIT_WINDOW_BEGIN',
+                                        'TC_GEN_OPS_HIT_WINDOW_BEG',])
+        )
+        dict_items.append(
+            self.get_met_config(name='end',
+                       data_type='int',
+                       metplus_configs=['TC_GEN_OPS_HIT_WINDOW_END',])
+        )
+        self.handle_met_config_dict(dict_name, dict_items)
+
+    def handle_genesis_match_window(self):
+        dict_name = 'genesis_match_window'
+        dict_items = []
+        dict_items.append(
+            self.get_met_config(name='beg',
+                       data_type='int',
+                       metplus_configs=['TC_GEN_GENESIS_MATCH_WINDOW_BEGIN',
+                                        'TC_GEN_GENESIS_MATCH_WINDOW_BEG',])
+        )
+        dict_items.append(
+            self.get_met_config(name='end',
+                       data_type='int',
+                       metplus_configs=['TC_GEN_GENESIS_MATCH_WINDOW_END',])
+        )
+        self.handle_met_config_dict(dict_name, dict_items)
+
     def handle_fcst_genesis(self):
         dict_name = 'fcst_genesis'
         dict_items = []

parm/met_config/TCGenConfig_wrapped

@@ -166,12 +166,26 @@ ${METPLUS_DLAND_THRESH}
 //
 ////////////////////////////////////////////////////////////////////////////////
 
+//
+// Genesis matching logic. Compare the forecast genesis point to all points in
+// the Best track (TRUE) or the single Best track genesis point (FALSE).
+//
+//genesis_match_point_to_track =
+${METPLUS_GENESIS_MATCH_POINT_TO_TRACK}
+
 //
 // Radius in km to search for a matching genesis event
 //
 // genesis_match_radius =
 ${METPLUS_GENESIS_MATCH_RADIUS}
 
+//
+// Time window in hours, relative to the model genesis time, to search for a
+// matching Best track point
+//
+//genesis_match_window = {
+${METPLUS_GENESIS_MATCH_WINDOW_DICT}
+
 //
 // Radius in km for a development scoring method hit
 //
@@ -184,12 +198,11 @@ ${METPLUS_DEV_HIT_RADIUS}
 // dev_hit_window =
 ${METPLUS_DEV_HIT_WINDOW_DICT}
 
+// Time window in hours for the Best track genesis minus model initialization
+// time difference for an operational scoring method hit
 //
-// Maximum Best track genesis minus model initialization time difference for an
-// operational scoring method hit
-//
-// ops_hit_tdiff =
-${METPLUS_OPS_HIT_TDIFF}
+//ops_hit_window = {
+${METPLUS_OPS_HIT_WINDOW_DICT}
 
 //
 // Discard genesis forecasts for initializations at or after the matching

parm/use_cases/met_tool_wrapper/TCGen/TCGen.conf

@@ -104,13 +104,19 @@ TC_GEN_DLAND_THRESH = NA
 
 TC_GEN_GENESIS_MATCH_RADIUS = 500
 
+#TC_GEN_GENESIS_MATCH_POINT_TO_TRACK = True
+
+#TC_GEN_GENESIS_MATCH_WINDOW_BEG = 0
+#TC_GEN_GENESIS_MATCH_WINDOW_END = 0
+
+#TC_GEN_OPS_HIT_WINDOW_BEG = 0
+#TC_GEN_OPS_HIT_WINDOW_END = 48
+
 TC_GEN_DEV_HIT_RADIUS = 500
 
 TC_GEN_DEV_HIT_WINDOW_BEGIN = -24
 TC_GEN_DEV_HIT_WINDOW_END = 24
 
-TC_GEN_OPS_HIT_TDIFF = 48
-
 TC_GEN_DISCARD_INIT_POST_GENESIS_FLAG = True
 
 TC_GEN_DEV_METHOD_FLAG = True