Installation¶

Requirements¶

ChArUcal requires Python 3.12 or later. The following packages are installed automatically:

pip install charucal

Or with uv:

uv add charucal

Virtual environments

Always install into a virtual environment to avoid conflicts with other packages.

python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install charucal

To get the latest unreleased changes, install directly from GitHub:

pip install git+https://github.com/HeadTriXz/charucal.git

charucal --help

You should see the top-level help text listing the calibrate and preview sub-commands.

Head to the Quick Start guide to run your first calibration.