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

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

.. _sphx_glr_generated_met_tool_wrapper_Point2Grid_Point2Grid.py:


Point2Grid: Basic Use Case
=============================================================================

met_tool_wrapper/Point2Grid/Point2Grid.conf

.. GENERATED FROM PYTHON SOURCE LINES 9-13

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

Putting point observations onto a grid for use with other tools.

.. GENERATED FROM PYTHON SOURCE LINES 15-23

Datasets
--------

| **Observations:** Stage 2 NetCDF 1-hour Precipitation Accumulation

| **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 25-29

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

This use case utilizes the METplus Point2Grid wrapper to generate a command to run the MET tool Point2Grid if all required files are found.

.. GENERATED FROM PYTHON SOURCE LINES 31-41

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

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

| **Init:** 2017-06-01_0Z
|

This use case puts point observations onto a specified grid

.. GENERATED FROM PYTHON SOURCE LINES 43-52

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

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

.. GENERATED FROM PYTHON SOURCE LINES 54-59

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

None. Point2Grid does not use configuration files.


.. GENERATED FROM PYTHON SOURCE LINES 61-89

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

This use case can be run two ways:

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

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

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

       run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/Point2Grid/Point2Grid.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 91-105

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

* grid.20170100.nc
* grid.20170200.nc
* grid.20170300.nc

.. GENERATED FROM PYTHON SOURCE LINES 107-120

Keywords
--------

.. note::

  * Point2GridToolUseCase

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



sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-Point2Grid.png'



.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.000 seconds)


.. _sphx_glr_download_generated_met_tool_wrapper_Point2Grid_Point2Grid.py:

.. only:: html

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




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

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

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

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


.. only:: html

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

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