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

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

.. _sphx_glr_generated_met_tool_wrapper_PairStat_PairStat.py:


PairStat: Basic Use Case
========================

met_tool_wrapper/PairStat/PairStat.conf

.. GENERATED FROM PYTHON SOURCE LINES 9-14

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

Compare hourly forecasts for temperature, u-, and v-wind components to observations
in a 3-hour observation window. Generate statistics of the results.

.. GENERATED FROM PYTHON SOURCE LINES 16-26

Datasets
--------

| **Pairs:** PointStat matched pairs output: temperature, u-wind component, and v-wind component

| **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.

| **Data Source:** Unknown
|

.. GENERATED FROM PYTHON SOURCE LINES 28-34

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

This use case utilizes the METplus PairStat wrapper to search for
files that are valid at a given run time and generate a command to run
the MET tool pair_stat if all required files are found.

.. GENERATED FROM PYTHON SOURCE LINES 36-44

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

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

| **Valid:** 2007-03-30_0Z
|

.. GENERATED FROM PYTHON SOURCE LINES 46-53

METplus Configuration
---------------------

parm/use_cases/met_tool_wrapper/PairStat/PairStat.conf

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

.. GENERATED FROM PYTHON SOURCE LINES 55-67

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

.. note::
    See the :ref:`PairStat MET Configuration<pair-stat-met-conf>`
    section of the User's Guide for more information on the environment
    variables used in the file below.

parm/met_config/PairStatConfig_wrapped

.. highlight:: bash
.. literalinclude:: ../../../../parm/met_config/PairStatConfig_wrapped

.. GENERATED FROM PYTHON SOURCE LINES 69-79

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

Provide the use case .conf configuration file to the run_metplus.py script.

/path/to/METplus/parm/use_cases/met_tool_wrapper/PairStat/PairStat.conf

See the :ref:`running-metplus` section of the System Configuration chapter
for more details.


.. GENERATED FROM PYTHON SOURCE LINES 81-93

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 pair_stat (relative to **OUTPUT_BASE**)
and will contain the following files:

* pair_stat_360000L_20070331_120000V.stat

.. GENERATED FROM PYTHON SOURCE LINES 95-106

Keywords
--------

.. note::

  * PairStatToolUseCase

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




.. GENERATED FROM PYTHON SOURCE LINES 106-108

.. code-block:: Python


    #


.. _sphx_glr_download_generated_met_tool_wrapper_PairStat_PairStat.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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