Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature 794 change master_metplus to run_metplus #805

Merged
merged 5 commits into from
Feb 18, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/coding_standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Coding Standards
* `Doxygen <http://www.doxygen.nl/>`_, `Python
docstrings <https://www.python.org/dev/peps/pep-0257/>`_, and
`Sphinx <http://www.sphinx-doc.org/en/master/>`_ for documentation
* **NOTE: Please do not use f-strings in the master_metplus.py file so that the Python version check can notify the user of the incorrect version. Using Python 3.5 or earlier will output the SyntaxError from the f-string instead of the useful error message.**
* **NOTE: Please do not use f-strings in the run_metplus.py file so that the Python version check can notify the user of the incorrect version. Using Python 3.5 or earlier will output the SyntaxError from the f-string instead of the useful error message.**
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/create_wrapper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ If the wrapper will not loop and process for each forecast lead, put the logic t

* Call self.clear() at the beginning of each loop iteration that tries to build/run a MET command to prevent inadvertently reusing/re-running commands that were previously created.

* Update the METplus/ush/master_metplus.py file to recognize your wrapper by adding an import statement::
* Update the METplus/ush/run_metplus.py file to recognize your wrapper by adding an import statement::

from new_tool_wrapper import NewToolWrapper

Expand Down
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/deprecation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ should use LOOP_ORDER, but it is not required to change
immediately. If you do this, you should check for LOOP_ORDER and then
check for LOOP_METHOD if it is not set.

In master_metplus.py:
In run_metplus.py:

::

Expand Down
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/github_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The feature branch is named after the corresponding GitHub issue:

When work is complete, the code in the feature branch is merged into the
develop branch. When a release candidate for METplus has been determined,
then the develop branch is used to create a master_vx.y release of METplus,
then the develop branch is used to create a main_vx.y release of METplus,
which includes data tarballs for use in running use cases.


Expand Down
22 changes: 11 additions & 11 deletions docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ METplus Wrappers run and do not need to be invoked on the command line.

- runtime-related settings:

- location of METplus master_metplus.conf file (the 'master' conf
- location of METplus run_metplus.conf file (the conf
file that is a collection of all the final METplus
configuration files)

Expand Down Expand Up @@ -393,7 +393,7 @@ These cases can be handled automatically by using the :ref:`validate_config`, bu

SED Commands
~~~~~~~~~~~~
Running master_metplus.py with one or more configuration files that contain deprecated variables that can be fixed with a find/replace command will generate a file in the {OUTPUT_BASE} called sed_commands.txt. This file contains a list of commands that can be run to update the configuration file. Lines that start with "#Add" are intended to notify the user to add a variable to their METplus configuration file.
Running run_metplus.py with one or more configuration files that contain deprecated variables that can be fixed with a find/replace command will generate a file in the {OUTPUT_BASE} called sed_commands.txt. This file contains a list of commands that can be run to update the configuration file. Lines that start with "#Add" are intended to notify the user to add a variable to their METplus configuration file.

The :ref:`validate_config` will step you through each of these commands and execute them upon your approval.

Expand All @@ -412,9 +412,9 @@ Example sed_commands.txt content::

Validate Config Helper Script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The script named validate_config.py is found in the same directory as master_metplus.py. To use this script, call it with the same arguments that you would pass to master_metplus.py::
The script named validate_config.py is found in the same directory as run_metplus.py. To use this script, call it with the same arguments that you would pass to run_metplus.py::

master_metplus.py -c ./my_conf.py -c ./another_config.py
run_metplus.py -c ./my_conf.py -c ./another_config.py
validate_config.py -c ./my_conf.py -c ./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.
Expand Down Expand Up @@ -498,7 +498,7 @@ Running METplus Wrappers
------------------------

Running METplus Wrappers involves invoking the Python script
master_metplus.py from any directory followed by a list of configuration
run_metplus.py from any directory followed by a list of configuration
files (file path relative to the
*<path_to_METplus_install_dir>*/parm directory).

Expand All @@ -525,7 +525,7 @@ Copy and paste the following into an empty text file and name it 'my_user_config
# It will be created if it does not exist
OUTPUT_BASE = /tmp/output

Run METplus via: ``master_metplus.py -c ./<my_user_config.conf>`` or ``master_metplus.py -c /<username>/<my_user_config.conf>`` if you saved your default config in a directory other than where you are running master_metplus.py.
Run METplus via: ``run_metplus.py -c ./<my_user_config.conf>`` or ``run_metplus.py -c /<username>/<my_user_config.conf>`` if you saved your default config in a directory other than where you are running run_metplus.py.

When the above command is run, a usage message appears indicating that other config files are required to perform useful tasks, as well as a list of currently supported wrappers:

Expand All @@ -534,11 +534,11 @@ When the above command is run, a usage message appears indicating that other con
USAGE: This text is displayed when [config] PROCESS_LIST = Usage.
Pass in a configuration file (with -c or --config) that overrides [config] PROCESS_LIST to run other processes. For example:

master_metplus.py -c parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf
run_metplus.py -c parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf

or

master_metplus.py --config parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf
run_metplus.py --config parm/use_cases/model_applications/precipitation/GridStat_fcstHRRR-TLE_obsStgIV_GRIB.conf

Possible processes:
- ASCII2NC
Expand Down Expand Up @@ -576,7 +576,7 @@ The command:

.. code-block::

master_metplus.py -c use_cases/met_tool_wrapper/GridStat/GridStat.conf
run_metplus.py -c use_cases/met_tool_wrapper/GridStat/GridStat.conf

will run METplus using the defaults set in the config files found in parm/metplus_config. Any variables defined in these three config files can be overridden in the parm/use_cases/GridStat/GridStat.conf file. METplus will run using the values specified in the GridStat.conf file.

Expand All @@ -586,7 +586,7 @@ The command:

.. code-block::

master_metplus.py -c use_cases/met_tool_wrapper/GridStat/GridStat.conf \
run_metplus.py -c use_cases/met_tool_wrapper/GridStat/GridStat.conf \
-c use_cases/met_tool_wrapper/GridStat/GridStat_forecast.conf \
-c use_cases/met_tool_wrapper/GridStat/GridStat_observation.conf

Expand All @@ -596,6 +596,6 @@ Separating configurations into multiple files can be useful if you want to compa

.. code-block::

master_metplus.py -c use_cases/met_tool_wrapper/GridStat/GridStat.conf \
run_metplus.py -c use_cases/met_tool_wrapper/GridStat/GridStat.conf \
-c /home/user/METplus_user_config/GridStat_myforecast.conf \
-c use_cases/met_tool_wrapper/GridStat/GridStat_observation.conf
4 changes: 2 additions & 2 deletions docs/Users_Guide/systemconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1346,7 +1346,7 @@ Config Quick Start Example

a. On your command line, run::

master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Example/Example.conf -c /path/to/user_system.conf
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Example/Example.conf -c /path/to/user_system.conf

*where /path/to/user_system.conf indicates the location of the user_system.conf file you created earlier.

Expand Down Expand Up @@ -1430,7 +1430,7 @@ Config Quick Start Example
up the rest of your environment
4. On your command line, run::

master_metplus.py -c parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_RPlotting.conf
run_metplus.py -c parm/use_cases/model_applications/tc_and_extra_tc/Plotter_fcstGFS_obsGFS_RPlotting.conf

5. When complete, you will have a log file in the output directory
you specified, and under the tc_pairs directory you will see
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,11 @@
#
# 1) Passing in ASCII2NC.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in ASCII2NC.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@
#
# 1) Passing in ASCII2NC_python_embedding.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in ASCII2NC_python_embedding.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@
#
# 1) Passing in ASCII2NC_python_embedding_user_py.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding_user_py.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding_user_py.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in ASCII2NC_python_embedding_user_py.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding_user_py.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding_user_py.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@
#
# 1) Passing in CyclonePlotter.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf \
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf \
# -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in CyclonePlotter.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
#
# Passing in EnsembleStat.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat.conf -c /path/to/user_system.conf
#
# The following METplus configuration variables must be set correctly to run this example.:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
#
# Passing in EnsembleStat_python_embedding.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat_python_embedding.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat_python_embedding.conf -c /path/to/user_system.conf
#
# The following METplus configuration variables must be set correctly to run this example.:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/Example/Example.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@
#
# 1) Passing in Example.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Example/Example.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Example/Example.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in Example.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Example/Example.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Example/Example.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@
#
# 1) Passing in ExtractTiles.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in ExtractTiles.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@
#
# 1) Passing in GempakToCF.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in GempakToCF.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@
#
# 1) Passing in the use case config file then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in the use case config file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@
#
# 1) Passing in the use case config file then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_multiple.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_multiple.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in the use case config file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_multiple.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_multiple.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@
#
# 1) Passing in the use case config file then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_with_arguments.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_with_arguments.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in the use case config file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_with_arguments.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_with_arguments.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/GridDiag/GridDiag.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@
#
# 1) Passing in GridDiag.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridDiag/GridDiag.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridDiag/GridDiag.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in GridDiag.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridDiag/GridDiag.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridDiag/GridDiag.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/met_tool_wrapper/GridStat/GridStat.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@
#
# 1) Passing in GridStat.conf then a user-specific system configuration file::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf -c /path/to/user_system.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat.conf::
#
# master_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf
# run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
Expand Down
Loading