.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/met_tool_wrapper/PCPCombine/PCPCombine_user_defined.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note :ref:`Go to the end ` to download the full example code. .. rst-class:: sphx-glr-example-title .. _sphx_glr_generated_met_tool_wrapper_PCPCombine_PCPCombine_user_defined.py: PCPCombine: User-defined Command Use Case ============================================================================= met_tool_wrapper/PCPCombine/PCPCombine_user_defined.conf .. GENERATED FROM PYTHON SOURCE LINES 9-16 Scientific Objective -------------------- Derive statistics (sum, minimum, maximum, range, mean, standard deviation, and valid count) using six 3 hour precipitation accumulation fields. This use case builds the same command as pcp_derive.conf, but the command is defined completely by the user in the METplus configuration file. .. GENERATED FROM PYTHON SOURCE LINES 18-28 Datasets -------- | **Forecast:** WRF precipitation accumulation fields (24, 21, 18, 15, 12, and 9 hour forecast leads) | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information. | **Data Source:** WRF | .. GENERATED FROM PYTHON SOURCE LINES 30-39 METplus Components ------------------ This use case utilizes the METplus PCPCombine wrapper to generate a command to run PCPCombine to derive statistics from the fields. FCST_PCP_COMBINE_COMMAND is used to define all arguments to the call to the MET tool pcp_combine. This variable uses filename template notation using the 'shift' keyword to define filenames that are valid at a time slightly shifted from the run time, i.e. wrfprs_ruc13_{lead?fmt=%HH?shift=-3H}.tm00_G212. It also references other configuration variables in the METplus configuration file, such as FCST_PCP_COMBINE_INPUT_NAMES and FCST_PCP_COMBINE_INPUT_LEVELS, and FCST_PCP_COMBINE_INPUT_DIR. .. GENERATED FROM PYTHON SOURCE LINES 41-50 METplus Workflow ---------------- PCPCombine is the only tool called in this example. It processes the following run times: | **Valid:** 2005-08-07_00Z | **Forecast lead:** 24 hour | .. GENERATED FROM PYTHON SOURCE LINES 52-61 METplus Configuration --------------------- METplus first loads all of the configuration files found in parm/metplus_config, then it loads any configuration files passed to METplus via the command line with the -c option, i.e. -c parm/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_user_defined.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_user_defined.conf .. GENERATED FROM PYTHON SOURCE LINES 63-68 MET Configuration --------------------- None. PCPCombine does not use configuration files. .. GENERATED FROM PYTHON SOURCE LINES 70-98 Running METplus --------------- This use case can be run two ways: 1) Passing in PCPCombine_user_defined.conf then a user-specific system configuration file:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_user_defined.conf -c /path/to/user_system.conf 2) Modifying the configurations in parm/metplus_config, then passing in PCPCombine_user_defined.conf:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_user_defined.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: * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions * **MET_INSTALL_DIR** - Path to location where MET is installed locally Example User Configuration File:: [dir] INPUT_BASE = /path/to/sample/input/data OUTPUT_BASE = /path/to/output/dir MET_INSTALL_DIR = /path/to/met-X.Y **NOTE:** All of these items must be found under the [dir] section. .. GENERATED FROM PYTHON SOURCE LINES 100-113 Expected Output --------------- A successful run will output the following both to the screen and to the logfile:: INFO: METplus has successfully finished running. Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. Output for this use case will be found in met_tool_wrapper/PCPCombine/PCPCombine_user_defined (relative to **OUTPUT_BASE**) and will contain the following files: * wrfprs_ruc13_2005080700_f24_A24.nc .. GENERATED FROM PYTHON SOURCE LINES 115-126 Keywords -------- .. note:: * PCPCombineToolUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. GENERATED FROM PYTHON SOURCE LINES 126-128 .. code-block:: Python # .. _sphx_glr_download_generated_met_tool_wrapper_PCPCombine_PCPCombine_user_defined.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: PCPCombine_user_defined.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: PCPCombine_user_defined.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: PCPCombine_user_defined.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_