Installation

System dependency

cslearn uses pygraphviz for graph visualisation, which requires graphviz to be installed on your system before installing the package.

On Debian/Ubuntu:

$ sudo apt install graphviz libgraphviz-dev pkg-config

On macOS (Homebrew):

$ brew install graphviz

On Windows, install graphviz from https://graphviz.org/download/ and ensure it is on your PATH.

Building this documentation additionally requires pandoc on your PATH (used by nbsphinx to render the example notebooks); on Debian/Ubuntu, sudo apt install pandoc. It is not needed to use the package.

Package installation

Install cslearn from PyPI:

$ pip install cslearn

Development installation

The development environment uses devenv, which also installs uv. With devenv installed, run from the repository root:

$ devenv shell

This activates the environment and runs uv sync --all-extras, installing all dependencies including the optional experiment extras.