Skip to main content

A Gymnasium platform for reinforcement learning in brain-computer interfaces

Project description

NeuroSim

A Gymnasium Platform for Reinforcement Learning in Brain-Computer Interfaces

Python 3.10+ License: MIT Tests PyPI version


NeuroSim is a Gymnasium-compatible reinforcement learning environment suite for brain-computer interfaces. It provides three environments modeling motor imagery decoding, intracortical cursor control, and P300 speller stimulus selection. The package includes pluggable signal models (electrode drift, fatigue, co-adaptation, noise), a conditional VAE neural surrogate, CSP+LDA classical baseline, PPO RL baseline, and a five-tier benchmark suite for reproducible evaluation across drift conditions and subject variability.

Installation

pip install neurosim              # Core (numpy, scipy, gymnasium)
pip install neurosim[train]       # + SB3, PyTorch for RL training
pip install neurosim[data]        # + MNE, MOABB for real EEG data
pip install neurosim[surrogate]   # + PyTorch for neural surrogate
pip install neurosim[all]         # Everything

Development install:

git clone https://github.com/HassDhia/neurosim.git
cd neurosim
pip install -e ".[all]"

Quick Start

import gymnasium as gym
import neurosim

env = gym.make("neurosim/DecoderAdapt-v0")
obs, info = env.reset(seed=42)
for _ in range(100):
    action = env.action_space.sample()
    obs, reward, terminated, truncated, info = env.step(action)
    if terminated or truncated:
        obs, info = env.reset()
env.close()

Environments

Environment Paradigm Observation Action Key Challenge
DecoderAdapt-v0 Motor imagery 55-dim (neural + confidence + drift) Dict: classify, recalibrate, adapt When to recalibrate under electrode drift
CursorControl-v0 Intracortical 96x5 neural state + cursor + target Box(2) velocity Continuous control through neural noise
SpellerNav-v0 P300 speller 36-posterior + ERP history Dict: stimulus group, commit Balance evidence vs communication speed

Signal Models

NeuroSim implements pluggable signal degradation models that simulate real-world BCI non-stationarity:

  • Electrode drift -- impedance degradation over session time, modeled as monotonic SNR reduction per channel
  • Fatigue drift -- exponential saturation of motor imagery signal quality with sustained use
  • Feature shift -- sudden and continuous distributional shifts in the neural feature space
  • Co-adaptation -- bidirectional user-decoder coupling where the user's neural patterns change in response to decoder behavior
  • Noise injection -- pink (1/f) noise, EMG artifact, blink artifact, and 50/60 Hz line noise at configurable intensities

Benchmark Tiers

Tier Condition Drift Sources
T1 Stationary -- no drift, low noise None
T2 Mild -- electrode drift, medium noise Electrode
T3 Full -- all drift, medium noise Electrode, fatigue, feature, co-adaptation
T4 Cross-subject -- multi-subject, high noise All
T5 Adversarial -- sudden shifts, high noise All + sudden

Training Agents

Train a PPO agent and run the benchmark suite from the command line:

neurosim-train --env DecoderAdapt-v0 --steps 100000
neurosim-benchmark --tier T1 --episodes 50

Or use Stable-Baselines3 directly:

from stable_baselines3 import PPO
import gymnasium as gym
import neurosim

env = gym.make("neurosim/DecoderAdapt-v0")
model = PPO("MlpPolicy", env, verbose=1)
model.learn(total_timesteps=100_000)
model.save("ppo_decoder_adapt")

Citation

If you use NeuroSim in your research, please cite:

@software{neurosim2026,
  author = {Dhia, Hass},
  title = {NeuroSim: A Gymnasium Platform for RL in Brain-Computer Interfaces},
  year = {2026},
  url = {https://github.com/HassDhia/neurosim},
}

License

MIT -- see LICENSE for details.

Project details


Download files

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

Source Distribution

neurosim-0.1.0.tar.gz (71.9 kB view details)

Uploaded Source

Built Distribution

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

neurosim-0.1.0-py3-none-any.whl (56.6 kB view details)

Uploaded Python 3

File details

Details for the file neurosim-0.1.0.tar.gz.

File metadata

  • Download URL: neurosim-0.1.0.tar.gz
  • Upload date:
  • Size: 71.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for neurosim-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bd9fab9bda2fbd9ce46272c68be1ecdfef5fb2d115ef4d2a24b2188499dd1a5c
MD5 ed58261b2cc9f347c255cb21cfa22a57
BLAKE2b-256 908ff0212c76314f61db97e18ecf6f27474402eca958801340ebc15d5cf3fe04

See more details on using hashes here.

File details

Details for the file neurosim-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: neurosim-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 56.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for neurosim-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ebf2f97fbc61f46e53f699da72bb5c1d1e4bbdc7a135f4e56525aaf035f2113
MD5 727bf3cf2c0d0c08d9b68d708c92a8f6
BLAKE2b-256 82830d2b4a4d8e2d352f3abf6786c202cf4e09589ee838fd79076c0502934f01

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page