Skip to content

Commit

Permalink
update out-of-date doc info about grouping forecast leads (#2109)
Browse files Browse the repository at this point in the history
  • Loading branch information
georgemccabe committed Apr 6, 2023
1 parent 19bc960 commit 3b17c92
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/Users_Guide/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2330,7 +2330,7 @@ METplus Configuration Glossary
| *Used by:* SeriesAnalysis
LEAD_SEQ_<n>_LABEL
Required when SERIES_BY_LEAD_GROUP_FCSTS=True. Specify the label of the corresponding bin of series by lead results.
Required if :term:`LEAD_SEQ_\<n>` is set. Specify the label of the nth forecast lead group .

| *Used by:* SeriesAnalysis
Expand Down Expand Up @@ -3742,7 +3742,7 @@ METplus Configuration Glossary
.. warning:: **DEPRECATED:** Please use :term:`LEAD_SEQ_\<n>` and :term:`SERIES_ANALYSIS_RUNTIME_FREQ` instead.

SERIES_BY_LEAD_GROUP_FCSTS
.. warning:: **DEPRECATED:** Please use :term:`SERIES_ANALYSIS_GROUP_FCSTS` instead.
.. warning:: **DEPRECATED:** Please use :term:`LEAD_SEQ_\<n>` and :term:`SERIES_ANALYSIS_RUNTIME_FREQ` instead.

SERIES_CI
.. warning:: **DEPRECATED:** Please use :term:`TCMPR_PLOTTER_SERIES_CI` instead.
Expand Down
7 changes: 2 additions & 5 deletions docs/Users_Guide/systemconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -771,11 +771,8 @@ is equivalent to setting::
[config]
LEAD_SEQ = 0, 3, 6, 9, 12

Grouping forecast leads is possible as well using a special version of
the :term:`LEAD_SEQ` variable for the
**SeriesByLead Wrapper Only**.
If :term:`SERIES_BY_LEAD_GROUP_FCSTS` = True, then groups of
forecast leads can be defined to be evaluated together.
Groups of forecast leads can be defined to be evaluated together.
**This applies to the SeriesAnalysis wrapper only**.
Any number of these groups can be defined by setting
configuration variables LEAD_SEQ_1, LEAD_SEQ_2, ..., :term:`LEAD_SEQ_\<n\>`.
The value can be defined with a
Expand Down

0 comments on commit 3b17c92

Please sign in to comment.