Guides

Step-by-step tutorials for using ezmsg-simbiophys to generate simulated neural signals.

• Mouse Velocity to Simulated Ecephys
  • Overview
  • Prerequisites
  • Running the Example
  • Pipeline Components
  • Receiving the Stream
  • Visualizing with ezmsg-tools
  • Modifying the Example
  • See Also

Overview

These guides demonstrate how to use the velocity encoding systems to generate realistic neural signals for testing brain-computer interface (BCI) applications.

Mouse to Ecephys (Mouse Velocity to Simulated Ecephys)

Capture real mouse movements and encode them into simulated extracellular electrophysiology containing both spikes and LFP.

Circle to LFP (circle_to_lfp)

Generate a simulated cursor moving in a circle and encode its velocity into LFP-like colored noise with known ground truth.

Getting Started

All examples stream their output over Lab Streaming Layer (LSL), making it easy to receive and process the data in other applications.

Prerequisites

# Core package
uv add ezmsg-simbiophys

# For LSL streaming
uv add ezmsg-lsl

# For mouse input (mouse_to_ecephys only)
uv add ezmsg-peripheraldevice

Running Examples

Examples are located in the examples/ directory:

cd ezmsg-simbiophys/examples
uv run python mouse_to_lsl_full.py
# or
uv run python circle_to_dynamic_pink_outlet.py

Use --help to see available options:

uv run python mouse_to_lsl_full.py --help