Skip to content

radiens-core

A typed Python client for the Radiens electrophysiology platform.

radiens-core is the base package of RadiensPy, the Radiens Python packages. It gives Python scripts and Jupyter notebooks access to the same acquisition, analysis, and curation workflows available in the Radiens desktop applications (Allego, Videre).

Note: This package is pre-1.0. Releases may change or remove APIs; check the changelog before upgrading. Some features need a recent Radiens release and raise CapabilityError on an older one.

Quick Example

from radiens_core import AllegoClient

with AllegoClient() as client:
    client.healthcheck()
    status = client.get_status()
    print(f"Streaming: {status.streaming.stream_mode}")
    print(f"Recording: {status.recording.record_mode}")

All public methods return typed Python objects with strong IDE autocomplete and inline documentation support.

Installation

pip install radiens-core

Requires Python 3.12+. MATLAB R2024b and later can use radiens-core through MATLAB's Python interface; see Using radiens-core from MATLAB.

Prerequisites

Use with a local Radiens desktop application:

  • Allego — real-time acquisition (AllegoClient)
  • Videre — offline file analysis, curation, and transformation (VidereClient)

See the Radiens downloads page for information on software download and installation.

Key Capabilities

Client Purpose
AllegoClient Control streaming and recording, retrieve live signals, select channels, configure DSP filters, compute live signal-quality (KPI) metrics, control spike sorting, manage stimulation, read hardware diagnostics
VidereClient Link recorded files, retrieve signal segments, select channels, apply filters, compute signal-quality and spectral metrics, run spike sorting and read spikes and units, read dataset provenance; filter, re-reference, downsample, and slice datasets, with bulk operations and reusable transform protocols

Documentation

Full API reference, getting-started guide, and examples: https://neuronexus.github.io/radienspy/radiens-core/

Support

License

This project is licensed under the terms described in the LICENSE file included with this distribution.