.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/met_tool_wrapper/StatAnalysis/StatAnalysis_python_embedding.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_StatAnalysis_StatAnalysis_python_embedding.py: StatAnalysis: Using Python Embedding =========================================================================== met_tool_wrapper/StatAnalysis/StatAnalysis_python_embedding.conf .. GENERATED FROM PYTHON SOURCE LINES 10-17 Scientific Objective -------------------- This demonstrates how the Stat-Analysis tool can tie together results from other MET tools (including PointStat, GridStat, EnsembleStat, and WaveletStat) and provide summary statistical information. Matched pair records are passed into Stat-Analysis using python embedding. .. GENERATED FROM PYTHON SOURCE LINES 20-32 Datasets -------- | **WRF ARW point_stat output STAT files:** | ...met_test/new | point_stat_120000L_20050807_120000V.stat | **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 | The 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 34-40 METplus Components ------------------ This use case utilizes the METplus StatAnalysis wrapper to search for files that are valid at a given run time and generate a command to run the MET tool stat_analysis. .. GENERATED FROM PYTHON SOURCE LINES 42-51 METplus Workflow ---------------- StatAnalysis is the only tool called in this example. It processes the following run times: | **Valid:** 2005-08-07_00Z | **Forecast lead:** 12 hour | .. GENERATED FROM PYTHON SOURCE LINES 53-62 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/StatAnalysis/StatAnalysis.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/StatAnalysis/StatAnalysis_python_embedding.conf .. GENERATED FROM PYTHON SOURCE LINES 64-79 MET Configuration --------------------- METplus sets environment variables based on user settings in the METplus configuration file. See :ref:`How METplus controls MET config file settings` for more details. **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!** If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: :ref:`Overriding Unsupported MET config file settings` .. note:: See the :ref:`StatAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: .. highlight:: bash .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped .. GENERATED FROM PYTHON SOURCE LINES 81-88 Python Embedding ---------------- This use case calls a Python script to read matched pair lines from an input source. The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_mpr.py `read_ascii_mpr.py `_ .. GENERATED FROM PYTHON SOURCE LINES 90-114 Running METplus --------------- It is recommended to run this use case by: Passing in StatAnalysis_python_embedding.conf then a user-specific system configuration file:: run_metplus.py -c /path/to/StatAnalysis_python_embedding.conf -c /path/to/user_system.conf The following METplus configuration variables must be set correctly to run this example.: * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). * **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 117-129 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/StatAnalysis_python_embedding (relative to **OUTPUT_BASE**) and will contain the following file: * WRF_ADPSFC_valid20050807_fcstvalidhour120000Z_out_stat.stat .. GENERATED FROM PYTHON SOURCE LINES 131-143 Keywords -------- .. note:: * StatAnalysisToolUseCase * PythonEmbeddingFileUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. GENERATED FROM PYTHON SOURCE LINES 143-145 .. code-block:: Python # .. _sphx_glr_download_generated_met_tool_wrapper_StatAnalysis_StatAnalysis_python_embedding.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: StatAnalysis_python_embedding.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: StatAnalysis_python_embedding.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: StatAnalysis_python_embedding.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_