.. 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_histogram.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_histogram.py>`
        to download the full example code.

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

.. _sphx_glr_reference_gallery_generated_line_plot_line_histogram.py:


Histogram plot
==============

Generate histogram of region-averaged field.

.. admonition:: References

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

   The following CSET operators are used:

   * :py:mod:`CSET.operators.read.read_cubes`
   * :py:mod:`CSET.operators.plot.plot_histogram_series`.

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

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

Example to generate histogram plot of ``temperature_at_screen_level`` for any number of input models::

    cset cookbook generic_surface_histogram_series.yaml
    cset -v bake -i "/path/to/input/data1" "..." "/path/to/input/dataN" \
                 -o "./output_path" \
                 -r generic_surface_histogram_series.yaml \
                 --VARNAME="temperature_at_screen_level" \
                 --MODEL_NAME="['my_model_label1', '...', 'my_model_labelN']" \
                 --SEQUENCE="realization" \
                 --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`.
* Set required configuration options on ``Diagnostics / Surface (2D) fields`` panel.
* Set ``HISTOGRAM_SURFACE_FIELD_SEQUENCE=False`` to generate one histogram for all times.
* Set ``HISTOGRAM_SURFACE_FIELD_SEQUENCE=True`` to generate a separate histogram for each output time.
::

    HISTOGRAM_SURFACE_FIELD = True
    HISTOGRAM_SURFACE_FIELD_SEQUENCE = False
    SURFACE_FIELDS = ["temperature_at_screen_level", ...]


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

.. GENERATED FROM PYTHON SOURCE LINES 51-68



.. image-sg:: /reference/gallery/generated/line/images/sphx_glr_plot_line_histogram_001.png
   :alt: Histogram  [2022-09-21 03:00:00 to 2022-09-21 05:00:00]
   :srcset: /reference/gallery/generated/line/images/sphx_glr_plot_line_histogram_001.png, /reference/gallery/generated/line/images/sphx_glr_plot_line_histogram_001_2_00x.png 2.00x
   :class: sphx-glr-single-img





.. code-block:: Python


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

    # Set paths to input data
    filename1 = sample_data_path("air_temperature_1.nc")
    filename2 = sample_data_path("air_temperature_2.nc")

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

    # Plot domain histogram using plot_histogram_series
    plot.plot_histogram_series(cubes, sequence_coordinate="realization")


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

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


.. _sphx_glr_download_reference_gallery_generated_line_plot_line_histogram.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_histogram.ipynb <plot_line_histogram.ipynb>`

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

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

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

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


.. only:: html

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

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