add documentation for config variables that are newly supported to al…

…low file window range to be specified separately for mask and input files
dtcenter · Dec 13, 2024 · 0a13906 · 0a13906
1 parent ef5bb97
commit 0a13906
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 2 deletions.
diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst
@@ -4362,12 +4362,58 @@ METplus Configuration Glossary
      | *Used by:* GenVxMask
 
    GEN_VX_MASK_FILE_WINDOW_BEGIN
-     Used to control the lower bound of the window around the valid time to determine if a GenVxMask input file should be used for processing. Overrides :term:`FILE_WINDOW_BEGIN`. See 'Use Windows to Find Valid Files' section for more information.
+     Used to control the lower bound of the window around the valid time to determine if a GenVxMask input file should
+     be used for processing. Applies to both the input file and the mask file(s).
+     Set :term:`GEN_VX_MASK_OBS_FILE_WINDOW_BEGIN` or
+     :term:`GEN_VX_MASK_MASK_FILE_WINDOW_BEGIN` to set them separately.
+     Overrides :term:`FILE_WINDOW_BEGIN`.
+     See 'Use Windows to Find Valid Files' section for more information.
 
      | *Used by:* GenVxMask
 
    GEN_VX_MASK_FILE_WINDOW_END
-     Used to control the upper bound of the window around the valid time to determine if an GenVxMask input file should be used for processing. Overrides :term:`FILE_WINDOW_BEGIN`. See 'Use Windows to Find Valid Files' section for more information.
+     Used to control the upper bound of the window around the valid time to determine if an GenVxMask input file should
+     be used for processing. Applies to both the input file and the mask file(s).
+     Set :term:`GEN_VX_MASK_OBS_FILE_WINDOW_END` or
+     :term:`GEN_VX_MASK_MASK_FILE_WINDOW_END` to set them separately.
+     Overrides :term:`FILE_WINDOW_END`.
+     See 'Use Windows to Find Valid Files' section for more information.
+
+     | *Used by:* GenVxMask
+
+   GEN_VX_MASK_OBS_FILE_WINDOW_BEGIN
+     Used to control the lower bound of the window around the valid time to determine if a GenVxMask input file should
+     be used for processing. Applies to the input file only (not the mask file).
+     Set :term:`GEN_VX_MASK_FILE_WINDOW_BEGIN` to control both input and mask.
+     Overrides :term:`FILE_WINDOW_BEGIN`.
+     See 'Use Windows to Find Valid Files' section for more information.
+
+     | *Used by:* GenVxMask
+
+   GEN_VX_MASK_OBS_FILE_WINDOW_END
+     Used to control the upper bound of the window around the valid time to determine if a GenVxMask input file should
+     be used for processing. Applies to the input file only (not the mask file).
+     Set :term:`GEN_VX_MASK_FILE_WINDOW_END` to control both input and mask.
+     Overrides :term:`FILE_WINDOW_END`.
+     See 'Use Windows to Find Valid Files' section for more information.
+
+     | *Used by:* GenVxMask
+
+   GEN_VX_MASK_MASK_FILE_WINDOW_BEGIN
+     Used to control the lower bound of the window around the valid time to determine if a GenVxMask mask file should
+     be used for processing. Applies to the mask file only (not the input file).
+     Set :term:`GEN_VX_MASK_FILE_WINDOW_BEGIN` to control both input and mask.
+     Overrides :term:`FILE_WINDOW_BEGIN`.
+     See 'Use Windows to Find Valid Files' section for more information.
+
+     | *Used by:* GenVxMask
+
+   GEN_VX_MASK_MASK_FILE_WINDOW_END
+     Used to control the upper bound of the window around the valid time to determine if a GenVxMask mask file should
+     be used for processing. Applies to the mask file only (not the input file).
+     Set :term:`GEN_VX_MASK_FILE_WINDOW_END` to control both input and mask.
+     Overrides :term:`FILE_WINDOW_END`.
+     See 'Use Windows to Find Valid Files' section for more information.
 
      | *Used by:* GenVxMask
 

diff --git a/docs/Users_Guide/wrappers.rst b/docs/Users_Guide/wrappers.rst
@@ -1749,6 +1749,10 @@ Configuration
 | :term:`GEN_VX_MASK_CUSTOM_LOOP_LIST`
 | :term:`GEN_VX_MASK_FILE_WINDOW_BEGIN`
 | :term:`GEN_VX_MASK_FILE_WINDOW_END`
+| :term:`GEN_VX_MASK_OBS_FILE_WINDOW_BEGIN`
+| :term:`GEN_VX_MASK_OBS_FILE_WINDOW_END`
+| :term:`GEN_VX_MASK_MASK_FILE_WINDOW_BEGIN`
+| :term:`GEN_VX_MASK_MASK_FILE_WINDOW_END`
 | :term:`GEN_VX_MASK_SKIP_VALID_TIMES`
 | :term:`GEN_VX_MASK_INC_VALID_TIMES`
 | :term:`GEN_VX_MASK_SKIP_INIT_TIMES`