ESMValTool Tutorial#

This tutorial helps you to use ESMValTool.

The Earth System Model Evaluation Tool (ESMValTool) is a community developed software toolkit that aims to facilitate the diagnosis and evaluation of the causes and effects of model biases and inter-model spread within the CMIP model ensemble.

This tutorial is structured into basic and advanced topics such that episodes starting from the Introduction up to the episode on Conclusion of the basic tutorial all cover basic topics and can be done in one sitting.

The remaining episodes cover the advanced topics and each episode is a mini-tutorial covering an advanced aspect of working with ESMValTool. These mini-tutorials can be appended to the main tutorial or worked through independently.

What will you learn in this course

  • What is ESMValTool

  • How to install ESMValTool

  • How to configure ESMValTool for your local system

  • How to run ESMValTool

  • How to work with ESMValTool’s suite of preprocessors

  • How to debug your recipes

  • How to access and deploy recipes from the ESMValTools gallery (Advanced)

  • How to develop your own diagnostics and recipes (Advanced)

  • How to contribute your recipes and diagnostics back into ESMValTool (Advanced)

  • How to include new observational datasets (Advanced)

  • How to handle errors and warnings (Advanced)

  • How to use ESMValCore API with Jupyter notebooks (Advanced)

Prerequisites

The prerequisites for the tutorial are listed on the tutorial setup page.

Main things you need to know before starting this course#

  1. This tutorial can be taken online independently or taught by one of our instructors.

  2. Don’t be alarmed if you can’t work through the entire tutorial in one sitting. It may take some time to get used to working with ESMValTool.

  3. If you get stuck, help is always available from the tutors, from ESMValTool developers via the github issues page or via the ESMValTool discussion page.

  4. This tutorial includes several advanced lessons after the conclusion. These advanced lessons should be treated like “mini-tutorials”, and include aspects like Developing your own diagnostic or How to include observations.

How to cite the tutorial#

Please use citation information available at https://doi.org/10.5281/zenodo.3974591.

Schedule#

Setup

Download files required for the lesson

00:00

What is ESMValTool?
Who are the people behind ESMValTool?
00:15



What is the purpose of the quickstart guide?
How do I load and check the ESMValTool environment?
How do I configure ESMValTool?
How do I run a recipe?
00:25

What are the prerequisites for installing ESMValTool?
How do I confirm that the installation was successful?

00:45

Configuration

What is the user configuration file and how should I use it?

01:10

How to run a recipe?
What happens when I run a recipe?
01:40




What do I do now?
Where can I get help?
What if I find a bug?
Where can I find more information about ESMValtool?
How can I cite ESMValtool?

The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor and how fast you work your way through the different episodes.