Skip to content

Commit

Permalink
fixing file #650
Browse files Browse the repository at this point in the history
  • Loading branch information
lisagoodrich committed Apr 5, 2022
2 parents 0d623f3 + 654c6a4 commit 9e0d2a6
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions docs/Users_Guide/systemconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ Config Best Practices / Recommendations

* If configuring METplus Wrappers in a common location for multiple users:

* It is recommended that the values for **MET_INSTALL_DIR** and
**INPUT_BASE** are changed to valid values in the
:ref:`default_configuration_file`.
* It is recommended that the values for **MET_INSTALL_DIR** and
**INPUT_BASE** are changed to valid values in the
:ref:`default_configuration_file`.

* It is recommended to leave **OUTPUT_BASE** set to the default value in
the :ref:`default_configuration_file`. This prevents multiple users from
accidentally writing to the same output directory.
* It is recommended to leave **OUTPUT_BASE** set to the default value in
the :ref:`default_configuration_file`. This prevents multiple users from
accidentally writing to the same output directory.

* If obtaining the METplus Wrappers with the intention of updating
the same local directory as new versions become available,
Expand Down Expand Up @@ -737,7 +737,7 @@ then three times will be processed:
2. Initialized on 2019-02-01 at 00Z / valid on 2019-02-01 at 06Z
3. Initialized on 2019-02-01 at 00Z / valid on 2019-02-01 at 09Z

You can also define :term:`LEAD_SEQ` using a special notation for many
The user can also define :term:`LEAD_SEQ` using a special notation for many
forecast leads. The notation is **begin_end_incr(b,e,i)** where b = the
first lead value, e = the last lead value (inclusive), and
i = the increment between leads. For example::
Expand All @@ -755,9 +755,9 @@ 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.
You can define any number of these groups by setting
Any number of these groups can be defined by setting
configuration variables LEAD_SEQ_1, LEAD_SEQ_2, ..., :term:`LEAD_SEQ_\<n\>`.
You can define the value with a
The value can be defined with a
comma-separated list of integers (currently only hours are supported here)
or using the special begin_end_incr(b,e,i) notation described just
above. Each :term:`LEAD_SEQ_\<n\>` must have a corresponding
Expand Down Expand Up @@ -868,7 +868,7 @@ Example 3::
This will skip every 30th and 31st day **and** every 3rd month.


You can use **begin_end_incr(b,e,i)** syntax to define a range of times to
**begin_end_incr(b,e,i)** syntax can be used to define a range of times to
skip.

b = begin value, e = end value,
Expand All @@ -886,7 +886,7 @@ This is equivalent to::
[config]
SKIP_TIMES = "%H:0,2,4,6,8,10,12,14,16,18,20,22"

You can also specify multiple strftime directives in a single time format.
Multiple strftime directives can be specified in a single time format.

Example 5::

Expand Down Expand Up @@ -924,15 +924,15 @@ and the METplus Wrappers is run with::
[config]
VALID_END = {now?fmt=%Y%m%d%H}

then the value of :term:`VALID_END` will be set to 2019042608. You can also
use {today} to substitute the
current YYYYMMDD, i.e. 20190426. You cannot change the formatting for
the 'today' keyword.
then the value of :term:`VALID_END` will be set to 2019042608. {today}
can also be used to substitute the
current YYYYMMDD, i.e. 20190426. The formatting for
the 'today' keyword cannot be changed..

Shift Keyword
"""""""""""""

You can use the 'shift' keyword to shift the current time by any number of
The 'shift' keyword can be used to shift the current time by any number of
seconds. For example, if the METplus Wrappers are run at the
same clock time with::

Expand All @@ -956,7 +956,7 @@ METplus Wrappers will process the following valid times:
Truncate Keyword
""""""""""""""""

You may want to configure the METplus Wrappers to process at 00Z, 06Z, 12Z,
The user may want to configure the METplus Wrappers to process at 00Z, 06Z, 12Z,
and 18Z of a given day instead of 02Z, 08Z, 14Z, and 20Z. Having to adjust
the shift amount differently if running at 08Z or 09Z to get the
times to line up would be tedious. Instead, use the 'truncate' keyword.
Expand Down Expand Up @@ -1632,8 +1632,8 @@ Shifting Times in Filename Templates
Users can use the 'shift' keyword to adjust the time referenced in the
filename template relative to the run time. For example, if the input files
used contained data from 01Z on the date specified in the filename to 01Z on
the following day. In this example, for a run at 00Z you want to use the
file from the previous day and for the 01Z to 23Z runs you want to use the
the following day. In this example, for a run at 00Z use the
file from the previous day and for the 01Z to 23Z runs, use the
file that corresponds to the current day. Here is an example::

[config]
Expand All @@ -1651,7 +1651,7 @@ Using Windows to find Valid Files

The [FCST/OBS]_FILE_WINDOW_[BEGIN/END] configuration variables can be used
if the time information in the input data does not exactly line up with the
run time but you still want to process the data. The default value of the
run time but the user still wants to process the data. The default value of the
file window begin and end variables are both 0 seconds. If both values are
set to 0, METplus Wrappers will require that a file matching the template
with the exact time requested exists. If either value is non-zero, METplus
Expand Down Expand Up @@ -1704,7 +1704,7 @@ Wrapper Specific Windows
^^^^^^^^^^^^^^^^^^^^^^^^

A user may need to specify a different window on a wrapper-by-wrapper basis.
If this is the case, you can override the file window values for each
If this is the case, the user can override the file window values for each
wrapper. Consider the following configuration::

[config]
Expand All @@ -1728,7 +1728,7 @@ Runtime Frequency

Some wrappers have an option to specify how frequently to process data. It can
be run once to process all of the available files in the desired time range,
or it can be configured to run over different intervals. This allows you to
or it can be configured to run over different intervals. This allows the user to
aggregate the output in a variety of ways. The wrappers that support this
functionality (along with the configuration variable that controls the setting)
include:
Expand Down Expand Up @@ -1933,12 +1933,12 @@ supports METplus configuration variables that control the MET tool
configuration file settings.
**The METplus wrappers provide a special "wrapped" MET configuration file that
references environment variables that are set by the wrappers based on the
values set in the METplus configuration files. YOU SHOULD NOT SET ANY OF THESE
ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT
values set in the METplus configuration files. THE USER SHOULD NOT SET ANY OF
THESE ENVIRONMENT VARIABLES! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT
CALLS THE MET TOOLS!**

If there is a setting in the MET configuration file that is not currently
supported by METplus you'd like to control, please refer to:
supported by METplus that the user would like to control, please refer to:
:ref:`Overriding Unsupported MET config file settings<met-config-overrides>`.

The following section demonstrates a few examples using GridStat.
Expand Down Expand Up @@ -2576,7 +2576,7 @@ This is the equivalent of running this bash command::

on the command line before calling run_metplus.py.

You can also reference other variables in the METplus config file.
Other variables can also be referenced in the METplus config file.
For example::

[config]
Expand All @@ -2601,7 +2601,7 @@ on the command line before calling run_metplus.py.
Setting Config Variables with Environment Variables
===================================================

You can set METplus config variables to the value of local environment
The METplus config variables can be set to the value of local environment
variables when METplus is run. To set any METplus config variable to the
value of a local environment variable, use the following syntax::

Expand Down Expand Up @@ -2662,10 +2662,10 @@ Starting in METplus 3.0, users are required to either explicitly set both FCST_*

Example::

(met_util.py) ERROR: If FCST_VAR1_NAME is set, you must either set OBS_VAR1_NAME or change FCST_VAR1_NAME to BOTH_VAR1_NAME
(met_util.py) ERROR: If FCST_VAR2_NAME is set, you must either set OBS_VAR2_NAME or change FCST_VAR2_NAME to BOTH_VAR2_NAME
(met_util.py) ERROR: If FCST_VAR1_LEVELS is set, you must either set OBS_VAR1_LEVELS or change FCST_VAR1_LEVELS to BOTH_VAR1_LEVELS
(met_util.py) ERROR: If FCST_VAR2_LEVELS is set, you must either set OBS_VAR2_LEVELS or change FCST_VAR2_LEVELS to BOTH_VAR2_LEVELS
(met_util.py) ERROR: If FCST_VAR1_NAME is set, the user must either set OBS_VAR1_NAME or change FCST_VAR1_NAME to BOTH_VAR1_NAME
(met_util.py) ERROR: If FCST_VAR2_NAME is set, the user must either set OBS_VAR2_NAME or change FCST_VAR2_NAME to BOTH_VAR2_NAME
(met_util.py) ERROR: If FCST_VAR1_LEVELS is set, the user must either set OBS_VAR1_LEVELS or change FCST_VAR1_LEVELS to BOTH_VAR1_LEVELS
(met_util.py) ERROR: If FCST_VAR2_LEVELS is set, the user must either set OBS_VAR2_LEVELS or change FCST_VAR2_LEVELS to BOTH_VAR2_LEVELS

These cases can be handled automatically by using the :ref:`validate_config`, but users should review the suggested changes, as they may want to update differently.

Expand Down Expand Up @@ -2724,7 +2724,7 @@ Example log output::
(met_util.py) ERROR: Set GRID_STAT_CLIMO_MEAN_INPUT_[DIR/TEMPLATE] in a METplus config file to set CLIMO_MEAN_FILE in a MET config

(met_util.py) ERROR: output_prefix variable should reference ${OUTPUT_PREFIX} environment variable
(met_util.py) INFO: You will need to add GRID_STAT_OUTPUT_PREFIX to the METplus config file that sets GRID_STAT_CONFIG_FILE. Set it to:
(met_util.py) INFO: GRID_STAT_OUTPUT_PREFIX will need to be added to the METplus config file that sets GRID_STAT_CONFIG_FILE. Set it to:
(met_util.py) INFO: GRID_STAT_OUTPUT_PREFIX = {CURRENT_FCST_NAME}_vs_{CURRENT_OBS_NAME}

These cases can be handled automatically by using the :ref:`validate_config`, but users should review the suggested changes and make sure they add the appropriate recommended METplus configuration variables to their files to achieve the same behavior.
Expand Down Expand Up @@ -2758,7 +2758,7 @@ The script named validate_config.py is found in the same directory as run_metplu
run_metplus.py ./my_conf.py ./another_config.py
validate_config.py ./my_conf.py ./another_config.py

You must pass a valid configuration to the script, as in you must properly set :term:`MET_INSTALL_DIR`, :term:`INPUT_BASE`, and :term:`OUTPUT_BASE`, or it will not run.
A valid configuration must be passed to the script, as in the user must properly set :term:`MET_INSTALL_DIR`, :term:`INPUT_BASE`, and :term:`OUTPUT_BASE`, or it will not run.

The script will evaluate all of the configuration files, including any MET configuration file that is referenced in a _CONFIG_FILE variable, such as :term:`GRID_STAT_CONFIG_FILE`. For each deprecated item that is found, the script will suggest a replacement for the file where the deprecated item was found.

Expand Down Expand Up @@ -2827,7 +2827,7 @@ Example 5 (Another MET Configuration File)::

Would you like the make this change to DeprecatedConfig? (y/n)[n]

IMPORTANT: If it is not already set, add the following in the [config] section to your METplus configuration file that sets GRID_STAT_CONFIG_FILE:
IMPORTANT: If it is not already set, add the following in the [config] section to the METplus configuration file that sets GRID_STAT_CONFIG_FILE:

GRID_STAT_OUTPUT_PREFIX = {CURRENT_FCST_NAME}_vs_{CURRENT_OBS_NAME}
Make this change before continuing! [OK]
Expand All @@ -2836,7 +2836,7 @@ Example 5 (Another MET Configuration File)::
While the METplus developers are very diligent to include deprecated
variables in this functionality, some may slip through the cracks.
When upgrading to a new version of METplus, it is important to test
and review your use cases to ensure they produce the same results as
and review the use cases to ensure they produce the same results as
the previous version. Please create a post in the
`METplus GitHub Discussions Forum <https://github.com/dtcenter/METplus/discussions>`_
with any questions.

0 comments on commit 9e0d2a6

Please sign in to comment.