OverviewTeaching: 10 min
Exercises: 10 min
Compatibility: ESMValTool v2.8.0Questions
What are the prerequisites for installing ESMValTool?
How do I confirm that the installation was successful?Objectives
Demonstrate that the installation was successful
The instructions help with the installation of ESMValTool on operating systems like Linux/MacOSX/Windows. We use the Mamba package manager to install the ESMValTool. Other installation methods are also available; they can be found in the documentation. We will first install Mamba, and then ESMValTool. We end this chapter by testing that the installation was successful.
Before we begin, here are all the possible ways in which you can use ESMValTool depending on your level of expertise or involvement with ESMValTool and associated software such as GitHub and Mamba.
- If you have access to a server where ESMValTool is already installed
as a module, for e.g., the CEDA JASMIN
server, you can simply load the module with the following command:
module load esmvaltool
esmvaltool, we can start using ESMValTool right away. Please see the next lesson.
- If you would like to install ESMValTool as a mamba package, then this lesson will tell you how!
- If you would like to start experimenting with existing diagnostics or contributing to ESMvalTool, please see the instructions for source installation in the lesson Development and contribution and in the documentation.
Install ESMValTool on Windows
ESMValTool does not directly support Windows, but successful usage has been reported through the Windows Subsystem for Linux(WSL), available in Windows 10. To install the WSL please follow the instructions on the Windows Documentation page. After installing the WSL, installation can be done using the same instructions for Linux/MacOSX.
Install ESMValTool on Linux/MacOSX
ESMValTool is distributed using Mamba.
To install mamba on
MacOSX, follow the instructions below:
Please download the installation file for the latest Mamba version here.
Next, run the installer from the place where you downloaded it:
Follow the instructions in the installer. The defaults should normally suffice.
You will need to restart your terminal for the changes to have effect.
We recommend updating mamba before the esmvaltool installation. To do so, run:
mamba update --name base mamba
Verify you have a working mamba installation by:
This should show the path to your mamba executable, e.g.
For more information about installing mamba, see the mamba installation documentation.
Install the ESMValTool package
The ESMValTool package contains diagnostics scripts in four languages: R, Python, Julia and NCL. This introduces a lot of dependencies, and therefore the installation can take quite long. It is, however, possible to install ‘subpackages’ for each of the languages. The following (sub)packages are available:
esmvaltool–> the complete package, i.e. the combination of the above.
For the tutorial, we will install the complete package. Thus, to install the ESMValTool package, run
mamba create --name esmvaltool esmvaltool
On MacOSX ESMValTool functionalities in Julia, NCL, and R are not supported. To install a Mamba environment on MacOSX, please refer to specific information.
This will create a new Mamba
esmvaltool, with the ESMValTool package and all of its dependencies
installed in it.
You find a list of common installation problems and their solutions in the documentation.
Some ESMValTool diagnostics are written in the Julia programming language. If you want a full installation of ESMValTool including Julia diagnostics, you need to make sure Julia is installed before installing ESMValTool.
In this tutorial, we will not use Julia, but for reference, we have listed the steps to install Julia below. Complete instructions for installing Julia can be found on the Julia installation page.
Julia installation instructions
First, open a bash terminal and activate the newly created
conda activate esmvaltool
Next, to install Julia via
mamba, you can use the following command:
mamba install julia
To check that the Julia executable can be found, run
to display the path to the Julia executable, it should be
To test that Julia is installed correctly, run
to start the interactive Julia interpreter. Press
Test that the installation was successful
To test that the installation was successful, run
conda activate esmvaltool
to activate the conda environment called
esmvaltool. In the shell prompt the
active conda environment should have been changed from
to display the command line help.
Version of ESMValTool
Can you figure out which version of ESMValTool has been installed?
esmvaltool --helpcommand lists
versionas a command to get the version
When you run
The version of ESMValTool installed should be displayed on the screen as:
ESMValCore: 2.8.0 ESMValTool: 2.8.0
Note that on HPC servers such as JASMIN, sometimes a more recent development version may be displayed for ESMValTool, for e.g.
All the required packages can be installed using mamba.
You can find more information about installation in the documentation.