Skip to content

antmicro/pcbooth

Repository files navigation

PCBooth

Copyright (c) 2022-2025 Antmicro

This tool is an open source utility for aiding Blender scene setup and running render jobs for Blender models in various image and video output formats. The tool is designed to visualize PCB-related models in .blend format. Currently pcbooth supports Blender 4.1+.

Installation

Requirements

pcbooth depends on the following packages:

  • python3.11, pip, pipx, ffmpeg

Additionally to preview and modify the generated .blend file, Blender 4.x needs to be installed.

Installation (Debian)

  1. Install the dependencies:

    sudo apt-get update
    sudo apt install python3.11 python3.11-venv pip ffmpeg
    python3 -m pip install --user pipx
    python3 -m pipx ensurepath
  2. Configure PATH:

    export PATH=$HOME/.local/bin:$PATH
  3. Clone and install pcbooth:

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

Usage

Please check the pcbooth documentation for more guidelines.

To display available functionalities of pcbooth, run:

pcbooth --help

For more information about using Blender, visit the Blender documentation.

License

The pcbooth utility is licensed under the Apache-2.0 license.