# bpod-core

> A modern Python interface for Bpod Finite State Machines.
> 
> ## Facts
> 
> - bpod-core is a Python library for defining and running behavioral experiments using Bpod Finite State Machines.
> - the current version of bpod-core is 0.1.0a14.
> - the documentation of bpod-core was last updated on September 17, 2026.
> - bpod-core requires Python 3.10 or newer.
> - bpod-core is compatible with Linux, macOS, and Windows.
> - bpod-core is compatible with Bpod r2.0 and newer. Older hardware revisions are not currently supported.
> - bpod-core uses different syntax from both Bpod MATLAB software and pybpod. The documentation of these projects is of limited relevance for bpod-core.
> 
> ## Links
> 
> - [source code of bpod-core](https://github.com/int-brain-lab/bpod-core)
> - [PyPI package of bpod-core](https://pypi.org/project/bpod-core)
> - [DOI for citing bpod-core](https://doi.org/10.5281/zenodo.21497456)
> - [JSON schema for state machines](https://raw.githubusercontent.com/int-brain-lab/bpod-core/main/.schema/statemachine.json)


2026, International Brain Laboratory

## Pages

- [bpod-core](https://int-brain-lab.github.io/bpod-core/index.html.md): A modern Python interface for Bpod Finite State Machines.
- [Installation](https://int-brain-lab.github.io/bpod-core/installation/index.html.md): How to install, verify and update bpod-core.
- [Finite-State Machines](https://int-brain-lab.github.io/bpod-core/state_machines/index.html.md): Creating, validating and visualizing finite-state machines with bpod-core.
- [Back Operator](https://int-brain-lab.github.io/bpod-core/state_machines/examples/back_operator/index.html.md): Exemplary Finite-State Machine: Back Operator
- [Conditions](https://int-brain-lab.github.io/bpod-core/state_machines/examples/conditions/index.html.md): Exemplary Finite-State Machine: Conditions
- [Global Counters](https://int-brain-lab.github.io/bpod-core/state_machines/examples/global_counters/index.html.md): Exemplary Finite-State Machine: Global Counters
- [Global Timers](https://int-brain-lab.github.io/bpod-core/state_machines/examples/global_timers/index.html.md): Exemplary Finite-State Machine: Global Timers
- [Light Chasing](https://int-brain-lab.github.io/bpod-core/state_machines/examples/light_chasing/index.html.md): Exemplary Finite-State Machine: Light Chasing
- [TTL Triggered State Change](https://int-brain-lab.github.io/bpod-core/state_machines/examples/ttl_triggered_state_change/index.html.md): Exemplary Finite-State Machine: TTL Triggered State Change
- [Two Choice](https://int-brain-lab.github.io/bpod-core/state_machines/examples/two_choice/index.html.md): Exemplary Finite-State Machine: Two Choice
- [Using the Bpod Class](https://int-brain-lab.github.io/bpod-core/bpod_class/index.html.md): Using the Bpod class to connect to a device and run state machines.
- [Data Format](https://int-brain-lab.github.io/bpod-core/data_format/index.html.md): The tabular data format of trial data returned by bpod-core.
- [Frequently Asked Questions](https://int-brain-lab.github.io/bpod-core/faq/index.html.md): Frequently asked questions about bpod-core.
- [Changelog](https://int-brain-lab.github.io/bpod-core/changelog/index.html.md): Release notes for bpod-core.
- [Contributing](https://int-brain-lab.github.io/bpod-core/contributing/index.html.md): How to contribute to bpod-core.
- [Inter-Process Communication](https://int-brain-lab.github.io/bpod-core/ipc/index.html.md): Sharing a single Bpod device between processes over ZeroMQ.
- [API](https://int-brain-lab.github.io/bpod-core/api/index.html.md): API reference for bpod-core.
- [bpod_core](https://int-brain-lab.github.io/bpod-core/api/bpod_core/index.html.md): API reference for bpod_core.
- [bpod_core.bpod](https://int-brain-lab.github.io/bpod-core/api/bpod_core.bpod/index.html.md): API reference for bpod_core.bpod.
- [bpod_core.bpod.abc](https://int-brain-lab.github.io/bpod-core/api/bpod_core.bpod.abc/index.html.md): API reference for bpod_core.bpod.abc.
- [bpod_core.bpod.constants](https://int-brain-lab.github.io/bpod-core/api/bpod_core.bpod.constants/index.html.md): API reference for bpod_core.bpod.constants.
- [bpod_core.bpod.structs](https://int-brain-lab.github.io/bpod-core/api/bpod_core.bpod.structs/index.html.md): API reference for bpod_core.bpod.structs.
- [bpod_core.com](https://int-brain-lab.github.io/bpod-core/api/bpod_core.com/index.html.md): API reference for bpod_core.com.
- [bpod_core.constants](https://int-brain-lab.github.io/bpod-core/api/bpod_core.constants/index.html.md): API reference for bpod_core.constants.
- [bpod_core.fsm](https://int-brain-lab.github.io/bpod-core/api/bpod_core.fsm/index.html.md): API reference for bpod_core.fsm.
- [bpod_core.ipc](https://int-brain-lab.github.io/bpod-core/api/bpod_core.ipc/index.html.md): API reference for bpod_core.ipc.
- [bpod_core.misc](https://int-brain-lab.github.io/bpod-core/api/bpod_core.misc/index.html.md): API reference for bpod_core.misc.

## Optional

- [llms-full.txt](https://int-brain-lab.github.io/bpod-core/llms-full.txt): Complete documentation in a single file.