imro-neuropixels 0.1.0

NP1.0 Neuropixels probe configuration and IMRO/Kilosort file generator with GUI

IMRO Neuropixels Generator

Neuropixels probe channel configuration tool. Create IMRO files for SpikeGLX/OpenEphys and export probe configurations for Kilosort.

Problem: The OpenEphys Neuropixels Plugin can load SpikeGLX IMRO files but provides no tool to create them.

Solution: IMRO Generator lets you configure which electrodes to record from based on depth coverage, then export as IMRO files or Kilosort probe dictionaries.

Installation

New to probe configuration? Start here:

1. Install: pip install -e . (requires Python 3.8+)
2. Launch: imro-gui
3. Quick guide: See QUICKSTART.md

The GUI lets you:

• Choose your recording depth range (0–44.16 mm)
• Select assignment mode (Striped or Mixed) for uniform electrode distribution
• Configure gains, filters, and reference type
• Save IMRO files for OpenEphys/SpikeGLX
• Load and modify existing IMRO configurations

For Developers

Integrating into your software? See:

• DEVELOPERS.md — Architecture, setup, extending
• docs/imro_algorithm.md — Algorithm specification
• docs/imro_dev_guide_A_overview.md — Detailed architecture
• tests/ — Test suite with examples

System Requirements

• Python: 3.8 or later
• GUI dependencies: PyQt5, pyqtgraph (installed automatically)
• Data processing: NumPy (installed automatically)

Installation

# From PyPI (once published)
pip install imro-neuropixels

# From TestPyPI
pip install -i https://test.pypi.org/simple/ \
    --extra-index-url https://pypi.org/simple/ imro-neuropixels

# From source (editable, for development)
git clone https://github.com/vitalylerner/imro-neuropixels.git
cd imro-neuropixels
pip install -e ".[dev]"

Example use

Mapping 2cm from the tip up

example file 20mm.imro in action, as seen in OpenEphys Probe Viewer, when flashes of light (2Hz) are shown to a fixating subject, while Neuropixels1.0-NHP is inserted in a visual area.

Picking an active region for recording

Set boundaries 10mm to 30mm

Map -> Save as IMRO

Map -> Save kilosort probe

Helpful Resources

• OpenEphys Neuropixels Plugin — GUI for recording with Neuropixels probes, loads IMRO files
• SpikeGLX IMRO Format — Complete IMRO specification and format documentation
• Kilosort Probe Dictionary — Format for probe configurations in Kilosort4
• Neuropixels Probe 1.0 NHP — Official probe specifications