https://github.com/int-brain-lab/bpod-core

A Python library for communicating with the Bpod Finite State Machine
https://github.com/int-brain-lab/bpod-core

behavior bpod experiment science state-machine

Last synced: about 2 months ago
JSON representation

A Python library for communicating with the Bpod Finite State Machine

• Host: GitHub
• URL: https://github.com/int-brain-lab/bpod-core
• Owner: int-brain-lab
• License: mit
• Created: 2023-07-25T16:53:36.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-27T12:48:17.000Z (about 2 months ago)
• Last Synced: 2026-02-27T15:16:06.731Z (about 2 months ago)
• Topics: behavior, bpod, experiment, science, state-machine
• Language: Python
• Homepage: https://int-brain-lab.github.io/bpod-core/
• Size: 1.29 MB
• Stars: 4
• Watchers: 5
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  



# bpod-core

A Python library for communicating with the [*Bpod Finite State Machine*](https://sanworks.io/).

> [!WARNING]

> bpod-core is under development and not yet ready for production use.

This project is maintained by the software development team at the

[*International Brain Lab*](https://internationalbrainlab.org/).

## 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.

## Links

* [Documentation and API reference](https://int-brain-lab.github.io/bpod-core)

* [Bpod Wiki](https://sanworks.github.io/Bpod_Wiki) - maintained by [*Sanworks*](https://sanworks.io/)

* [PyBpod](https://pybpod.readthedocs.io) - another Python project for Bpod devices

---

[![CI](https://github.com/int-brain-lab/bpod-core/actions/workflows/main.yaml/badge.svg)](https://github.com/int-brain-lab/bpod-core/actions/workflows/main.yaml)

[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)

[![Coverage Status](https://coveralls.io/repos/github/int-brain-lab/bpod-core/badge.svg?branch=main)](https://coveralls.io/github/int-brain-lab/bpod-core?branch=main)

[![License](https://img.shields.io/github/license/int-brain-lab/bpod-core)](https://github.com/int-brain-lab/bpod-core/blob/main/LICENSE)

[![GitHub tag](https://img.shields.io/github/v/tag/int-brain-lab/bpod-core)](https://github.com/int-brain-lab/bpod-core/tags)

[![PyPI](https://img.shields.io/pypi/v/bpod-core)](https://pypi.org/project/bpod-core/)