Skip to content

Commit

Permalink
Updating MTD conv radius/thresh description (#2566)
Browse files Browse the repository at this point in the history
* Updating MTD conv radius/thresh description

* Update glossary.rst

* Update docs/Users_Guide/glossary.rst

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Update docs/Users_Guide/glossary.rst

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

---------

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
  • Loading branch information
CPKalb and georgemccabe authored Apr 26, 2024
1 parent 869c11d commit 828068c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 30 deletions.
32 changes: 6 additions & 26 deletions docs/Users_Guide/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1329,14 +1329,14 @@ METplus Configuration Glossary
| *Used by:* MODE
FCST_MTD_CONV_RADIUS
Comma separated list of convolution radius values used by mode-TD for forecast files. A corresponding variable exists for observation data called :term:`OBS_MTD_CONV_RADIUS`.
A single integer to specify the convolution radius used by mode-TD for forecast files. A corresponding variable exists for observation data called :term:`OBS_MTD_CONV_RADIUS`.

| *Used by:*
| *Used by:* MTD
FCST_MTD_CONV_THRESH
Comma separated list of convolution threshold values used by mode-TD for forecast files. A corresponding variable exists for observation data called :term:`OBS_MTD_CONV_THRESH`.
A single convolution threshold used by mode-TD for forecast files. A corresponding variable exists for observation data called :term:`OBS_MTD_CONV_THRESH`.

| *Used by:*
| *Used by:* MTD
FCST_MTD_FILE_WINDOW_BEGIN
See :term:`OBS_MTD_FILE_WINDOW_BEGIN`
Expand Down Expand Up @@ -2587,17 +2587,12 @@ METplus Configuration Glossary
| *Used by:* MTD
MTD_CONV_RADIUS
Comma separated list of convolution radius values used by mode-TD for both forecast and observation files. Has the same behavior as setting :term:`FCST_MTD_CONV_RADIUS` and :term:`OBS_MTD_CONV_RADIUS` to the same value.
A single integer to specify the convolution radius used by mode-TD for both forecast and observation files. Has the same behavior as setting :term:`FCST_MTD_CONV_RADIUS` and :term:`OBS_MTD_CONV_RADIUS` to the same value.

| *Used by:* MTD
MTD_CONV_THRESH
Comma separated list of convolution threshold values used by mode-TD for both forecast and observation files. Has the same behavior as setting :term:`FCST_MTD_CONV_THRESH` and :term:`OBS_MTD_CONV_THRESH` to the same value.

| *Used by:* MTD
MTD_FCST_CONV_RADIUS
Comma separated list of convolution radius values used by mode-TD for forecast files.
A single convolution threshold used by mode-TD for both forecast and observation files. Has the same behavior as setting :term:`FCST_MTD_CONV_THRESH` and :term:`OBS_MTD_CONV_THRESH` to the same value.

| *Used by:* MTD
Expand All @@ -2619,21 +2614,6 @@ METplus Configuration Glossary

| *Used by:* MTD
MTD_FCST_CONV_THRESH
Comma separated list of convolution threshold values used by mode-TD for forecast files.

| *Used by:* MTD
MTD_OBS_CONV_RADIUS
Comma separated list of convolution radius values used by mode-TD for observation files.

| *Used by:* MTD
MTD_OBS_CONV_THRESH
Comma separated list of convolution threshold values used by mode-TD for observation files.

| *Used by:* MTD
MTD_OUT_DIR
.. warning:: **DEPRECATED:** Please use :term:`MTD_OUTPUT_DIR`.

Expand Down
10 changes: 6 additions & 4 deletions docs/Users_Guide/wrappers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5104,6 +5104,8 @@ METplus Configuration
| :term:`FCST_MTD_CONV_THRESH`
| :term:`OBS_MTD_CONV_RADIUS`
| :term:`OBS_MTD_CONV_THRESH`
| :term:`MTD_CONV_RADIUS`
| :term:`MTD_CONV_THRESH`
| :term:`MTD_CUSTOM_LOOP_LIST`
| :term:`MTD_SKIP_IF_OUTPUT_EXISTS`
| :term:`MTD_DESC`
Expand Down Expand Up @@ -5267,7 +5269,7 @@ ${METPLUS_FCST_CONV_RADIUS}

* - METplus Config(s)
- MET Config File
* - :term:`MTD_FCST_CONV_RADIUS`
* - :term:`FCST_MTD_CONV_RADIUS`
- fcst.conv_radius

${METPLUS_FCST_CONV_THRESH}
Expand All @@ -5279,7 +5281,7 @@ ${METPLUS_FCST_CONV_THRESH}

* - METplus Config(s)
- MET Config File
* - :term:`MTD_FCST_CONV_THRESH`
* - :term:`FCST_MTD_CONV_THRESH`
- fcst.conv_thresh

${METPLUS_OBS_FILE_TYPE}
Expand Down Expand Up @@ -5323,7 +5325,7 @@ ${METPLUS_OBS_CONV_RADIUS}

* - METplus Config(s)
- MET Config File
* - :term:`MTD_OBS_CONV_RADIUS`
* - :term:`OBS_MTD_CONV_RADIUS`
- obs.conv_radius

${METPLUS_OBS_CONV_THRESH}
Expand All @@ -5335,7 +5337,7 @@ ${METPLUS_OBS_CONV_THRESH}

* - METplus Config(s)
- MET Config File
* - :term:`MTD_OBS_CONV_THRESH`
* - :term:`OBS_MTD_CONV_THRESH`
- obs.conv_thresh

${METPLUS_MIN_VOLUME}
Expand Down

0 comments on commit 828068c

Please sign in to comment.