.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/met_tool_wrapper/MTD/MTD_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_MTD_MTD_python_embedding.py: MTD using Python Embedding ========================== met_tool_wrapper/MTD/MTD_python_embedding.conf .. GENERATED FROM PYTHON SOURCE LINES 9-14 Scientific Objective -------------------- Compare forecast and observation 3 hour precipitation accumulation spatially and temporally over the 6 hour, 9 hour, and 12 hour forecast leads. .. GENERATED FROM PYTHON SOURCE LINES 16-25 Datasets -------- | **Forecast:** Dummy text files found in the MET shared directory | **Observation:** Dummy text files found in the MET shared directory | **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. | .. GENERATED FROM PYTHON SOURCE LINES 27-32 METplus Components ------------------ This use case utilizes the METplus MTD wrapper to read in files using Python Embedding to demonstrate how to read in data this way. .. GENERATED FROM PYTHON SOURCE LINES 34-39 METplus Workflow ---------------- MTD is the only tool called in this example. It processes a single run time with three forecast leads. The input data are simple text files with no timing information, so the list of forecast leads simply duplicates the same file multiple times to demonstrate how data is read in via Python Embedding. .. GENERATED FROM PYTHON SOURCE LINES 41-51 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/MTD/MTD_python_embedding.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/MTD/MTD_python_embedding.conf .. GENERATED FROM PYTHON SOURCE LINES 53-68 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:`MTD 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/MTDConfig_wrapped .. GENERATED FROM PYTHON SOURCE LINES 70-77 Python Embedding ---------------- This use case calls a Python script to read the input data. The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py `read_ascii_numpy.py `_ .. GENERATED FROM PYTHON SOURCE LINES 79-107 Running METplus --------------- This use case can be run two ways: 1) Passing in MTD_python_embedding.conf then a user-specific system configuration file:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/MTD/MTD_python_embedding.conf -c /path/to/user_system.conf 2) Modifying the configurations in parm/metplus_config, then passing in MTD_python_embedding.conf:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/MTD/MTD_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: * **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 109-126 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/MTD/mtd_python_embedding (relative to **OUTPUT_BASE**) and will contain the following files: * mtd_PYTHON_20050807_120000V_2d.txt * mtd_PYTHON_20050807_120000V_3d_pair_cluster.txt * mtd_PYTHON_20050807_120000V_3d_pair_simple.txt * mtd_PYTHON_20050807_120000V_3d_single_cluster.txt * mtd_PYTHON_20050807_120000V_3d_single_simple.txt * mtd_PYTHON_20050807_120000V_obj.nc .. GENERATED FROM PYTHON SOURCE LINES 128-141 Keywords -------- .. note:: * MTDToolUseCase * PythonEmbeddingFileUseCase * DiagnosticsUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. _sphx_glr_download_generated_met_tool_wrapper_MTD_MTD_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: MTD_python_embedding.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: MTD_python_embedding.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: MTD_python_embedding.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_