Skip to content

Mention the esmvaltool-base package in the installation instructions #4595

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

Open
bouweandela wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −3
Open

Mention the esmvaltool-base package in the installation instructions #4595

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab4ac6d
Mention the esmvaltool-base package in the installation documentation
bouweandela Aug 24, 2026
e3ef4c7
Merge branch 'main' into add-docs-for-esmvaltool-base
valeriupredoi Sep 16, 2026
f6912d8
Apply suggestion from @valeriupredoi
bouweandela Sep 16, 2026
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: 14 additions & 3 deletions doc/sphinx/source/quickstart/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,14 @@ the instructions for
* :ref:`ESMValTool installation on Linux<install_on_linux>`
* :ref:`ESMValTool installation on MacOS<install_on_macosx>`.

Further options for installation are:
.. note::

A complete installation requires about 6 GB of disk space, while a minimal
installation (Python-only) requires about 2 GB of disk space. The ESMValTool package itself
is only a few MB in size, but it builds on many other software packages, which
are installed as dependencies.

Further options for installation are:

* :ref:`From the source code<install_from_source>` available at https://github.com/ESMValGroup/ESMValTool;
* :ref:`From pre-installed versions on HPC clusters<install_on_hpc>`;
Expand Down Expand Up @@ -192,9 +198,14 @@ Some of the CMORization scripts are written in Python, while others are written
in NCL. Therefore, both ``esmvaltool-python`` and ``esmvaltool-ncl`` need to be
installed in order to be able to run all CMORization scripts.

Note that the ESMValTool source code is contained in the ``esmvaltool-python``
If you need an installation of ESMValTool with a minimal set of dependencies,
you can install the ``esmvaltool-base`` package, which contains the core
functionality of ESMValTool and only the dependencies needed to run the
`example recipe <recipe_examples>`__ ``examples/recipe_python.yml``.

Note that the ESMValTool source code is contained in the ``esmvaltool-base``
package, so this package will always be installed as a dependency if you install
one or more of the packages for other languages.
one or more of the packages listed above.

.. _install_on_macosx:

Expand Down