Skip to content

Commit

Permalink
Feature #1626 TCDiag Wrapper (#2201)
Browse files Browse the repository at this point in the history
  • Loading branch information
@georgemccabe
georgemccabe authored Jun 6, 2023
1 parent ff35877 commit e1585a2
Show file tree
Hide file tree
Showing 15 changed files with 2,086 additions and 3 deletions.
274 changes: 273 additions & 1 deletion docs/Users_Guide/glossary.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,13 +394,18 @@ METplus Configuration Glossary

| *Used by:* RegridDataPlane
LOG_TC_DIAG_VERBOSITY
Overrides the log verbosity for TCDiag only. If not set, the verbosity level is controlled by :term:`LOG_MET_VERBOSITY`.

| *Used by:* TCDiag
LOG_TC_PAIRS_VERBOSITY
Overrides the log verbosity for TCPairs only. If not set, the verbosity level is controlled by :term:`LOG_MET_VERBOSITY`.

| *Used by:* TCPairs
LOG_TC_RMW_VERBOSITY
Overrides the log verbosity for TCRMW only. If not set, the verbosity level is controlled by :term:`LOG_MET_VERBOSITY`.
Overrides the log verbosity for TCRMW only. If not set, the verbosity level is controlled by :term:`LOG_MET_VERBOSITY`.

| *Used by:* TCRMW
Expand Down Expand Up @@ -499,6 +504,12 @@ METplus Configuration Glossary

| *Used by:* TCRMW
TC_DIAG_CONFIG_FILE
Path to configuration file read by tc_diag.
If unset, parm/met_config/TCDiagConfig_wrapped will be used.

| *Used by:* TCDiag
ASCII2NC_INPUT_FORMAT
Optional string to specify the format of the input data. Valid options are "met_point", "little_r", "surfrad", "wwsis", "aeronet", "aeronetv2", or "aeronetv3."

Expand Down Expand Up @@ -4705,6 +4716,11 @@ METplus Configuration Glossary

| *Used by:* TCRMW
TC_DIAG_INPUT_DATATYPE
Specify the data type of the input directory for input files used with the MET tc_diag tool. Used to set the 'file_type' value of the data dictionary in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_RMW_INPUT_DIR
Directory containing input data to TCRMW. This variable is optional because you can specify the full path to the input files using :term:`TC_RMW_INPUT_TEMPLATE`.

Expand Down Expand Up @@ -10389,6 +10405,262 @@ METplus Configuration Glossary

| *Used by:* TCRMW
TC_DIAG_INPUT_DIR
Directory containing input data to TCDiag. This variable is optional because you can specify the full path to the input files using :term:`TC_DIAG_INPUT_TEMPLATE`.

| *Used by:* TCDiag
TC_DIAG_INPUT_TEMPLATE
Filename template of the input data used by TCDiag. See also :term:`TC_DIAG_INPUT_DIR`.

| *Used by:* TCDiag
TC_DIAG_DECK_INPUT_DIR
Directory containing ADECK input data to TCDiag. This variable is optional because you can specify the full path to the input files using :term:`TC_DIAG_DECK_TEMPLATE`.

| *Used by:* TCDiag
TC_DIAG_DECK_TEMPLATE
Filename template of the ADECK input data used by TCDiag. See also :term:`TC_DIAG_DECK_INPUT_DIR`.

| *Used by:* TCDiag
TC_DIAG_OUTPUT_DIR
Directory to write output data from TCDiag. This variable is optional because you can specify the full path to the output file using :term:`TC_DIAG_OUTPUT_TEMPLATE`.

| *Used by:* TCDiag
TC_DIAG_OUTPUT_TEMPLATE
Filename template of write the output data generated by TCDiag. See also :term:`TC_DIAG_OUTPUT_DIR`.

| *Used by:* TCDiag
TC_DIAG_INPUT_FILE_LIST
Specifies an explicit path to a file list file to pass into tc_diag.
If set, :term:`TC_DIAG_INPUT_TEMPLATE` and :term:`TC_DIAG_INPUT_DIR`
are ignored.

| *Used by:* TCDiag
TC_DIAG_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:
TC_DIAG_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:* TCDiag
TC_DIAG_SKIP_IF_OUTPUT_EXISTS
If True, do not run app if output file already exists. Set to False to overwrite files.

| *Used by:* TCDiag
TC_DIAG_MODEL
Specify the value for 'model' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_STORM_ID
Specify the value for 'storm_id' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_BASIN
Specify the value for 'basin' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_CYCLONE
Specify the value for 'cyclone' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_INIT_INCLUDE
Specify the value for 'init_inc' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_VALID_BEG
Specify the value for 'valid_beg' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_VALID_END
Specify the value for 'valid_end' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_VALID_INCLUDE
Specify the value for 'valid_inc' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_VALID_EXCLUDE
Specify the value for 'valid_exc' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_VALID_HOUR
Specify the value for 'valid_hour' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DIAG_SCRIPT
Specify the value for 'diag_script' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DOMAIN_INFO<n>_DOMAIN
Specify the value for the nth 'domain_info.domain' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DOMAIN_INFO<n>_N_RANGE
Specify the value for the nth 'domain_info.n_range' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DOMAIN_INFO<n>_N_AZIMUTH
Specify the value for the nth 'domain_info.n_azimuth' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DOMAIN_INFO<n>_DELTA_RANGE_KM
Specify the value for the nth 'domain_info.delta_range_km' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DOMAIN_INFO<n>_DIAG_SCRIPT
Specify the value for the nth 'domain_info.diag_script' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_CENSOR_THRESH
Specify the value for 'censor_thresh' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_CENSOR_VAL
Specify the value for 'censor_val' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_CONVERT
Specify the value for 'convert' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DATA_DOMAIN
Specify the value for 'data.domain' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_DATA_LEVEL
Specify the value for 'data.level' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_METHOD
Specify the value for 'regrid.method' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_WIDTH
Specify the value for 'regrid.width' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_VLD_THRESH
Specify the value for 'regrid.vld_thresh' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_SHAPE
Specify the value for 'regrid.shape' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_CENSOR_THRESH
Specify the value for 'regrid.censor_thresh' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_CENSOR_VAL
Specify the value for 'regrid.censor_val' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_REGRID_CONVERT
Specify the value for 'regrid.convert' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_COMPUTE_TANGENTIAL_AND_RADIAL_WINDS
Specify the value for 'compute_tangential_and_radial_winds' in the MET configuration file for TCDiag .

| *Used by:* TCDiag
TC_DIAG_U_WIND_FIELD_NAME
Specify the value for 'u_wind_field_name' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_V_WIND_FIELD_NAME
Specify the value for 'v_wind_field_name' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_TANGENTIAL_VELOCITY_FIELD_NAME
Specify the value for 'tangential_velocity_field_name' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_TANGENTIAL_VELOCITY_LONG_FIELD_NAME
Specify the value for 'tangential_velocity_long_field_name' in the MET configuration file for TCDiag .

| *Used by:* TCDiag
TC_DIAG_RADIAL_VELOCITY_FIELD_NAME
Specify the value for 'radial_velocity_field_name' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_RADIAL_VELOCITY_LONG_FIELD_NAME
Specify the value for 'radial_velocity_long_field_name' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_VORTEX_REMOVAL
Specify the value for 'vortex_removal' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_NC_RNG_AZI_FLAG
Specify the value for 'nc_rng_azi_flag' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_NC_DIAG_FLAG
Specify the value for 'nc_diag_flag' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_CIRA_DIAG_FLAG
Specify the value for 'cira_diag_flag' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
TC_DIAG_OUTPUT_PREFIX
Specify the value for 'output_prefix' in the MET configuration file for TCDiag.

| *Used by:* TCDiag
MODE_MULTIVAR_INTENSITY
Specify the value for 'multivar_intensity' in the MET configuration file for MODE.

Expand Down
2 changes: 2 additions & 0 deletions docs/Users_Guide/quicksearch.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Use Cases by MET Tool:
| `RegridDataPlane <../search.html?q=RegridDataPlaneToolUseCase&check_keywords=yes&area=default>`_
| `SeriesAnalysis <../search.html?q=SeriesAnalysisUseCase&check_keywords=yes&area=default>`_
| `StatAnalysis <../search.html?q=StatAnalysisToolUseCase&check_keywords=yes&area=default>`_
| `TCDiag <../search.html?q=TCDiagToolUseCase&check_keywords=yes&area=default>`_
| `TCMPRPlotter <../search.html?q=TCMPRPlotterUseCase&check_keywords=yes&area=default>`_
| `TCGen <../search.html?q=TCGenToolUseCase&check_keywords=yes&area=default>`_
| `TCPairs <../search.html?q=TCPairsToolUseCase&check_keywords=yes&area=default>`_
Expand Down Expand Up @@ -59,6 +60,7 @@ Use Cases by MET Tool:
| **RegridDataPlane**: *RegridDataPlaneToolUseCase*
| **SeriesAnalysis**: *SeriesAnalysisUseCase*
| **StatAnalysis**: *StatAnalysisToolUseCase*
| **TCDiag**: *TCDiagToolUseCase*
| **TCMPRPlotter**: *TCMPRPlotterUseCase*
| **TCGen**: *TCGenToolUseCase*
| **TCPairs**: *TCPairsToolUseCase*
Expand Down
Loading

0 comments on commit e1585a2

Please sign in to comment.