# ESMValTool > [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity) > [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) > [![Documentation Status](https://readthedocs.org/projects/esmvaltool/badge/?version=latest)](https://esmvaltool.readthedocs.io/en/latest/?badge=latest) > [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3401363.svg)](https://doi.org/10.5281/zenodo.3401363) > [![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#ESMValGroup_Lobby:gitter.im) > [![CircleCI](https://circleci.com/gh/ESMValGroup/ESMValTool/tree/main.svg?style=svg)](https://circleci.com/gh/ESMValGroup/ESMValTool/tree/main) > [![Test in Full Development Mode](https://github.com/ESMValGroup/ESMValTool/actions/workflows/test-development.yml/badge.svg)](https://github.com/ESMValGroup/ESMValTool/actions/workflows/test-development.yml) > [![Codacy Badge](https://app.codacy.com/project/badge/Grade/79bf6932c2e844eea15d0fb1ed7e415c)](https://app.codacy.com/gh/ESMValGroup/ESMValTool/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) > [![Docker Build Status](https://img.shields.io/docker/automated/esmvalgroup/esmvaltool)](https://hub.docker.com/r/esmvalgroup/esmvaltool/) > [![Anaconda-Server Badge](https://img.shields.io/conda/vn/conda-forge/ESMValTool?color=blue&label=conda-forge&logo=conda-forge&logoColor=white)](https://anaconda.org/conda-forge/esmvaltool) > ![stand with Ukraine](https://badgen.net/badge/stand%20with/UKRAINE/?color=0057B8&labelColor=FFD700) > > ![esmvaltoollogo](https://raw.githubusercontent.com/ESMValGroup/ESMValTool/main/doc/sphinx/source/figures/ESMValTool-logo-2-glow.png) > > - [**Documentation**](https://docs.esmvaltool.org/en/latest/) > - [**ESMValTool Website**](https://www.esmvaltool.org/) > - [**ESMValTool Tutorial**](https://tutorial.esmvaltool.org/index.html) > - [**ESMValGroup Project on GitHub**](https://github.com/ESMValGroup) > - [**Gallery**](https://docs.esmvaltool.org/en/latest/gallery.html) > - [**`conda-forge` package feedstock**](https://github.com/conda-forge/esmvaltool-suite-feedstock) > > # Introduction > > ESMValTool is a community-developed climate model diagnostics and evaluation software package, driven > both by computational performance and scientific accuracy and reproducibility. ESMValTool is open to both > users and developers, encouraging open exchange of diagnostic source code and evaluation results from the > Coupled Model Intercomparison Project [CMIP](https://www.wcrp-climate.org/wgcm-cmip) ensemble. For a > comprehensive introduction to ESMValTool please visit our > [documentation](https://docs.esmvaltool.org/en/latest/introduction.html) page. > > # Running esmvaltool > > Diagnostics from ESMValTool are run using [recipe](https://docs.esmvaltool.org/en/latest/recipes/index.html) > files that contain pointers to the requested data types, directives for the preprocessing steps that data > will be subject to, and directives for the actual diagnostics that will be run with the now preprocessed data. > Data preprocessing is done via the [ESMValCore](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/index.html) package, a pure Python, highly-optimized scientific library, developed by the ESMValTool core developers, > and that performs a number of common analysis tasks > such as regridding, masking, levels extraction etc. [Diagnostics](https://docs.esmvaltool.org/en/latest/develop/diagnostic.html) are written in a variety of programming languages (Python, NCL, R) and are developed by the wider > scientific community, and included after a scientific and technical review process. > > # Input data > > ESMValTool can run with the following types of [data as input](https://docs.esmvaltool.org/en/latest/input.html): > > - CMIP6 > - CMIP5 > - CMIP3 > - [observational and re-analysis datasets](https://docs.esmvaltool.org/en/latest/input.html#supported-datasets-for-which-a-cmorizer-script-is-available) > - obs4MIPs > - ana4mips > - CORDEX ([work in progress](https://docs.esmvaltool.org/en/latest/input.html#cordex-note)) > > # Getting started > > Please see [getting started](https://docs.esmvaltool.org/en/latest/quickstart/index.html) on our instance of Read the Docs as well as [ESMValTool tutorial](https://tutorial.esmvaltool.org/index.html). The tutorial is a set of lessons that together teach skills needed to work with ESMValTool in climate-related domains. > > ## Getting help > > The easiest way to get help, if you cannot find the answer in the documentation in our [docs](https://docs.esmvaltool.org), is to open an [issue on GitHub](https://github.com/ESMValGroup/ESMValTool/issues). > > ## Contributing > > If you would like to contribute a new diagnostic or feature, please have a look at our [contribution guidelines](https://docs.esmvaltool.org/en/latest/community/index.html). 2026, ESMValTool Development Team ## Pages - [Welcome to ESMValTool’s documentation!](index.html.md): sphinx-quickstart on Tue Jun 2 11:34:13 2015. - [Introduction](introduction.html.md): The Earth System Model Evaluation Tool (ESMValTool) is a - [Tutorials](tutorials/index.html.md): A tutorial is available on ESMValTool Tutorial. - [ESMValTool Tutorial](tutorials/tutorial_overview.html.md): This tutorial helps you to use ESMValTool. - [Setup: Preparations for participating in the tutorial](tutorials/tutorial_setup.html.md): This page includes some information on how to prepare for participating in this - [Introduction](tutorials/episode_1_introduction.html.md): This tutorial is a first introduction to ESMValTool. Before diving into the - [Quickstart guide](tutorials/episode_2_quickstart.html.md): The purpose of the quickstart guide is to enable a user of ESMValTool to run - [Installation](tutorials/episode_3_installation.html.md): The instructions help with the installation of ESMValTool on operating systems - [Configuration](tutorials/episode_4_configuration.html.md): ESMValTool provides a set of predefined configuration files. - [Running your first recipe](tutorials/episode_5_recipe.html.md): This episode describes how ESMValTool recipes work, how to run a recipe and how - [Conclusion of the basic tutorial](tutorials/episode_6_conclusion.html.md): Congratulations on completing the ESMValTool tutorial! - [What ESMValTool can do for you](functionalities.html.md): The ESMValTool applies a great variety of standard diagnostics and - [Gallery](gallery.html.md): This section shows example plots produced by ESMValTool. For more information, follow the links in t... - [Getting started](quickstart/index.html.md): * Installation - [Installation](quickstart/installation.html.md): ESMValTool supports Python 3.12 and later and requires Linux or MacOS. - [Configuration](quickstart/configuration.html.md): The `esmvaltool` command is provided by the ESMValCore package, the - [Running](quickstart/running.html.md): ESMValTool is mostly used as a command line tool. - [Output](quickstart/output.html.md): ESMValTool automatically generates a new output directory with every run. The - [Recipes](recipes/index.html.md): A website displaying results produced with the latest release of - [Model Benchmarking](recipes/recipe_benchmarking.html.md): These recipes and diagnostics are based on recipe_monitor that allow plotting arbitrary preprocessor... - [General model evaluation](recipes/recipe_model_evaluation.html.md): These recipes and diagnostics provide a basic climate model evaluation with - [Monitor](recipes/recipe_monitor.html.md): These recipes and diagnostics allow plotting arbitrary preprocessor output, - [Portrait plot](recipes/recipe_portrait.html.md): Portrait plots are a flexible way to visualize performance metrics for multiple - [Sanity checks](recipes/recipe_sanity_checks.html.md): The sanity check recipe (`recipe_sanity_checks.yml`) is intended to perform - [Seaborn Diagnostics](recipes/recipe_seaborn.html.md): These recipes showcase the use of the Seaborn diagnostic that provides a - [CMIP Rapid Evaluation Framework (REF)](recipes/recipe_ref.html.md): Here ESMValTool recipes are collected which will be used in the CMIP - [Blocking metrics and indices, teleconnections and weather regimes (MiLES)](recipes/recipe_miles.html.md): Atmospheric blocking is a recurrent mid-latitude weather pattern identified by a large-amplitude, qu... - [MJO Wavenumber-Frequency Spectra](recipes/recipe_mjo.html.md): This recipe computes Wheeler-Kiladis space-time spectra to evaluate - [Generating Climate Patterns from CMIP6 Models](recipes/recipe_climate_patterns.html.md): The recipe recipe_climate_patterns generates climate patterns from CMIP6 model - [Clouds](recipes/recipe_clouds.html.md): Four recipes are available to evaluate cloud climatologies from CMIP models. - [Evaluate water vapor short wave radiance absorption schemes of ESMs with the observations, including ESACCI data.](recipes/recipe_cmug_h2o.html.md): The recipe contains several diagnostics to use ESACCI water vapour data to evaluate CMIP models. - [Cloud Regime Error Metric (CREM)](recipes/recipe_crem.html.md): The radiative feedback from clouds remains the largest source of uncertainty - [Evaluate water vapor short wave radiance absorption schemes of ESMs with the observations.](recipes/recipe_deangelis15nat.html.md): The recipe reproduces figures from DeAngelis et al. (2015): - [Diurnal temperature range](recipes/recipe_diurnal_temperature_index.html.md): The goal of this diagnostic is to compute a vulnerability indicator for the diurnal temperature rang... - [Droughts](recipes/recipe_droughts.html.md): Meteorological drought can in its simplest form be described by a lack of - [Consecutive dry days](recipes/droughts/recipe_consecdrydays.html.md): Meteorological drought can in its simplest form be described by a lack of - [Standardized Precipitation-Evapotranspiration Index (SPEI)](recipes/droughts/recipe_spei.html.md): Droughts can be separated into three main types: meteorological, hydrological, - [Drought characteristics following Martin (2018)](recipes/droughts/recipe_martin18grl.html.md): Following Martin (2018) drought characteristics are calculated based on the - [Eady growth rate](recipes/recipe_eady_growth_rate.html.md): This recipe computes the maximum Eady Growth Rate and performs the annual and seasonal means, storin... - [Extreme Events Indices (ETCCDI)](recipes/recipe_extreme_events.html.md): This diagnostic uses the standard climdex.pcic.ncdf R library to - [Combined Climate Extreme Index](recipes/recipe_extreme_index.html.md): The goal of this diagnostic is to compute time series of a number of extreme events: heatwave, coldw... - [Spatially resolved evaluation of ESMs with satellite column-averaged CO<sub>2</sub>](recipes/recipe_gier20bg.html.md): This recipe reproduces the figures of Gier et al. (2020). It uses satellite - [Heat wave and cold wave duration](recipes/recipe_heatwaves_coldwaves.html.md): The goal of this diagnostic is to estimate the relative change in heat/cold wave characteristics in... - [Hydroclimatic intensity and extremes (HyInt)](recipes/recipe_hyint.html.md): The HyInt tool calculates a suite of hydroclimatic and climate extremes indices to perform a multi-i... - [Implied heat transport from Top of Atmosphere fluxes](recipes/recipe_iht_toa.html.md): This recipe calculates the implied horizontal heat transport (IHT) due to the - [Quick insights for climate impact researchers](recipes/recipe_impact.html.md): Many impact researchers do not have the time and finances to use a large - [Lifetime](recipes/recipe_lifetime.html.md): The diagnostic calculates the lifetime of CH4 (or potentially other chemically - [Madden-Julian Oscillation precipitation Hovmöller diagnostic](recipes/recipe_mjo_hovmoeller.html.md): This recipe computes lag-regression Hovmöller diagrams of the - [Modes of variability](recipes/recipe_modes_of_variability.html.md): The goal of this recipe is to compute modes of variability from a reference or observational dataset... - [Diagnostics of integrated atmospheric methane (XCH4)](recipes/recipe_mpqb_xch4.html.md): This recipe `recipe_mpqb_xch4.yml` allows the comparison of integrated atmospheric methane - [Precipitation quantile bias](recipes/recipe_quantilebias.html.md): Precipitation is a dominant component of the hydrological cycle, and as such a main driver of the cl... - [Quantifying progress across different CMIP phases](recipes/recipe_bock20jgr.html.md): The recipe recipe_bock20jgr.yml generates figures to quantify the progress across - [Stratosphere - Autoassess diagnostics](recipes/recipe_autoassess_stratosphere.html.md): Polar night jet / easterly jet strengths are defined as the maximum / minimum wind - [Land-surface Permafrost - Autoassess diagnostics](recipes/recipe_autoassess_landsurface_permafrost.html.md): Permafrost thaw is an important impact of climate change, and is the source of - [Land-surface Surface Radiation - Autoassess diagnostics](recipes/recipe_autoassess_landsurface_surfrad.html.md): The simulation of surface radiation is central to all aspects of model - [Land-surface Soil Moisture - Autoassess diagnostics](recipes/recipe_autoassess_landsurface_soilmoisture.html.md): Soil moisture is a critical component of the land system, controling surface - [Stratosphere-troposphere coupling and annular modes indices (ZMNAM)](recipes/recipe_zmnam.html.md): The current generation of climate models include the representation of stratospheric processes, as t... - [Thermodynamics of the Climate System - The Diagnostic Tool TheDiaTo v1.0](recipes/recipe_thermodyn_diagtool.html.md): The tool allows to compute TOA, atmospheric and surface energy budgets, latent energy and water mass... - [Tropical Cold-Point Tropopause (CPT) Hovmoeller Diagnostic](recipes/recipe_tropical_cpt_hovmoeller.html.md): This recipe evaluates the structure of the tropical (20°S-20°N) - [Zonal and Meridional Means](recipes/recipe_validation.html.md): This functional diagnostic takes two models designated by CONTROL and EXPERIMENT and compares them v... - [Radiation Budget](recipes/recipe_radiation_budget.html.md): The aim of monitoring the energy budget is to understand the (im)balance - [AOD AeroNET Assess](recipes/recipe_aod_aeronet_assess.html.md): This diagnostic evaluates model aerosol optical depth (AOD) against ground - [Surface trace gases](recipes/recipe_surface_trace_gas.html.md): Recipes are stored in esmvaltool/recipes/ - [Lamb Weathertypes](recipes/recipe_weathertyping.html.md): A diagnostic to calculate Lamb weathertypes over a given region. Furthermore, - [Performance metrics for essential climate parameters](recipes/recipe_perfmetrics.html.md): Some of the results of this diagnostics can also be reproduced utilizing - [Single Model Performance Index (SMPI)](recipes/recipe_smpi.html.md): This diagnostic calculates the Single Model Performance Index (SMPI) following Reichler and Kim (200... - [Climate model Weighting by Independence and Performance (ClimWIP)](recipes/recipe_climwip.html.md): Projections of future climate change are often based on multi-model - [Constraining future Indian Summer Monsoon projections with the present-day precipitation over the tropical western Pacific](recipes/recipe_li17natcc.html.md): Following Li et al. (2017) the change between present-day and future Indian Summer Monsoon (ISM) pre... - [Context for interpreting equilibrium climate sensitivity and transient climate response from the CMIP6 Earth system models](recipes/recipe_meehl20sciadv.html.md): This recipe reproduces the analysis of Meehl et al., Sci. Adv. (2020). In - [Emergent constraints for equilibrium climate sensitivity](recipes/recipe_emergent_constraints.html.md): Calculates equilibrium climate sensitivity (ECS) versus - [Emergent constraints on equilibrium climate sensitivity in CMIP5: do they hold for CMIP6?](recipes/recipe_schlund20esd.html.md): This recipe reproduces the analysis of Schlund et al., Earth Sys. Dyn. - [Emergent constraint on equilibrium climate sensitivity from global temperature variability](recipes/recipe_cox18nature.html.md): This recipe reproduces the emergent constraint proposed by Cox et al. (2018) - [Emergent constraint on snow-albedo effect](recipes/recipe_snowalbedo.html.md): The recipe recipe_snowalbedo.yml computes the springtime snow-albedo - [Equilibrium climate sensitivity](recipes/recipe_ecs.html.md): Equilibrium climate sensitivity is defined as the change in global mean - [KNMI Climate Scenarios 2014](recipes/recipe_kcs.html.md): This recipe implements the method described in Lenderink et al., 2014, to prepare the 2014 KNMI Clim... - [Transient Climate Response](recipes/recipe_tcr.html.md): The transient climate response (TCR) is defined as the global and annual mean - [Transient Climate Response to Cumulative CO<sub>2</sub> Emissions (TCRE)](recipes/recipe_tcre.html.md): The idea that global temperature rise is directly proportional to the total - [Climate model projections from the ScenarioMIP of CMIP6](recipes/recipe_tebaldi21esd.html.md): This recipe is implemented into ESMValTool to evaluate the temperature and precipitation changes fro... - [Climate Change Hotspot](recipes/recipe_climate_change_hotspot.html.md): In the context of a changing climate, it is found that - [Cloud properties and their projected changes in CMIP models with low to high climate sensitivity](recipes/recipe_bock24acp.html.md): The recipes recipe_bock24acp_\*.yml reproduce figures (Fig. 3, 4, 6 and 7) from the publication Bock... - [Zero Emissions Commitment (ZEC)](recipes/recipe_zec.html.md): The Zero Emissions Commitment (ZEC) quantifies the change in global mean - [Physical Climate at Global Warming Levels (GWLs)](recipes/recipe_calculate_gwl_exceedance_stats.html.md): This recipe calculates years of Global Warming Level (GWL) exceedances in CMIP - [IPCC AR6 Chapter 3 (selected figures)](recipes/recipe_ipccwg1ar6ch3.html.md): This recipe collects selected diagnostics used in IPCC AR6 WGI Chapter 3: - [IPCC AR5 Chapter 9 (selected figures)](recipes/recipe_ipccwg1ar5ch9.html.md): The goal of this recipe is to collect diagnostics to reproduce Chapter 9 of AR5, - [IPCC AR5 Chapter 12 (selected figures)](recipes/recipe_collins13ipcc.html.md): The goal is to create a standard recipe for creating selected Figures from - [Landcover - Albedo](recipes/recipe_albedolandcover.html.md): The diagnostic determines the coefficients of multiple linear regressions fitted between the albedo ... - [Turnover time of carbon over land ecosystems](recipes/recipe_carvalhais14nat.html.md): This recipe evaluates the turnover time of carbon over - [Hydrological models - data pre-processing](recipes/recipe_hydrology.html.md): We provide a collection of scripts that pre-processes environmental data for use in several hydrolog... - [Hydro forcing comparison](recipes/recipe_hydro_forcing.html.md): This recipe can be used to assess the agreement between forcing datasets - [Landcover diagnostics](recipes/recipe_landcover.html.md): The diagnostic computes the accumulated and fractional extent of major land cover classes, - [Land and ocean components of the global carbon cycle](recipes/recipe_anav13jclim.html.md): This recipe reproduces most of the figures of Anav et al. (2013): - [Runoff, Precipitation, Evapotranspiration](recipes/recipe_runoff_et.html.md): This diagnostic calculates biases of long-term climatological annual means of total runoff R, - [Climate drivers of fire](recipes/recipe_ref_fire.html.md): This diagnostic includes: - [Recipe for evaluating Arctic Ocean](recipes/recipe_arctic_ocean.html.md): The Arctic ocean is one of the areas of the Earth where the effects of climate change are especially... - [Climate Variability Diagnostics Package (CVDP)](recipes/recipe_cvdp.html.md): The Climate Variability Diagnostics Package (CVDP) developed by NCAR’s Climate Analysis Section is a... - [Nino indices, North Atlantic Oscillation (NAO), Souther Oscillation Index (SOI)](recipes/recipe_combined_indices.html.md): The goal of this diagnostic is to compute indices based on area averages. - [Ocean chlorophyll in ESMs compared to ESA-CCI observations.](recipes/recipe_esacci_oc.html.md): This recipe compares monthly surface chlorophyll from CMIP models to ESA CCI ocean colour chlorophyl... - [ENSO CLIVAR metrics - reproducing background climatology and ENSO characteristics](recipes/recipe_enso_ref.html.md): Reproducing some ENSO metrics from the - [ENSO CLIVAR metrics - reproducing ENSO characteristics, lifecycle, seasonality, teleconnections](recipes/recipe_enso_clivar.html.md): Reproducing ENSO metrics from the - [Ocean transport diagnostics](recipes/recipe_ocean_transport.html.md): This recipe computes three ocean transport diagnostics for a CMIP6 model: - [Ocean diagnostics](recipes/recipe_oceans.html.md): These recipes are used for evaluating the marine component of models of the - [Sea Surface Salinity Evaluation](recipes/recipe_sea_surface_salinity.html.md): This recipe compares the regional means of sea surface salinity with a - [Ocean metrics](recipes/recipe_russell18jgr.html.md): The Southern Ocean is central to the global climate and the global carbon cycle, and to the climate’... - [Capacity factor of wind power: Ratio of average estimated power to theoretical maximum power](recipes/recipe_capacity_factor.html.md): The goal of this diagnostic is to compute the wind capacity factor, taking as input the daily insta... - [CMORizer recipes](recipes/recipe_cmorizers.html.md): These are CMORizer recipes calling CMORizer diagnostic scripts. - [Ensemble Clustering - a cluster analysis tool for climate model simulations (EnsClus)](recipes/recipe_ensclus.html.md): EnsClus is a cluster analysis tool in Python, based on the k-means algorithm, for ensembles of clima... - [ESA CCI LST comparison to Historical Models](recipes/recipe_esacci_lst.html.md): This diagnostic compares ESA CCI LST to multiple historical emsemble members of CMIP models. - [Example recipes](recipes/recipe_examples.html.md): These are example recipes calling example diagnostic scripts. - [Timeseries for Arctic-Midlatitude Teleconnections](recipes/recipe_galytska23jgr.html.md): The recipe produces the timeseries of selected variables to study Arctic-midlatitude teleconnections... - [Multi-model products](recipes/recipe_multimodel_products.html.md): The goal of this diagnostic is to compute the multi-model ensemble mean for a set of models selected... - [Capacity factor for solar photovoltaic (PV) systems](recipes/recipe_pv_capacity_factor.html.md): This diagnostic computes the photovoltaic (PV) capacity factor, - [Sea Ice](recipes/recipe_seaice.html.md): The sea ice diagnostics include: - [Seaice drift](recipes/recipe_seaice_drift.html.md): This recipe allows to quantify the relationships between Arctic sea-ice drift - [Seaice feedback](recipes/recipe_seaice_feedback.html.md): In this recipe, one process-based diagnostic named the - [Sea Ice Sensitivity](recipes/recipe_seaice_sensitivity.html.md): This recipe and diagnostic calculates the rate of sea ice area loss per degree of warming, as in plo... - [Shapeselect](recipes/recipe_shapeselect.html.md): Impact modelers are often interested in data for irregular regions best defined by a shapefile. With... - [Short test versions of scientific recipes to check for backward compatibility.](recipes/recipes_testing.html.md): These recipes are created to cover typical functionalities in the ESMValTool and allow to test them ... - [Toymodel](recipes/recipe_toymodel.html.md): The goal of this diagnostic is to simulate single-model ensembles from an observational dataset to i... - [Legacy Recipes](recipes/legacy_recipe_list.html.md): Recipes that have been retired and are included for - [Legacy recipe: Diagnostics of stratospheric dynamics and chemistry](recipes/legacy/recipe_eyring06jgr.html.md): This recipe has been retired and moved to the folder “archive”. This recipe - [Legacy recipe: Ozone and associated climate impacts](recipes/legacy/recipe_eyring13jgr.html.md): This recipe has been retired and moved to the folder “archive”. This recipe - [Legacy recipe: Psyplot Diagnostics](recipes/legacy/recipe_psyplot.html.md): This recipe has been retired and moved to the folder “archive”. This recipe is only included - [Legacy recipe: RainFARM stochastic downscaling](recipes/legacy/recipe_rainfarm.html.md): This recipe has been retired and moved to the folder “archive”. This recipe is only included - [Legacy recipe: Constraining uncertainty in projected gross primary production (GPP) with machine learning](recipes/legacy/recipe_schlund20jgr.html.md): This recipe has been retired and moved to the folder “archive”. This recipe is only included - [Legacy Recipe: Standardized Precipitation-Evapotranspiration Index (SPEI)](recipes/legacy/recipe_spei.html.md): This recipe has been retired and moved to the folder “archive”. This recipe is only included - [Legacy recipe: Emergent constraints on carbon cycle feedbacks](recipes/legacy/recipe_wenzel14jgr.html.md): This recipe has been retired and moved to the folder “archive”. This recipe - [Legacy recipe: Multiple ensemble diagnostic regression (MDER) for constraining future austral jet position](recipes/legacy/recipe_wenzel16jclim.html.md): This recipe has been retired and moved to the folder “archive”. This recipe - [Legacy recipe: Projected land photosynthesis constrained by changes in the seasonal cycle of atmospheric CO<sub>2</sub>](recipes/legacy/recipe_wenzel16nat.html.md): This recipe has been retired and moved to the folder “archive”. This recipe - [Broken recipe list](recipes/broken_recipe_list.html.md): This table gives an overview of the recipes that are known to have issues. - [ESMValTool Code API Documentation](api/esmvaltool.html.md): ESMValTool is mostly used as a command line tool. However, it is also possible - [Shared diagnostic script code](api/esmvaltool.diag_scripts.shared.html.md): Code that is shared between multiple diagnostic scripts. - [Drought Diagnostics](api/esmvaltool.diag_scripts.droughts.html.md): The droughts module contains diagnostics for calculation and plotting of drought - [Drought Metrics following Martin (2018)](api/esmvaltool.diag_scripts.droughts/collect_drought.html.md): Compares SPI/SPEI data from models with observations/reanalysis. - [Difference Maps](api/esmvaltool.diag_scripts.droughts/diffmap.html.md): Plot relative and absolute differences between two time intervals. - [Emergent constraints diagnostics](api/esmvaltool.diag_scripts.emergent_constraints.html.md): This module provides various tools to evaluate emergent constraints for - [Emergent constraint on ECS from global temperature variability](api/esmvaltool.diag_scripts.emergent_constraints/cox18nature.html.md): Diagnostic script to reproduce emergent constraint of Cox et al. (2018). - [Calculation of emergent constraints on ECS](api/esmvaltool.diag_scripts.emergent_constraints/ecs_scatter.html.md): Diagnostic script to calculate various emergent constraints for ECS. - [Evaluate multiple emergent constraints simultaneously](api/esmvaltool.diag_scripts.emergent_constraints/multiple_constraints.html.md): Diagnostic script to evaluate multiple emergent constraints simultaneously. - [Evaluate single emergent constraint](api/esmvaltool.diag_scripts.emergent_constraints/single_constraint.html.md): Diagnostic script to evaluate a single emergent constraint. - [Auxiliary functions for emergent constraints scripts](api/esmvaltool.diag_scripts.emergent_constraints/init.html.md): Convenience functions for emergent constraints diagnostics. - [Calculating and displaying multiple representations of the CH4 lifetime](api/esmvaltool.diag_scripts.lifetime.html.md): Lifetime diagnostic to show multiple datasets in one plot. - [Monitor Diagnostic](api/esmvaltool.diag_scripts.monitor.html.md): This module provides various tools to monitor climate model simulations. - [Monitoring diagnostic to plot arbitrary preprocessor output](api/esmvaltool.diag_scripts.monitor/monitor.html.md): Diagnostic to plot preprocessor output. - [Monitoring diagnostic to plot EOF maps and associated PC timeseries](api/esmvaltool.diag_scripts.monitor/compute_eofs.html.md): Diagnostic to compute and plot the first EOF of an arbitrary input. - [Monitoring diagnostic to show multiple datasets in one plot (incl. biases)](api/esmvaltool.diag_scripts.monitor/multi_datasets.html.md): Monitoring diagnostic to visualize multiple datasets. - [Base class for monitoring diagnostics](api/esmvaltool.diag_scripts.monitor/monitor_base.html.md): Base class for monitoring diagnostics. - [Ocean diagnostics toolkit](api/esmvaltool.diag_scripts.ocean.html.md): Welcome to the API documentation for the ocean diagnostics tool kit. - [Seaborn Diagnostic](api/esmvaltool.diag_scripts.seaborn_diag.html.md): Create arbitrary Seaborn plots. - [Plotting 1D Histograms](api/esmvaltool.diag_scripts.plot_histogram.html.md): Diagnostic script that creates a 1D histogram plot for several datasets. - [Portrait Plot](api/esmvaltool.diag_scripts.portrait_plot.html.md): Portrait Plot Diagnostic. - [Transient Climate Response to Cumulative CO<sub>2</sub> Emissions (TCRE)](api/esmvaltool.diag_scripts.climate_metrics.tcre.html.md): Calculate Transient Climate Response to Cumulative CO2 Emissions (TCRE). - [Zero Emissions Commitment (ZEC)](api/esmvaltool.diag_scripts.climate_metrics.zec.html.md): Diagnostic script to calculate and plot ZEC. - [Hour of Maximum Precipitation](api/esmvaltool.diag_scripts.hydrology.hour_of_max_precipitation.html.md): Calculate and plot hour of daily maximum precipitation. - [Tropical CPT Hovmoeller Diagnostic](api/esmvaltool.diag_scripts.tropopause.cpt_hovmoeller.html.md): Create tropical CPT Hovmoeller plots with contour overlays. - [Obtaining input data](input.html.md): ESMValTool supports input data from climate models participating in - [Making a recipe or diagnostic](develop/index.html.md): * [Introduction](introduction.html.md) - [Introduction](develop/introduction.html.md): This chapter contains instructions for developing your own recipes and/or diagnostics. - [Recipe](develop/recipe.html.md): The user will need to write a basic recipe to be able to run their own personal diagnostic. - [Diagnostic](develop/diagnostic.html.md): Anyone can run a personal diagnostic, no matter where the location of it; - [Writing a CMORizer script for an additional dataset](develop/dataset.html.md): ESMValTool is designed to work with CF compliant - [Contributing to the community](community/index.html.md): **Contributions are very welcome!** - [Contributing code and documentation](community/code_documentation.html.md): If you would like to contribute a new diagnostic and recipe or a new feature, - [AI Policy](community/ai_policy.html.md): “AI” herein refers to generative AI tools like large language models (LLMs) - [Making a new diagnostic or recipe](community/diagnostic.html.md): Please discuss your idea for a new diagnostic or recipe with the development team before getting sta... - [Contributor License Agreement](community/contributor_license_agreement.html.md): We require developers to sign a Contributor License Agreement (CLA), - [ESMValTool policy on backward compatibility](community/backward_compatibility.html.md): Development of recipes or conducting project-related work may require a - [Broken/outdated recipe policy](community/broken_recipe_policy.html.md): Recipes might stop working for different reasons. Among those are, for instance, withdrawal of datas... - [Making a new dataset](community/dataset.html.md): If you are contributing a new dataset, please have a look at - [Support for multiple versions of a dataset](community/multiple_dataset_versions.html.md): If you plan to update a CMORizer script to support a newer version of an - [Review of pull requests](community/review.html.md): In the ESMValTool community we use pull request reviews to ensure all code and - [Maintaining a recipe](community/maintainer.html.md): As development of the ESMValTool continues, new features may be added, old ones replaced or retired ... - [GitHub Workflow](community/repository.html.md): The source code of the ESMValTool is hosted on GitHub. The following description gives an overview o... - [Moving work from the private to the public repository](community/private_repository.html.md): In case you develop a new diagnostic with the ESMValTool, and you plan on publishing the results of ... - [Release strategy and procedure](community/release_strategy/index.html.md): These pages detail the release strategy and technical procedures - [Release schedule and procedure for ESMValCore and ESMValTool](community/release_strategy/release_strategy.html.md): This document describes the process for the release of ESMValCore - [Release: recipes runs and comparison](community/release_strategy/detailed_release_procedure.html.md): The release procedure for ESMValTool is a fairly involved process (at the moment), so it - [Utilities](utils/utils.html.md): This section provides information on tools that are useful when developing - [Recipe Test Workflow (RTW)](utils/RTW/index.html.md): * Currently tested recipes - [About](utils/RTW/about.html.md): The Recipe Test Workflow (RTW) is a workflow that is used to regularly run - [Currently tested recipes](utils/RTW/tested_recipes.html.md): The recipes tested with the RTW at each site are defined in the following - [User Guide](utils/RTW/user_guide/index.html.md): * Quick Start Guide - [Quick Start Guide](utils/RTW/user_guide/quick_start.html.md): * Clone the ESMValTool repository (which contains the RTW): - [The workflow](utils/RTW/user_guide/workflow.html.md): The RTW performs the following steps: - [Running the [RTW](../glossary.html.md#term-RTW) on DKRZ in “production mode”](utils/RTW/user_guide/dkrz_production.html.md): “Production” is used to mean an intention to run the RTW - [How to add a recipe to the [RTW](glossary.html.md#term-RTW)](utils/RTW/add_a_recipe.html.md): To add a recipe to the RTW you will: - [Glossary](utils/RTW/glossary.html.md): : Coupled Model Intercomparison Project, see the CMIP Documentation. - [Frequently Asked Questions](faq.html.md): Yes, you can subscribe to the ESMValTool user mailing list and join the discussion on general topics... - [Changelog](changelog.html.md): - Preparation of recipes that are run by the Rapid Evaluation Framework (REF) for CMIP7. - [Support](support.html.md): Support for ESMValTool can be found in ESMValTool Discussions page - [Title of the tutorial](tutorials/template.html.md): Add content here.