.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/met_tool_wrapper/TCPairs/TCPairs_extra_tropical.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_TCPairs_TCPairs_extra_tropical.py: TCPairs: Basic Use Case for Extra Tropical Cyclones ======================================================================== met_tool_wrapper/TCPairs/TCPairs_extra_tropical.conf .. GENERATED FROM PYTHON SOURCE LINES 9-14 Scientific Objective -------------------- Once this method is complete, a forecast and reference track analysis file will have been paired up, allowing statistical information to be extracted. .. GENERATED FROM PYTHON SOURCE LINES 16-30 Datasets -------- | **Forecast:** A Deck | track_data/201412/a??q201412*.gfso.* | **Observation:** Best Track - B Deck | track_data/201412/b??q201412*.gfso.* | **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:** GFS | .. GENERATED FROM PYTHON SOURCE LINES 32-38 METplus Components ------------------ This use case utilizes the METplus TCPairs wrapper to search for files that are valid at a given run time and generate a command to run the MET tool tc_pairs. .. GENERATED FROM PYTHON SOURCE LINES 40-49 METplus Workflow ---------------- TCPairs is the only tool called in this example. It processes the following run times: | **Init:** 2014-12-13_18Z | **Forecast lead:** 24 hour | .. GENERATED FROM PYTHON SOURCE LINES 51-60 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 /path/to/TCPairs_extra_tropical.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/TCPairs/TCPairs_extra_tropical.conf .. GENERATED FROM PYTHON SOURCE LINES 62-77 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:`TCPairs 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/TCPairsConfig_wrapped .. GENERATED FROM PYTHON SOURCE LINES 79-103 Running METplus --------------- It is recommended to run this use case by: Passing in TCPairs_extra_tropical.conf then a user-specific system configuration file:: run_metplus.py -c /path/to/TCPairs_extra_tropical.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 105-118 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 **tc_pairs/201412** (relative to **OUTPUT_BASE**) and will contain the following files: * mlq2014121318.gfso.0103.tcst * mlq2014121318.gfso.0104.tcst .. GENERATED FROM PYTHON SOURCE LINES 120-133 Keywords -------- .. note:: * TCPairsToolUseCase * SBUOrgUseCase * TropicalCycloneUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. GENERATED FROM PYTHON SOURCE LINES 133-135 .. code-block:: Python # .. _sphx_glr_download_generated_met_tool_wrapper_TCPairs_TCPairs_extra_tropical.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: TCPairs_extra_tropical.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: TCPairs_extra_tropical.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: TCPairs_extra_tropical.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_