Skip to content

Commit a9e634f

Browse files
author
Remi Kazeroni
committed
cleanup section 2
1 parent 0c33b6f commit a9e634f

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

_episodes/07-development-setup.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Development and contribution"
33
teaching: 10
44
exercises: 20
5-
compatibility: ESMValTool v2.5.0
5+
compatibility: ESMValTool v2.9.0
66

77
questions:
88
- "What is a development installation?"
@@ -56,11 +56,12 @@ The ESMValTool source code is available on a public GitHub repository:
5656
[https://github.com/ESMValGroup/ESMValTool](https://github.com/ESMValGroup/ESMValTool).
5757
To obtain the code, there are two options:
5858

59-
1. download the code from the repository. A ZIP file called
59+
1. Download the code from the repository. A ZIP file called
6060
``ESMValTool-main.zip`` is downloaded. To continue the installation, unzip
6161
the file, move to the ``ESMValTool-main`` directory and then follow the
62-
sequence of steps starting from **2 ESMValTool dependencies**.
63-
2. clone the repository if you want to contribute to the ESMValTool development:
62+
sequence of steps starting from the section on
63+
**ESMValTool dependencies** below.
64+
2. Clone the repository if you want to contribute to the ESMValTool development:
6465

6566
~~~bash
6667
git clone https://github.com/ESMValGroup/ESMValTool.git
@@ -108,14 +109,23 @@ nothing to commit, working tree clean
108109

109110
### 2 ESMValTool dependencies
110111

112+
ESMValTool now uses `mamba` instead of `conda` for the recommended installation.
111113
It is recommended to use conda to manage ESMValTool dependencies. For a minimal
112-
conda installation, see section **Install Conda** in lesson
114+
mamba installation, see section **Install Mamba** in lesson
113115
[Installation]({{ page.root }}{% link _episodes/02-installation.md %}).
116+
117+
It is good practice to update the version of mamba on your machine before setting up
118+
ESMValTool. This can be done as follows:
119+
120+
~~~bash
121+
mamba update --name base mamba
122+
~~~
123+
114124
To simplify the installation process, an environment file ``environment.yml`` is
115125
provided in the ESMValTool directory. We create an environment by running:
116126

117127
~~~bash
118-
conda env create --file environment.yml
128+
mamba env create --name esmvaltool --file environment.yml
119129
~~~
120130

121131
The environment is called ``esmvaltool`` by default.
@@ -124,8 +134,10 @@ If an ``esmvaltool`` environment is already created following the lesson
124134
we should choose another name for the new environment in this lesson by:
125135

126136
~~~bash
127-
conda env create -n a_new_name --file environment.yml
137+
mamba env create --name a_new_name --file environment.yml
128138
~~~
139+
This will create a new conda environment and install ESMValTool into it with a
140+
single command.
129141

130142
For more information see [conda managing environments][manage-environments].
131143
Now, we should activate the environment:

0 commit comments

Comments
 (0)