Skip to content

Commit

Permalink
Per #1870, update the User's Guide with the new config options. Docum…
Browse files Browse the repository at this point in the history
…ent valid_inc/valid_exc in the common TC config section and add write_valid to the TC-Pairs chapter.
  • Loading branch information
JohnHalleyGotway committed Aug 5, 2021
1 parent 69de807 commit d471bbf
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 23 deletions.
37 changes: 23 additions & 14 deletions met/docs/Users_Guide/config_options_tc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ or exclude (exc). Tracks whose initial time meets the specified
criteria will be used. An empty string indicates that all times
should be used.

In TC-Stat, the **-init_beg**, **-init_end**, **init_inc** and **-int_exc** job command options can be used to further refine these selections.

For example:

| init_beg = "20100101";
Expand All @@ -107,26 +109,34 @@ For example:
init_inc = [];
init_exc = [];
.. _valid_beg end inc exc_1:

.. _valid_beg, valid_end_1:

:ref:`valid_beg, valid_end <valid_beg, valid_end_1>`

Specify a model valid time window in YYYYMMDD[_HH[MMSS]] format.
Tracks for which all valid times fall within the time window will be used.
An empty string indicates that all times should be used.
ref:`valid_beg, valid_end, valid_inc, valid_exc <valid_beg end inc exc_1>`

Specify a model valid time window YYYYMMDD[_HH[MMSS]] format or provide a
list of specific valid times to include (inc) or exclude (exc). If a time
window is specified, only tracks for which all points are contained within
the window will be used. If valid times to include or exclude are specified,
tracks will be subset down to the points which meet that criteria. Empty
begin/end time strings and empty include/exclude lists indicate that all
valid times should be used.

In TC-Stat, the **-valid_beg**, **-valid_end**, **valid_inc** and **-valid_exc** job command options can be used to further refine these selections.

For example:

| valid_beg = "20100101";
| valid_end = "20101231";
|
| valid_end = "20101231_12";
| valid_inc = [ "20101231_06" ];
| valid_exc = [ "20101231_00" ];
|
.. code-block:: none
valid_beg = "";
valid_end = "";
valid_inc = [];
valid_exc = [];
.. _init_hour_1:

Expand Down Expand Up @@ -422,7 +432,6 @@ by basin or sub-basin. Note that if your model data and best track do not
use the same basin identifier conventions, using an empty list for this
parameter will result in missed matches.


.. code-block:: none
basin_map = [
Expand Down Expand Up @@ -481,9 +490,9 @@ For example:
valid_inc = [];
valid_exc = [];
.. _ini valid_hour lead req:
.. _init valid_hour lead req:

:ref:`ini_hour, valid_hour, lead, lead_req <ini valid_hour lead req>`
:ref:`init_hour, valid_hour, lead, lead_req <init valid_hour lead req>`

Stratify by the initialization and valid hours and lead time.
Specify a comma-separated list of initialization hours,
Expand Down
10 changes: 10 additions & 0 deletions met/docs/Users_Guide/tc-pairs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ ____________________
init_exc = [];
valid_beg = "";
valid_end = "";
valid_inc = [];
valid_exc = [];
init_hour = [];
init_mask = [];
lead_req = [];
Expand All @@ -118,6 +120,14 @@ The **model** variable contains a list of comma-separated models to be used. Eac

____________________

.. code-block:: none
write_valid = [ "20101231_06" ];
The **write_valid** entry specifies a comma-separated list of valid time strings in YYYYMMDD[_HH[MMSS]] format for which output should be written. An empty list indicates that data for all valid times should be written. This option may be useful when verifying track forecasts in realtime. If evaluating performance for a single valid time, this option can limit the output to that time and skip output for earlier track points.

____________________

.. code-block:: none
check_dup = FALSE;
Expand Down
11 changes: 2 additions & 9 deletions met/docs/Users_Guide/tc-stat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ _________________________
init_exc = [];
valid_beg = "";
valid_end = "";
valid_inc = [];
valid_exc = [];
init_hour = [];
lead_req = [];
init_mask = [];
Expand All @@ -161,15 +163,6 @@ The **amodel** and **bmodel** fields stratify by the amodel and bmodel columns b

_________________________

.. code-block:: none
valid_inc = [];
valid_exc = [];
The **valid_inc** and **valid_exc** fields stratify by valid times, based on a comma-separated list of specific valid times to include (inc) or exclude (exc). Time strings are defined by YYYYMMDD[_HH[MMSS]]. Using the **-valid_inc** and **-valid_exc** options within the job command lines may further refine these selections.

_________________________

.. code-block:: none
valid_hour = [];
Expand Down

0 comments on commit d471bbf

Please sign in to comment.