.. _using-the-package:

*****************
ENSO Metrics
*****************

Overview
========
The El Niño-Southern Oscillation (ENSO) is the dominant mode of 
interannual variability in the tropical Pacific and has far-reaching 
impacts on climate around the world. It is therefore key to ensure 
the correct simulation of ENSO in state-of-the-art climate models. 
A community-wide synthesis of metrics to evaluate the performance, 
teleconnections and processes of ENSO in coupled GCMs have been implemented 
to PMP as a result of the collaboration with the ENSO Metrics Working Group 
of the `International CLIVAR Pacific Panel`_. 

Demo
====
* `PMP demo Jupyter notebook`_

Results
=========
* `Interactive graphics for PMP-calculated ENSO Metrics`_
* `Description for included metrics`_
* `Description for the results`_

Reference
=========
* Planton, Y., E. Guilyardi, A. T. Wittenberg, J. Lee, P. J. Gleckler, T. Bayr, S. McGregor, M. J. McPhaden, S. Power, R. Roehrig, J. Vialard, A Voldoire, 2021: Evaluating climate models with the CLIVAR 2020 ENSO metrics package, Bulletin of the American Meteorological Society, https://doi.org/10.1175/BAMS-D-19-0337.1. 

Additional Resources
====================
* `CLIVAR ENSO Metrics GitHub repository`_

.. _International CLIVAR Pacific Panel: https://www.clivar.org/clivar-panels/pacific
.. _CLIVAR ENSO Metrics GitHub repository: https://github.com/CLIVAR-PRP/ENSO_metrics 
.. _Description for the results: https://pcmdi.llnl.gov/metrics/enso/
.. _Description for included metrics: https://github.com/CLIVAR-PRP/ENSO_metrics/wiki
.. _Interactive graphics for PMP-calculated ENSO Metrics: https://pcmdi.llnl.gov/pmp-preliminary-results/interactive_plot/portrait_plot/enso_metric/enso_metrics_interactive_portrait_plots_v20210723.html
.. _PMP demo Jupyter notebook: https://github.com/PCMDI/pcmdi_metrics/blob/main/doc/jupyter/Demo/Demo_6_ENSO.ipynb