# Welcome to ESMValCore’s documentation!

**ESMValTool** is a community diagnostics and performance metrics tool for the evaluation of Earth System Models (ESMs) that allows for
routine comparison of models and observations. It includes a large collection of community recipes and observation data formatters to CMOR standards.

**ESMValCore** is a software package which provides the core functionality for ESMValTool. It is a workflow to find CMIP data, and apply
commonly used pre-processing functions.

To get a first impression of what ESMValTool and ESMValCore can do for you,
have a look at our blog posts
[Analysis-ready climate data with ESMValCore](https://blog.esciencecenter.nl/easy-ipcc-powered-by-esmvalcore-19a0b6366ea7)
and
[ESMValTool: Recipes for solid climate science](https://blog.esciencecenter.nl/esmvaltool-recipes-for-solid-climate-science-da5b33814f69).

## Basic documentation schema

This gives a brief idea of topics in each of the packages to help find information. As ESMValTool encompasses ESMValCore there will be some overlap between them.
ESMValCore can be used without ESMValTool such as in a Jupyter notebook.
For more detailed information, see documentation navigation to the left. Please also see
[ESMValTool documentation](https://docs.esmvaltool.org/en/latest/index.html).

![Brief topics for tool and core.](figures/ESMValSchemaDiagram.png)

## Learning resources:

A carpentries tutorial is available on [https://tutorial.esmvaltool.org](https://tutorial.esmvaltool.org).

A series of video lectures has been created by [ACCESS-NRI](https://access-nri.org.au).
While these are tailored for ACCESS users, they are still very informative.

<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=pUXrXB8C8bLRfQHY&amp;list=PLFjfi2xLaFpJp59LvDc1upQsj_xzFlFLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

## How to contribute

Refer to ESMValTool contributing to the community for a guide on contributing recipes and diagnostics.

Refer to ESMValCore [Contributing](contributing.html.md#contributing)  for information on contributing code.

## Get in touch!

Contact information is available [here](https://docs.esmvaltool.org/en/latest/support.html#support-and-contact).

## Indices and tables

* [Index](genindex.html.md)
* [Search Page](search.html.md)