Thalamus — real-time, closed-loop, multimodal data acquisition

Real-time, synchronized, closed-loop multimodal data acquisition — built for the operating room and the research lab.

Release Python Platforms License Docs Paper

Quick Start · How it works · Node Reference · Examples · Paper

Thalamus is an open-source platform for real-time, synchronized, closed-loop multimodal data capture, specifically tailored to meet the stringent demands of neurosurgical environments — while serving equally well in the research lab.

What's new

Highlights from the most recent releases (see CHANGELOG.md for the full history):

  • Behavioral tasks — author and run trial-based experiments with the Task Controller: a Qt task runtime, a library of ready paradigms, and a simple async task API.
  • Eye calibration — an interactive calibration tool that maps raw eye-camera signal to gaze/screen coordinates (Projective and Angular-Scaling models, point nudging, undo/redo, reward delivery).
  • Live state editing — inspect and change a running pipeline's configuration from the command line with the registry tool.
  • Extensible plugins — the plugin API lets native extensions read analog data from other nodes and inject data back in.
  • Reproducible recordings — every recording now stores the build type, version, and git commit, and archives the exact task code that ran.

How it works

Thalamus assembles experiments from a pipeline of nodes. Each node is a small, configurable unit that plays one of four roles:

Role Does Examples
🟢 Generators produce data WAVE, NIDAQ, INTAN, SPIKEGLX, GENICAM
🔵 Consumers record / output data STORAGE2, LOG, NIDAQ_OUT, OPHANIM
🟣 Transformers consume → produce data OCULOMATIC, ALGEBRA, LUA, NORMALIZE, ARUCO
🟠 Controllers coordinate the pipeline RUNNER2, TASK_CONTROLLER

You build an experiment by adding nodes, configuring them, and subscribing consumers to the producers they care about. Recorded data is written to a compact .tha capture file and converted to analysis-friendly formats (HDF5, CSV, Parquet, …) with the bundled tooling. See the Node Reference for the full catalog of node types and the Concepts guide for the data model and file format.

Overview

Thalamus facilitates the advancement of clinical applications of Brain-Computer Interface (BCI) technology by integrating behavioral and electrophysiological data streams.

Design requirements Thalamus prioritizes
  1. Requires minimal setup within an operating room, clinical and research environment and could be easily controlled and quickly modified by the experimenter​
  2. Operated with high reliability with few crashes​
  3. Fail-safe architecture that guarantees minimal data loss in the setting of a crash​
  4. Allows for real-time computation to support visualizations of research and clinical data streams​
  5. Closed-loop control based on research and/or clinical data streams​
  6. Acquires synchronous data from the available research and clinical sensors including relevant behavioral, physiologic, and neural sensors that could easily be scaled over time​
  7. Supports a high-bandwidth, low latency, parallel distributed architecture for modular acquisition and computation that could easily be upgraded as technology continues to advance​
  8. Open-source with source code available to support research use​
  9. Embodies best practice in software engineering using unit tests and validation checks​
  10. Supports advances in translational applications and, hence, also operates in research domains​

Installation

Download the wheel for your platform from the Releases page (or the Actions tab). The package is published as thalamus_neuro; the importable module remains thalamus. Builds are provided for Linux (manylinux), Windows (10+), and macOS (arm64). Thalamus requires Python 3.10+.

We recommend a virtual environment so the bundled grpc version is not disturbed:

python -m venv venv-thalamus
source venv-thalamus/bin/activate        # Linux/macOS
call venv-thalamus/scripts/activate      # Windows

Then install the wheel for your platform, for example:

# Linux
python -m pip install thalamus_neuro-1.0.16-py3-none-manylinux_2_39_x86_64.whl
# Windows
python -m pip install thalamus_neuro-1.0.16-py3-none-win_amd64.whl
# macOS (arm64)
python -m pip install thalamus_neuro-1.0.16-py3-none-macosx_12_0_arm64.whl

Note — Drivers and runtimes for third-party devices (e.g. GenTL/GenICam cameras, National Instruments DAQs) must be installed separately. Thalamus itself only needs a standard computer with enough RAM for in-memory operation.

Run

python -m thalamus.pipeline            # Data pipeline (no task controller)
python -m thalamus.task_controller     # Data pipeline and task controller
python -m thalamus.hydrate FILE        # Convert a .tha capture file to HDF5
python -m thalamus.dataframe ...        # Export a node's data to CSV/Parquet/…
python -m thalamus.record_reader2 FILE  # Inspect the contents of a .tha file

Documentation

Full documentation lives at https://cajigaslab.github.io/Thalamus/:

  • Quick Start — install, build a pipeline, record, and analyze your first dataset.
  • Concepts & Architecture — the node pipeline, data model, capture-file format, and tooling.
  • Examples — runnable, copy-paste tutorials (including a hardware-free walkthrough).
  • Node Reference — every node type and its configuration.

Runnable example scripts also live in the examples/ folder. For the figures in our paper, see the SimpleUseCase folder. Release history is in CHANGELOG.md.

Contributing

Like all open-source projects, Thalamus benefits from your involvement, suggestions, and contributions. Use the Issues tab to report bugs and request features, and see CONTRIBUTING.md for the repository layout, development setup, how to add a new node type, and the pull-request and release process.

License & citation

Thalamus is released under the GPL-3.0 license (see LICENSE). If you use Thalamus in your work, please cite our paper:

Thalamus: a real-time, closed-loop platform for synchronized multimodal data acquisition. Communications Engineering (Nature). https://www.nature.com/articles/s44172-026-00646-z

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.0.44)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for jarlhaggerty from gravatar.com jarlhaggerty

Credits

Maintainer: Jarl Haggerty

License expression

GPL-3.0-only
View SPDX License List

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

thalamus_neuro-1.0.31-py3-none-win_amd64.whl (43.0 MB view details)

Uploaded Python 3Windows x86-64

thalamus_neuro-1.0.31-py3-none-manylinux_2_39_x86_64.whl (39.9 MB view details)

Uploaded Python 3manylinux: glibc 2.39+ x86-64

thalamus_neuro-1.0.31-py3-none-macosx_12_0_arm64.whl (24.7 MB view details)

Uploaded Python 3macOS 12.0+ ARM64

File details

Details for the file thalamus_neuro-1.0.31-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for thalamus_neuro-1.0.31-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 97c2a931899f159acc0b41a1270a691292332c6cbca48a6f4b46de9be2979265
MD5 f8bc17cb6bad507dc265d7f55a250553
BLAKE2b-256 31c30a1145dd47e9dce6f2e60f8e010e788de9863dd396ddbfafdd3ca8769d20

See more details on using hashes here.

File details

Details for the file thalamus_neuro-1.0.31-py3-none-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for thalamus_neuro-1.0.31-py3-none-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 12e35699a33bb0cc599a6700d999402d1a11e0ea6521ce9958d552702c204893
MD5 809b13ee34f5df8709dd1506ad66fc19
BLAKE2b-256 dd4249f3d07e7e1e659d9551704d83f41505f0e12fdbcabb20bb14a7062f8033

See more details on using hashes here.

File details

Details for the file thalamus_neuro-1.0.31-py3-none-macosx_12_0_arm64.whl.

File metadata

File hashes

Hashes for thalamus_neuro-1.0.31-py3-none-macosx_12_0_arm64.whl
Algorithm Hash digest
SHA256 0d865f3b40bdaf0e608c9f0432b3e7eedcbf654eeaefc1eb6126a76be5c8af42
MD5 1c432ef6e3834efcc4f09f50eb8cc44b
BLAKE2b-256 7ce0435b9e1c2c202e349a090f22f940a38a2945571ee55dafa8094c0b26d23d

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.44

3 files

1.0.43

3 files

1.0.42

3 files

1.0.41

3 files

1.0.40

3 files

1.0.39

3 files

1.0.37

3 files

1.0.36

3 files

This release

1.0.31 This release

3 files

1.0.29

3 files

1.0.28

3 files

1.0.27

3 files

1.0.25

3 files

1.0.24

3 files

1.0.22

3 files

1.0.20

3 files

1.0.19

3 files

1.0.18

3 files

1.0.17

3 files

1.0.16

3 files

1.0.15

3 files

1.0.14

3 files

1.0.13

3 files

1.0.12

3 files

1.0.11

3 files

1.0.6

3 files

1.0.4

3 files

1.0.3

3 files

1.0.2

3 files

1.0.1

3 files

0.3.51

3 files

0.3.50

3 files

0.3.49

3 files

0.3.48

3 files

0.3.47

3 files

0.3.46

3 files

0.3.44

3 files

0.3.43

3 files

0.3.42

3 files

0.3.41

3 files

0.3.40

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page