Feature #1489 plot point obs wrapper (#1753)

dtcenter · Aug 22, 2022 · 68ff502 · 68ff502
1 parent 91c1a65
commit 68ff502
Show file tree

Hide file tree

Showing 14 changed files with 1,537 additions and 9 deletions.
diff --git a/.github/parm/use_case_groups.json b/.github/parm/use_case_groups.json
@@ -1,19 +1,14 @@
 [
   {
     "category": "met_tool_wrapper",
-    "index_list": "0-29",
+    "index_list": "0-29,59-61",
     "run": false
   },
   {
     "category": "met_tool_wrapper",
     "index_list": "30-58",
     "run": false
   },
-  {
-    "category": "met_tool_wrapper",
-    "index_list": "59-60",
-    "run": false
-  },
   {
     "category": "air_quality_and_comp",
     "index_list": "0",

diff --git a/docs/Contributors_Guide/add_use_case.rst b/docs/Contributors_Guide/add_use_case.rst
@@ -638,7 +638,8 @@ created and tested.
 Trigger Input Data Ingest
 -------------------------
 
-If working in the *dtcenter/METplus repository*, please skip this step.
+**IF WORKING IN THE *dtcenter/METplus REPOSITORY*, PLEASE SKIP THIS STEP.**
+
 If working in a forked METplus repository, the newly added input data will not
 become available for the tests unless it is triggered from the dtcenter
 repository. A METplus developer will need to run the following steps. Please
@@ -952,7 +953,7 @@ Copy data from the feature directory into the next version directory
 
 **CONDITION 2:** MET Tool Wrapper Use Cases::
 
-    from_directory=${METPLUS_DATA_TARFILE_DIR}/${METPLUS_FEATURE_BRANCH}/met_test
+    from_directory=${METPLUS_DATA_TARFILE_DIR}/${METPLUS_FEATURE_BRANCH}/met_test/new
     echo $from_directory
     ls $from_directory
 

diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst
@@ -9653,3 +9653,258 @@ METplus Configuration Glossary
      Specify the value for 'match_points' in the MET configuration file for TCPairs.
 
      | *Used by:* TCPairs
+
+   PLOT_POINT_OBS_MSG_TYP
+     Specify the value for 'msg_typ' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_SID_INC
+     Specify the value for 'sid_inc' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_SID_EXC
+     Specify the value for 'sid_exc' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_OBS_VAR
+     Specify the value for 'obs_var' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_OBS_GC
+     Specify the value for 'obs_gc' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_OBS_QUALITY
+     Specify the value for 'obs_quality' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_VALID_BEG
+     Specify the value for 'valid_beg' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_VALID_END
+     Specify the value for 'valid_end' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_LAT_THRESH
+     Specify the value for 'lat_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_LON_THRESH
+     Specify the value for 'lon_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_ELV_THRESH
+     Specify the value for 'elv_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_HGT_THRESH
+     Specify the value for 'hgt_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_PRS_THRESH
+     Specify the value for 'prs_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_OBS_THRESH
+     Specify the value for 'obs_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_CENSOR_THRESH
+     Specify the value for 'censor_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_CENSOR_VAL
+     Specify the value for 'censor_val' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_DOTSIZE
+     Specify the value for 'dotsize' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_LINE_COLOR
+     Specify the value for 'line_color' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_LINE_WIDTH
+     Specify the value for 'line_width' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_FILL_COLOR
+     Specify the value for 'fill_color' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_INPUT_DIR
+     Directory containing input point observation data for PlotPointObs.
+     This variable is optional because you can specify the full path to the
+     input file(s) using :term:`PLOT_POINT_OBS_INPUT_TEMPLATE`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_INPUT_TEMPLATE
+     Filename template of the input point observation file(s) for PlotPointObs.
+     See also :term:`PLOT_POINT_OBS_INPUT_DIR`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_INPUT_DIR
+     Directory containing input grid data for PlotPointObs.
+     This variable is optional because you can specify the full path to the
+     input file using :term:`PLOT_POINT_OBS_GRID_INPUT_TEMPLATE`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_INPUT_TEMPLATE
+     Filename template of the input grid file for PlotPointObs.
+     See also :term:`PLOT_POINT_OBS_GRID_INPUT_DIR`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_OUTPUT_DIR
+     Directory containing output generated by PlotPointObs.
+     This variable is optional because you can specify the full path to the
+     output file using :term:`PLOT_POINT_OBS_OUTPUT_TEMPLATE`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_OUTPUT_TEMPLATE
+     Filename template of the output generated by PlotPointObs.
+     See also :term:`PLOT_POINT_OBS_OUTPUT_DIR`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_TITLE
+     Sets the title for the output plot generated by PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   LOG_PLOT_POINT_OBS_VERBOSITY
+     Overrides the log verbosity for plot_point_obs only. If not set,
+     the verbosity level is controlled by :term:`LOG_MET_VERBOSITY`.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_FILL_PLOT_INFO_FLAG
+     Specify the value for 'fill_plot_info.flag' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_FILL_PLOT_INFO_COLOR_TABLE
+     Specify the value for 'fill_plot_info.color_table' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_FILL_PLOT_INFO_PLOT_MIN
+     Specify the value for 'fill_plot_info.plot_min' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_FILL_PLOT_INFO_PLOT_MAX
+     Specify the value for 'fill_plot_info.plot_max' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_FILL_PLOT_INFO_COLORBAR_FLAG
+     Specify the value for 'fill_plot_info.colorbar_flag' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_FIELD
+     Specify the value for 'grid_data.field' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_REGRID_TO_GRID
+     Specify the value for 'grid_data.regrid.to_grid' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_REGRID_METHOD
+     Specify the value for 'grid_data.regrid.method' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_REGRID_WIDTH
+     Specify the value for 'grid_data.regrid.width' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_REGRID_VLD_THRESH
+     Specify the value for 'grid_data.regrid.vld_thresh' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_REGRID_SHAPE
+     Specify the value for 'grid_data.regrid.shape' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_GRID_PLOT_INFO_COLOR_TABLE
+     Specify the value for 'grid_data.grid_plot_info.color_table' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_GRID_PLOT_INFO_PLOT_MIN
+     Specify the value for 'grid_data.grid_plot_info.plot_min' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_GRID_PLOT_INFO_PLOT_MAX
+     Specify the value for 'grid_data.grid_plot_info.plot_max' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_GRID_DATA_GRID_PLOT_INFO_COLORBAR_FLAG
+     Specify the value for 'grid_data.grid_plot_info.colorbar_flag' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_POINT_DATA
+     Specify the value for 'point_data' in the MET configuration file for PlotPointObs.
+
+     | *Used by:* PlotPointObs
+
+   PLOT_POINT_OBS_SKIP_IF_OUTPUT_EXISTS
+     If True, do not run plot_point_obs if output file already exists.
+     Set to False to overwrite files.
+
+     | *Used by:*  PlotPointObs
+
+   PLOT_POINT_OBS_RUNTIME_FREQ
+     Frequency to run PlotPointObs. See :ref:`Runtime_Freq` for more information.
+
+     | *Used by:*  PlotPointObs
+
+   PLOT_POINT_OBS_MET_CONFIG_OVERRIDES
+     Override any variables in the MET configuration file that are not
+     supported by the wrapper. This should be set to the full variable name
+     and value that you want to override, including the equal sign and the
+     ending semi-colon. The value is directly appended to the end of the
+     wrapped MET config file.
+
+     Example:
+     PLOT_POINT_OBS_MET_CONFIG_OVERRIDES = desc = "override_desc"; model = "override_model";
+
+     See :ref:`Overriding Unsupported MET config file settings<met-config-overrides>` for more information
+
+     | *Used by:* PlotPointObs
diff --git a/docs/Users_Guide/quicksearch.rst b/docs/Users_Guide/quicksearch.rst
@@ -27,6 +27,7 @@ Use Cases by MET Tool:
    | `PCPCombine <../search.html?q=PCPCombineToolUseCase&check_keywords=yes&area=default>`_
    | `Point2Grid <../search.html?q=Point2GridToolUseCase&check_keywords=yes&area=default>`_
    | `PlotDataPlane <../search.html?q=PlotDataPlaneToolUseCase&check_keywords=yes&area=default>`_
+   | `PlotPointObs <../search.html?q=PlotPointObsToolUseCase&check_keywords=yes&area=default>`_
    | `PointStat <../search.html?q=PointStatToolUseCase&check_keywords=yes&area=default>`_
    | `RegridDataPlane <../search.html?q=RegridDataPlaneToolUseCase&check_keywords=yes&area=default>`_
    | `SeriesAnalysis <../search.html?q=SeriesAnalysisUseCase&check_keywords=yes&area=default>`_
@@ -53,6 +54,7 @@ Use Cases by MET Tool:
    | **PCPCombine**: *PCPCombineToolUseCase*
    | **Point2Grid**: *Point2GridToolUseCase*
    | **PlotDataPlane**: *PlotDataPlaneToolUseCase*
+   | **PlotPointObs**: *PlotPointObsToolUseCase*
    | **PointStat**: *PointStatToolUseCase*
    | **RegridDataPlane**: *RegridDataPlaneToolUseCase*
    | **SeriesAnalysis**: *SeriesAnalysisUseCase*