Skip to content

Commit

Permalink
per #2283, add documentation about INCLUDE_TIMES and using days of th…
Browse files Browse the repository at this point in the history
…e week for [SKIP/INCLUDE]_TIMES
  • Loading branch information
georgemccabe committed Aug 16, 2023
1 parent c5a538e commit 6ef7f6d
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/Users_Guide/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4927,7 +4927,20 @@ METplus Configuration Glossary
Result:
Skip even hours: 0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22

| *Used by:* GridStat, SeriesAnalysis
Value:
SKIP_TIMES = "%a:Mon,Wed,Fri"

Result:
Skip days that fall on Monday, Wednesday, or Friday

| *Used by:* All
INCLUDE_TIMES
List of valid times to process. All times that do not match the include
rules will be skipped. Can be used in addition to or in place of
:term:`SKIP_TIMES`. See :term:`SKIP_TIMES` for formatting information.

| *Used by:* All
TC_GEN_TRACK_INPUT_DIR
Directory containing the track data used by TCGen. This variable is optional because you can specify the full path to track data using :term:`TC_GEN_TRACK_INPUT_TEMPLATE`.
Expand Down
34 changes: 34 additions & 0 deletions docs/Users_Guide/systemconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -940,6 +940,40 @@ All other wrappers in the
:term:`PROCESS_LIST` will skip the 31st day of each month. Note that the
SKIP_TIMES values are not applied to GridStat in this case.

Support for skipping times by the day of the week was added in v6.0.0.

Example 7::

[config]
SKIP_TIMES = "%a:Sun,Tue,Thu,Sat"

This will skip all days of the week except for Monday, Wednesday, and Friday.

Also added in v6.0.0 is the ability to specify times to include with
:term:`INCLUDE_TIMES`. If this is set, then any times that do not match the
include rules will be skipped.

Example 8::

[config]
INCLUDE_TIMES = "%a:Mon,Wed,Fri"

This will skip all days of the week except for Monday, Wednesday, and Friday.

:term:`INCLUDE_TIMES` also supported wrapper-specific versions, e.g.
GRID_STAT_INCLUDE_TIMES.

INCLUDE_TIMES and SKIP_TIMES can be used together.

Example 9::

[config]
INCLUDE_TIMES = "%a:Mon,Wed,Fri"
SKIP_TIMES = "%d:1"

This will only process times that land on Monday, Wednesday, and Friday
except the 1st of the month.

Realtime Looping
^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 6ef7f6d

Please sign in to comment.