Advanced installation

Valenspy is a Python package but has some non-python dependencies. Therefore, the easist way to install ValEnsPy is to use conda.

Dependencies

ValEnsPy officially supports Python 3.10 and above. Its main dependencies are xarray (>v2025.03.0 for DataTree support) and dask. Additionally, ValEnsPy utilizes the existing ecosystem of xarray based weather and climate packages, including xesmf, xclim, and intake-esm. Therefore, Valenspy has a non-python dependency through xesmf, namely ESMF (esmpy). However, if regridding functionality is not needed, ValEnsPy can be installed and used without ESMF.

Installing with conda

To install with conda ensure that you have either Miniconda or Anaconda installed, then run the following command in your terminal:

This will install ValEnsPy and all its dependencies, including ESMF (esmpy) if it is not already installed in the environment.

Installing with pip

Valenspy can be installed via pip from PyPI.

Warning

Installing ValEnsPy with pip will not install ESMF (esmpy). If you require regridding functionality, either install esmpy in your environment seperately or use conda to install ValEnsPy.

In your terminal run the following command:

Installing on Windows

ValEnsPy is not yet fully supported on Windows because the xesmf package (in particular the ESMF dependency) is not supported on Windows. If you are using Windows and do not require regridding functionality, you can install ValEnsPy using pip without installing ESMF (esmpy) separately. If the regridding functionality is we recommend using a Linux or MacOS environment.

Installation from source

#WIP - link to developer guide/contributing pages

Testing the installation

#WIP