Installation

Requirements

bpod-core requires Python 3.10 or later. It is supported on Linux, macOS, and Windows.

Virtual Environment

While optional, we recommend installing bpod-core into a dedicated virtual environment, isolating bpod-core and its dependencies from other Python projects, preventing version conflicts and keeping your system Python clean. We recommend using uv to manage Python environments. See uv’s documentation for installation instructions.

Creation

To create a virtual environment:

$ uv venv bpod-core --python 3.14

Activation

To activate the virtual environment:

$ source bpod-core/bin/activate

PS> bpod-core\Scripts\activate

Installing bpod-core

To install bpod-core and its dependencies into the active virtual environment:

$ uv pip install bpod-core

Note

Linux users: You may encounter permission errors when connecting to a Bpod device. See Frequently Asked Questions for instructions on installing the required udev rules.

Verifying the installation

After installation, run the bpod command-line tool:

$ bpod --version

This should print the installed version of bpod-core.

Updating

To update bpod-core to the latest release:

$ uv pip install --upgrade bpod-core