bpod-gui

---

bpod-gui is a Python package that provides a set of standardized GUIs for interacting with the Bpod Finate State Machine from Sanworks.

This package relies on the bpod-core package created by the International Brain Lab.

---

Development Setup

We utilize uv developed by astral to manage dependencies, Python versions, and environments.

Instructions:

1. Install the Python 3.13 binaries by running uv python install 3.13
2. Clone the repository using git clone git@github.com:olfactorybehaviorlab/bpod-gui
3. Within the newly cloned repository run uv venv --python=3.13 bpod-gui-env
4. In the same directory, run uv sync to install the pinned version of the dependencies from the uv.lock file
5. In the same directory, run uv pip install -e . to install the package in editable for development