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

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

.. _sphx_glr_generated_met_tool_wrapper_DataIngest_DataIngest.py:


DataIngest: Basic Use Case
============================================================================

met_tool_wrapper/DataIngest/DataIngest.conf

.. GENERATED FROM PYTHON SOURCE LINES 9-13

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

Download input files and optionally decompress them.

.. GENERATED FROM PYTHON SOURCE LINES 15-19

Datasets
--------

| **Inputs:** None

.. GENERATED FROM PYTHON SOURCE LINES 21-26

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

This use case utilizes the METplus DataIngest wrapper to download and
decompress input files.

.. GENERATED FROM PYTHON SOURCE LINES 28-46

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

**Beginning time (VALID_BEG):** 2022-07-20 0Z

**End time (VALID_END):** 2022-07-20 12Z

**Increment between beginning and end times (VALID_INCREMENT):** 12 hours

**Sequence of forecast leads to process (LEAD_SEQ):** None

DataIngest is the only tool called in this example.
It has two run times.
The MADIS data is hourly, so two files are downloaded.
The Surfrad data is daily, so one file is downloaded.
The MADIS files are compressed with gzip compression, so they are
automatically decompressed into NetCDF format.


.. 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,
i.e. parm/use_cases/met_tool_wrapper/DataIngest/DataIngest.conf

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

.. GENERATED FROM PYTHON SOURCE LINES 59-64

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

None.


.. GENERATED FROM PYTHON SOURCE LINES 66-70

Python Embedding
----------------

This use case does not use Python Embedding.

.. GENERATED FROM PYTHON SOURCE LINES 72-76

User Scripting
--------------

This user case does not call a user-defined script.

.. GENERATED FROM PYTHON SOURCE LINES 78-87

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

Pass the use case configuration file to the run_metplus.py script along
with any user-specific system configuration files if desired::

  run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/DataIngest/DataIngest.conf /path/to/user_system.conf

See :ref:`running-metplus` for more information.

.. GENERATED FROM PYTHON SOURCE LINES 89-104

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

* madis_metar/20220720_0000.nc
* madis_metar/20220720_1200.nc
* surfrad/tbl20220720.dat


.. GENERATED FROM PYTHON SOURCE LINES 106-117

Keywords
--------

.. note::

  * DataIngestToolUseCase
  * MADISFileUseCase
  * NetCDFFileUseCase

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



.. _sphx_glr_download_generated_met_tool_wrapper_DataIngest_DataIngest.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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