Installation

Prerequisites

• Python >=3.10
• git
• ffmpeg (optional, required only for --format mp4 or --format webm)

Get the Source

Clone the project from GitLab, then enter the repository:

git clone git@gitlab.in2p3.fr:dudouet/NucShaper.git
cd NucShaper

Recommended Option (Project Wrapper)

The wrapper handles .venv automatically and runs the CLI:

./scripts/nucshape --help

Manual Option (Explicit venv)

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .
python -m nucshape.cli --help

Web Documentation

python -m pip install -e ".[docs]"
mkdocs serve

Verification

./scripts/nucshape themes
python -m unittest discover -s tests -p "test_*.py" -v