.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/met_tool_wrapper/TCGen/TCGen.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_TCGen_TCGen.py: TCGen: Basic Use Case ========================================================================== met_tool_wrapper/TCGen/TCGen.conf .. GENERATED FROM PYTHON SOURCE LINES 9-14 Scientific Objective -------------------- The TC-Gen tool provides verification of tropical cyclone genesis forecasts in ATCF file format. .. GENERATED FROM PYTHON SOURCE LINES 16-27 Datasets -------- | **Track:** A Deck or B Deck (Best) | **Genesis:** Genesis Forecast | **Location:** All of the input data required for this use case can be found in the met_tool_wrapper 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. | .. GENERATED FROM PYTHON SOURCE LINES 29-35 METplus Components ------------------ This use case utilizes the METplus TCGen wrapper to search for files that match wildcard expressions and generate a command to run the MET tool tc_gen. .. GENERATED FROM PYTHON SOURCE LINES 37-45 METplus Workflow ---------------- TCGen is the only tool called in this example. It processes the following run times: | **Init:** 2016 | .. GENERATED FROM PYTHON SOURCE LINES 47-56 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/TCGen.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/TCGen/TCGen.conf .. GENERATED FROM PYTHON SOURCE LINES 58-73 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:`TCGen 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/TCGenConfig_wrapped .. GENERATED FROM PYTHON SOURCE LINES 75-102 Running METplus --------------- This use case can be run two ways: 1) Passing in TCGen.conf then a user-specific system configuration file:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/TCGen/TCGen.conf -c /path/to/user_system.conf 2) Modifying the configurations in parm/metplus_config, then passing in TCGen.conf:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/TCGen/TCGen.conf The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, 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 104-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 met_tool_wrapper/TCGen and will contain the following files: * tc_gen_2016_ctc.txt * tc_gen_2016_cts.txt * tc_gen_2016.stat .. GENERATED FROM PYTHON SOURCE LINES 120-133 Keywords -------- .. note:: * TCGenToolUseCase * DTCOrgUseCase * 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_TCGen_TCGen.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: TCGen.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: TCGen.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: TCGen.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_