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

.. only:: html

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

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

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

.. _sphx_glr_reference_gallery_generated_line_plot_line_vertical.py:


Vertical profile plot
=====================

Generate vertical profile of region-averaged field.

.. admonition:: References

   General functionality is provided using :doc:`CSET recipe </usage/operator-recipes>` ``generic_level_domain_mean_vertical_profile_series.yaml``

   The following CSET operators are used:

   * :py:mod:`CSET.operators.read.read_cubes`
   * :py:mod:`CSET.operators.collapse.collapse`
   * :py:mod:`CSET.operators.plot.plot_vertical_line_series`.

Using *cset bake* on the command line
-------------------------------------

* Access recipe file using ``cset cookbook``.
* Set required recipe inputs on command line.

Example to generate vertical profile plot of domain averaged ``air_temperature`` on pressure levels for any number of input models::

    cset cookbook generic_level_domain_mean_vertical_profile_series.yaml
    cset -v bake -i "/path/to/input/data1" "..." "/path/to/input/dataN" \
                 -o "./output_path" \
                 -r generic_level_domain_mean_vertical_profile_series.yaml \
                 --VARNAME="air_temperature" \
                 --MODEL_NAME="['my_model_label1', '...', 'my_model_labelN']" \
                 --LEVELTYPE="pressure" \
                 --METHOD="SEQ" \
                 --SUBAREA_TYPE='None' --SUBAREA_EXTENT='None' --SUBAREA_NAME=''

Configuring the *cset_workflow*
-------------------------------

* Update workflow configuration settings via ``rose edit`` GUI or in ``rose-suite.conf`` file.
* Complete ``General setup options`` and ``Cycling and Model options`` details - see :doc:`/usage/workflow-configure`.
* To plot vertical profile of fields defined on pressure levels, set required configuration options on ``Diagnostics / Pressure level fields`` panel::

    PRESSURE_LEVEL_FIELDS = ["air_temperature", ...]
    PRESSURE_LEVELS = ['1000', '850', '500', ...]
    PROFILE_PLEVEL = True

* To plot vertical profile of fields defined on model levels, set required configuration options on ``Diagnostics / Model level fields`` panel::

    MODEL_LEVEL_FIELDS = ["air_temperature", ...]
    MODEL_LEVELS = [1, 2, 3, ...]
    PROFILE_MLEVEL = True


Example python code
-------------------

.. GENERATED FROM PYTHON SOURCE LINES 56-78



.. image-sg:: /reference/gallery/generated/line/images/sphx_glr_plot_line_vertical_001.png
   :alt: air_temperature  [2021-04-10 21:00:00]
   :srcset: /reference/gallery/generated/line/images/sphx_glr_plot_line_vertical_001.png, /reference/gallery/generated/line/images/sphx_glr_plot_line_vertical_001_2_00x.png 2.00x
   :class: sphx-glr-single-img





.. code-block:: Python


    from CSET import sample_data_path
    from CSET.operators import collapse, plot, read

    # Set paths to input data
    filename1 = sample_data_path("profile_air_temperature_1.nc")
    filename2 = sample_data_path("profile_air_temperature_2.nc")

    # Read selected variable(s) of interest for 2 models
    cubes = read.read_cubes(
        [filename1, filename2],
        ["air_temperature"],
        model_names=["model_fcst_1", "model_fcst_2"],
    )

    # Collapse input data over selected dimensions
    collapsed_cubes = collapse.collapse(
        cubes, ["grid_longitude", "grid_latitude", "time"], "MEAN"
    )

    # Plot domain mean profile using plot_vertical_line_series
    plot.plot_vertical_line_series(collapsed_cubes, series_coordinate="pressure")


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

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


.. _sphx_glr_download_reference_gallery_generated_line_plot_line_vertical.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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