Skip to content

Update "Development and contribution" episode for v2.13.0 #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 25, 2025
Merged

Update "Development and contribution" episode for v2.13.0 #384

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba14d87
update episode
LisaBock Nov 20, 2025
71a4102
fix too long line
LisaBock Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions _episodes/07-development-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Development and contribution"
teaching: 10
exercises: 20
compatibility: ESMValTool v2.9.0
compatibility: ESMValTool v2.13.0

questions:
- "What is a development installation?"
Expand Down Expand Up @@ -116,11 +116,11 @@ following the lesson
[Installation]({{ page.root }}{% link _episodes/02-installation.md %}),
we should choose another name for the new environment in this lesson.

ESMValTool now uses `mamba` instead of `conda` for the recommended installation.
ESMValTool uses `mamba` for the recommended installation.
For a minimal mamba installation, see section **Install Mamba** in lesson
[Installation]({{ page.root }}{% link _episodes/02-installation.md %}).

It is good practice to update the version of mamba and conda on your machine before
It is good practice to update the version of mamba on your machine before
setting up ESMValTool. This can be done as follows:

~~~bash
Expand All @@ -145,7 +145,8 @@ mamba env create --name a_new_name --file environment.yml
This will create a new conda environment and install ESMValTool (with all
dependencies that are needed for development purposes) into it with a single command.

For more information see [conda managing environments][manage-environments].
For more information see
[Mamba User Guide](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html).

Now, we should activate the environment:

Expand Down Expand Up @@ -179,9 +180,6 @@ If the installation is successful, ESMValTool prints a help message to the conso
> the ``esmvaltool`` environment.
> Use this command to check that ESMValTool is installed in a ``develop`` mode.
>
> **Tip**: see the
> [documentation on conda list](https://docs.conda.io/projects/conda/en/latest/commands/list.html).
>
>> ## Solution
>>
>> Run:
Expand All @@ -202,7 +200,7 @@ If the installation is successful, ESMValTool prints a help message to the conso

The ``main`` branch has the latest features of ESMValTool. Please make sure
that the source code on your machine is up-to-date. If you obtain the source
code using git clone as explained in step **1 Source code**, you can run ``git pull``
code using git clone as explained in section **1 Source code**, you can run ``git pull``
to update the source code. Then ESMValTool installation will be updated
with changes from the ``main`` branch.

Expand Down Expand Up @@ -276,7 +274,8 @@ The good news is that ``pre-commit`` has been already installed
when we chose development installation.
``pre-commit`` is a command line and runs all of those tools. It also fixes some of those errors.
To explore other tools, have a look at ESMValTool documentation on
[Code style](https://docs.esmvaltool.org/en/latest/community/introduction.html#code-style).
[Code quality](https://docs.esmvaltool.org/en/latest/community/
code_documentation.html#code-quality).

> ## Using pre-commit
>
Expand Down