Skip to content

Commit

Permalink
Per #1135, add documentation for fcst/obs_init/valid_inc/exc options …
Browse files Browse the repository at this point in the history
…to the STAT-Analysis chapter. Also, clarify the description for the existing options.
  • Loading branch information
JohnHalleyGotway committed Feb 24, 2021
1 parent 4f72981 commit 6c859ab
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions met/docs/Users_Guide/stat-analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -303,25 +303,39 @@ ___________________
fcst_valid_beg = "";
fcst_valid_end = "";
fcst_valid_hour = "";
fcst_valid_inc = [];
fcst_valid_exc = [];
fcst_valid_hour = [];
obs_valid_beg = "";
obs_valid_end = ""
obs_valid_hour = "";
obs_valid_end = "";
obs_valid_inc = [];
obs_valid_exc = [];
obs_valid_hour = [];
The user may filter data based on its valid time. The fcst/obs_valid_beg and fcst/obs_valid_end options are strings in YYYYMMDD[_HH[MMSS]] format which define retention time windows for all analyses to be performed. The analyses are performed on all data whose valid time falls within these windows. If left as empty strings, no valid time window filtering is applied.

The user may specify the beginning, ending, and instantaneous valid times in YYYYMMDD[_HH[MMSS]] format to be used for all analyses performed. If multiple valid times fall within the valid time window, the analyses will be performed on their union. These selections may be further refined by using the **"-fcst_valid_beg", "-fcst_valid_end", "-obs_valid_beg", "-obs_valid_end", “fcst_valid_hour"** and **"-obs_valid_hour"** options within the job command line.
The fcst/obs_valid_hour options are arrays of strings in HH format which define the valid hour(s) of the data to be used. If specified, only data whose valid hour appears in the list of hours is used. The fcst/obs_valid_inc/exc options are arrays of strings in YYYYMMDD[_HH[MMSS]] format which explicitly define the valid times for data to be included or excluded from all analyses.

These selections may be further refined by using the **"-fcst_valid_beg", "-fcst_valid_end", "-fcst_valid_inc", "-fcst_valid_exc", "-fcst_valid_hour", "-obs_valid_beg", "-obs_valid_end", "-obs_valid_inc", "-obs_valid_exc",** and **"-obs_valid_hour"** options within the job command line.

___________________

.. code-block:: none
fcst_init_beg = "";
fcst_init_end = "";
fcst_init_hour = "";
fcst_init_inc = [];
fcst_init_exc = [];
fcst_init_hour = [];
obs_init_beg = "";
obs_init_end = "";
obs_init_hour = "";
obs_init_inc = [];
obs_init_exc = [];
obs_init_hour = [];
The user may specify the beginning, ending, or exact model initialization times in YYYYMMDD[_HH[MMSS]] format to be used for all analyses performed. If multiple init times fall within the init time window, the analyses will be performed on their union. These selections may be further refined by using the **"-fcst_init_beg", "-fcst_init_end", "-obs_init_beg", "-obs_init_end", fcst_init_hour"** and **"-obs_init_hour"** options within the job command line.
These time filtering options are the same as described above but applied to initialization times rather than valid times. These selections may be further refined by using the **"-fcst_init_beg", "-fcst_init_end", "-fcst_init_inc", "-fcst_init_exc", "-fcst_init_hour"," "-obs_init_beg", "-obs_init_end", fcst_init_hour"** and **"-obs_init_hour"** options within the job command line.

___________________

Expand Down

0 comments on commit 6c859ab

Please sign in to comment.