Installation

Install dependencies

To install dependencies for PCBooth on a Debian/Ubuntu-based system, run the following commands:

sudo apt update
sudo apt install python3.11 python3.11-venv pip ffmpeg
python3 -m pip install --user pipx
python3 -m pipx ensurepath

Configure PATH

Make sure that the directory /home/[username]/.local/bin is present in your PATH. You can do this by running the following in your shell:

export PATH=$HOME/.local/bin:$PATH

Clone and install pcbooth

Install pcbooth:

python3.11 -m pipx install 'git+https://github.com/antmicro/pcbooth.git'

Note

For developers, it is recommended to clone the repository and install PCBooth in editable mode:

git clone https://github.com/antmicro/pcbooth.git
cd pcbooth
python3.11 -m pipx install --editable .

This installs the required dependencies and installs PCBooth into its own virtual environment. PCBooth depends on the bpy package in version 4.1 to interact with Blender, which is currently only compatible with Python 3.11.


Last update: 2025-01-28