Installation

To install cabaret, you need Python 3.11 or newer.

Cabaret can be installed using pip

pip install cabaret          # basic installation
pip install "cabaret[plot]"  # with matplotlib for plotting

or from sources

git clone https://github.com/ppp-one/cabaret.git
cd cabaret
pip install .

For development, we recommend uv

git clone https://github.com/ppp-one/cabaret.git
cd cabaret
uv sync --dev          # installs the package + dev + test dependencies
uv sync --group docs   # additionally install documentation dependencies