############
User's Guide
############

**Foreword: A note to METplotpy users**

This User's Guide is provided as an aid to users of METplotpy.  METplotpy
contains packages for plotting in METplus as stand-alone, or part of METplus
use case, METplus wrappers, METexpress, or METviewer. It is also a component
of the unified METplus verification framework. More details about METplus can
be found on the
`METplus website <http://dtcenter.org/community-code/metplus>`_.

It is important to note here that METplotpy is an evolving software package.
This documentation describes the |release| release dated |release_date|.
Intermediate releases may include bug fixes. METplotpy is also able to accept
new modules contributed by the community. If there is code you would like to
contribute, we will gladly consider your contribution. Please create a
post in the
`METplus GitHub Discussions Forum <https://github.com/dtcenter/METplus/discussions>`_.
We will determine if we will be able to include the contribution in
a future version.

**Model Evaluation Tools Plot Py (METplotpy)  TERMS OF USE - IMPORTANT!**

Copyright |copyright|
Licensed under the Apache License, Version 2.0 (the "License");
You may not use this file except in compliance with the License.

You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0


Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.


.. _citations:

**Citations**

The citation for this User's Guide should be:

|author_list|, |release_year|: The METplotpy Version |version| User's Guide.
Developmental Testbed Center.
Available `here <https://github.com/dtcenter/METplotpy/releases>`_.

**Acknowledgments**

We thank all of the METplus sponsors including: Developmental Testbed
Center (DTC) partners (NOAA, NCAR, USAF, and NSF), along with
NOAA/Office of Atmospheric Research (OAR), NOAA/National Weather Service,
NOAA/Joint Technology Transfer Program (JTTI),
NOAA/Subseasonal to Seasonal (S2S) Project, NOAA/Unified Forecast System
Research to Operations Project (UFS R2O), Met Office and the Naval Research
Laboratory (NRL). Thanks also go to the staff at the DTC for their help,
advice, and many types of support. Finally, the National Center for
Atmospheric Research (NCAR), sponsored by National Science Foundation.


.. toctree::
   :titlesonly:
   :numbered: 4

   overview
   release-notes
   installation
   line
   box
   bar
   difficulty_index
   eclv
   ens_ss
   contour
   performance_diagram
   reliability_diagram
   roc_diagram
   histogram
   histogram_2d
   s2s_blocking
   weather_regime
   hovmoeller
   spacetime
   make_maki_enso
   mjo_rmm_omi
   taylor_diagram
   tcrmw_cross_section
   skew_t
   stratosphere_diagnostics
   stratosphere_plots
   polar_plot
   wind_rose
   fv3_physics
   tcmpr_plots
   scatter
   references


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`