.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "generated/met_tool_wrapper/CyclonePlotter/CyclonePlotter.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_CyclonePlotter_CyclonePlotter.py>`
        to download the full example code.

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

.. _sphx_glr_generated_met_tool_wrapper_CyclonePlotter_CyclonePlotter.py:


CyclonePlotter: Basic Use Case
============================================================================

met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf

.. GENERATED FROM PYTHON SOURCE LINES 11-16

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


Provide visualization of cyclone tracks on a global map (PlateCaree projection)

.. GENERATED FROM PYTHON SOURCE LINES 18-23

Datasets
--------

 No datasets are required for running this use case.  Only output from
 running the MET Tool tc-pairs or the METplus tc pairs wrapper is required.

.. GENERATED FROM PYTHON SOURCE LINES 25-33

External Dependencies
---------------------

You will need to use a version of Python 3.6+ that has the following packages installed:

* cartopy
* matplotlib


.. GENERATED FROM PYTHON SOURCE LINES 35-39

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

This use case does not utilize any MET tools

.. GENERATED FROM PYTHON SOURCE LINES 41-49

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

CyclonePlotter is the only tool called in this example. It processes the following
run times:

| **Init:** 2015-03-01_12Z
|

.. GENERATED FROM PYTHON SOURCE LINES 52-61

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/CyclonePlotter/CyclonePlotter.conf

.. highlight:: bash
.. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf

.. GENERATED FROM PYTHON SOURCE LINES 63-68

MET Configuration
---------------------

No MET configuration is needed to run the cyclone plotter wrapper.


.. GENERATED FROM PYTHON SOURCE LINES 70-99

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

This use case can be run as follows:

1) Passing in CyclonePlotter.conf then a user-specific system configuration file::

       run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.conf \
                         -c /path/to/user_system.conf

2) Modifying the configurations in parm/metplus_config, then passing in CyclonePlotter.conf::

       run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.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 101-114

Expected Output
---------------

A successful run will generate output to both the screen and to the logfile:

   INFO: METplus has successfully finished running.

Additionally, two output files are created.  Refer to the value set for **OUTPUT_BASE** to find where the output data was generated.
TCPairs output for this use case will be found in cyclone/201503 (relative to **OUTPUT_BASE**)
and will contain files with the following format:

* 20150301.txt
* 20150301.png

.. GENERATED FROM PYTHON SOURCE LINES 116-127

Keywords
--------

.. note::

  * CyclonePlotterUseCase

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





.. _sphx_glr_download_generated_met_tool_wrapper_CyclonePlotter_CyclonePlotter.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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