This release is a pre-release and may not be stable for production use.
bpod-core
A modern Python interface for Bpod Finite State Machines.
bpod-core is a Python library for running behavioral experiments on Bpod hardware. You describe the trial logic as a finite state machine; bpod-core validates it, runs it on a connected Bpod device, and returns every recorded event with precise timestamps as an analysis-ready data frame.
Bpod Finite State Machines are an open-source platform by Sanworks for controlling behavioral experiments: a microcontroller-based finite state machine that runs the trial logic in real time and talks to sensors, valves, and other peripherals with deterministic millisecond-scale timing. Running the state machine on dedicated microcontroller hardware, rather than a general-purpose computer, keeps time-critical trial execution isolated from operating-system scheduling jitter. This makes Bpod particularly well-suited to closed-loop experiments, where state transitions must be triggered by sensor readings within a tight, predictable latency.
bpod-core grew out of the need for a modern, well-tested way to work with Bpod devices from Python, and is designed to fit naturally into everyday research workflows. It is maintained by the software development team at the International Brain Laboratory.
Goals
- Interface to Bpod Devices: Provides an interface for interacting with Bpod devices.
- State Machine Management: Offers capabilities to define, validate, and run state machines.
- Standalone or Library Use: Can function independently or be integrated as a library within other projects.
- Performance-Oriented: Designed to be lean and fast.
- Quality Assurance: Typed, tested, and documented.
Non-Goals
- No GUI: Does not include a graphical user interface.
- Limited High-Level Functionality: Does not provide features such as data management, configuration, or calibration.
- No Specific Module Support: Does not implement support for specific Bpod modules.
Installation
bpod-core is available on PyPI:
pip install bpod-core
See the installation guide for requirements and recommended setup.
Feedback and Contributing
Report bugs and request features on the issue tracker. To contribute, see the contributing guide.
Links
- bpod-core documentation – the official documentation of bpod-core.
- Bpod Wiki – maintained by Sanworks.
- PyBpod – another Python project for Bpod devices maintained by the Champalimaud Foundation.
Release files for bpod-core 0.1.0a15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bpod_core-0.1.0a15.tar.gz | 296.3 kB | With provenance | Details for bpod_core-0.1.0a15.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bpod_core-0.1.0a15-py3-none-any.whl | Python 3 | none | any | Details for bpod_core-0.1.0a15-py3-none-any.whl |
Total release size: 402.9 kB
Release files / bpod_core-0.1.0a15.tar.gz
| Download URL | bpod_core-0.1.0a15.tar.gz |
|---|---|
| Size | 296.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
407bf6f1aec2639d8403b519b07d1b98e92de69644f8beeac2d4c2ee25490648
|
|
BLAKE2b-256 checksum How to use checksums |
75bb15e8e9607a34863e49b4ba0d5d67332852d83c74b6981052f55ec2028921
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logRelease files / bpod_core-0.1.0a15-py3-none-any.whl
| Download URL | bpod_core-0.1.0a15-py3-none-any.whl |
|---|---|
| Size | 106.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ff38f2fd649aa77b5a3d94ed469a2abcf97f7113dde5599801d18fa981046397
|
|
BLAKE2b-256 checksum How to use checksums |
6d9b2bf9cb1c1d6a6c01d5bc3f8d3e76f4949336dfb09873f58a7b9ee19e6117
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logSecurity for bpod-core 0.1.0a15
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for bpod_core-0.1.0a15.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
