Installation¶

Requirements¶

Calibre requires Python 3.10 or later.

The easiest way to install Calibre is from PyPI using pip:

pip install calibre

This will install Calibre along with all required dependencies:

To install the latest development version from source:

git clone https://github.com/finite-sample/calibre.git
cd calibre
pip install -e .

For development, install with additional development dependencies:

git clone https://github.com/finite-sample/calibre.git
cd calibre
pip install -e ".[dev]"

This includes:

To build the documentation locally:

pip install -e ".[docs]"

This includes:

To verify that Calibre is installed correctly:

import calibre
print(f"Calibre version: {calibre.__version__}")

You should see the version number printed without any errors.

ImportError: No module named ‘cvxpy’

This usually means CVXPY failed to install. Try installing it separately:

pip install cvxpy

Installation fails on macOS

If you encounter issues on macOS, try using conda instead:

conda install -c conda-forge cvxpy
pip install calibre

Memory errors during installation

If you encounter memory errors, try installing with pip’s no-cache option:

pip install --no-cache-dir calibre

If you encounter installation issues: