pineuro
Python for Individualized Neurofeedback
A Python library for real-time fMRI neurofeedback research. pineuro provides a complete pipeline from DICOM acquisition through preprocessing, network mask extraction, and moment-to-moment BOLD activation estimation, with a desktop GUI for study management and participant workflows.
Features
Core pipeline
- DICOM processing: Watch for incoming scanner DICOMs and process volumes as they arrive
- Preprocessing: Motion correction, brain extraction, and multi-run coregistration (ANTsPy)
- ICA mask extraction: Participant-specific network masks via ICA and Yeo atlas
- GLM mask extraction: Network masks from task localizer contrasts
- MNI atlas masks: Atlas-based ROIs without a localizer run
- Incremental GLM: Online activation estimation using Gentleman's algorithm
- Connectivity feedback: Real-time functional connectivity between network pairs
Study management
- Desktop GUI: Study configuration and participant workflows (
pineuro-gui) - Session orchestration: Multi-run and multi-session protocols
- Sham / control conditions: Sham feedback, replay providers, and randomization
- QC reports: HTML quality reports for each pipeline stage
Task framework
- Built-in tasks: Gauge (dual-network block design), ball (dual-network adaptive), thermometer (single-network), and RIT variants
- Task plugin system:
@pineuro_taskdecorator and entry-point registration - Simulation mode: Offline DICOM replay at configurable speed
Installation
Requires Python 3.10 or 3.11 (>=3.10,<3.12). All dependencies are pure pip; no external tools required.
pip install pineuro
See the Installation Guide for platform-specific notes (on Linux, install wxPython first), installing from source, and troubleshooting.
GUI
pineuro-gui
The desktop GUI provides study configuration, participant workflows, live activation plots, and QC reports. See the First Session Tutorial for a complete walkthrough.
Documentation
Getting started
- Installation: Setup and dependencies
- Quick Start: GUI quick start (with an API snippet)
- First Session: End-to-end GUI walkthrough
User guide: Full index
Pipeline Overview · Study Configuration · Preprocessing · Mask Extraction · Feedback Tasks · Tasks · Sham & Blinding · Multi-Session · Display Setup · Simulation Mode · QC Reports · Network Testing
Citation
If you use pineuro in your research, please cite:
Vandewouw, M. M. (2026). pineuro: Python for Individualized Neurofeedback.
https://github.com/WhitfieldGabrieli-EPICBrainLab/pineuro
License
Apache License 2.0. See LICENSE for details.
1 maintainer
Metadata
1 maintainer
Release files for pineuro 1.1.0
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 |
|---|---|---|---|---|
| pineuro-1.1.0.tar.gz | 663.8 kB | Without provenance | Details for pineuro-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pineuro-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for pineuro-1.1.0-py3-none-any.whl |
Total release size: 1.3 MB
Release files / pineuro-1.1.0.tar.gz
| Download URL | pineuro-1.1.0.tar.gz |
|---|---|
| Size | 663.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01af7606d61709bbd68e35f6f9771ec4ba1946cce7fe87479f1004d6149fc93b
|
|
BLAKE2b-256 checksum How to use checksums |
72142318f1499b74d163110d6a79ab633a1a06c3f6ccc32834d3a2cca22b604e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.11
|
Release files / pineuro-1.1.0-py3-none-any.whl
| Download URL | pineuro-1.1.0-py3-none-any.whl |
|---|---|
| Size | 648.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5728248e2dcb317baadf11bedf179f3f387f053a1c5303e66b0d6313f642c03f
|
|
BLAKE2b-256 checksum How to use checksums |
3e24fe72de64dfd8d920c737657869e8f3751769f957814c60bad9c0ca667842
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.11
|
Security for pineuro 1.1.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
