.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "generated/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_generated_met_tool_wrapper_GFDLTracker_GFDLTracker_Genesis.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_generated_met_tool_wrapper_GFDLTracker_GFDLTracker_Genesis.py:


GFDLTracker: TC Genesis Use Case
================================

met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf

.. GENERATED FROM PYTHON SOURCE LINES 9-18

Scientific Objective
--------------------

Setup and run GFDL Tracker applications to track cyclones in TC genesis mode.
See :ref:`external-components-gfdl-tracker` for more information.
A genesis vitals file is read into the tracker. This file contains
information on storms that were tracked in the previous 2 runs so that
additional data is attributed to the correct storm.


.. GENERATED FROM PYTHON SOURCE LINES 20-28

Datasets
--------

| **Forecast:** GFS

| **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 30-35

METplus Components
------------------

This use case utilizes the METplus GFDLTracker wrapper to generate a command
to run the GFDL Tracker Fortran applications.

.. GENERATED FROM PYTHON SOURCE LINES 37-46

METplus Workflow
----------------

GFDLTracker is the only tool called in this example.
It processes the following run time:

| **Init:** 2021-07-13 00Z
| **Forecast lead**: All available leads (0 - 198 hour)
|

.. GENERATED FROM PYTHON SOURCE LINES 48-57

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/GFDLTracker/GFDLTracker_Genesis.conf

.. highlight:: bash
.. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf

.. GENERATED FROM PYTHON SOURCE LINES 59-69

GFDL Tracker Configuration
--------------------------

METplus replaces values in the template configuration files read by the
tracker based on user settings in the METplus configuration file.

**YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!**

.. highlight:: bash
.. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/GFDLTracker/template.nml

.. GENERATED FROM PYTHON SOURCE LINES 71-81

Running METplus
---------------

This use case can be run by passing in the conf file to the run script::

   run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/GFDLTracker/GFDLTracker_Genesis.conf

See the :ref:`running-metplus` section of the User's Guide for more
information on how to run use cases.


.. GENERATED FROM PYTHON SOURCE LINES 83-96

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 gfdl_tracker/genesis (relative to **OUTPUT_BASE**)
and will contain the following file:

* gfs.2021071300.genesis.txt
* input.202107130000.nml

.. GENERATED FROM PYTHON SOURCE LINES 98-107

Keywords
--------

.. note::

  * GFDLTrackerToolUseCase

  Navigate to the :ref:`quick-search` page to discover other similar use cases.



.. _sphx_glr_download_generated_met_tool_wrapper_GFDLTracker_GFDLTracker_Genesis.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: GFDLTracker_Genesis.ipynb <GFDLTracker_Genesis.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: GFDLTracker_Genesis.py <GFDLTracker_Genesis.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: GFDLTracker_Genesis.zip <GFDLTracker_Genesis.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_