radiens-core 0.0.3

Python client for Radiens neuroscience platform

radiens-core

A typed Python client for the Radiens electrophysiology platform.

radiens-core gives Python scripts and Jupyter notebooks programmatic access to the same acquisition, analysis, and curation capabilities available in the Radiens desktop applications (Allego, Videre, Curate). It communicates with Radiens backend servers over gRPC and auto-discovers locally running services — no manual configuration needed.

Note: This package is in its initial release series (0.x). While fully functional, minor API adjustments may occur before 1.0.

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 fully typed Pydantic models — you get autocomplete, hover documentation, and mypy compatibility out of the box.

Installation

pip install radiens-core

Requires Python 3.12+.

Prerequisites

A running Radiens backend server is required. The backend ships with the Radiens desktop applications:

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

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

Key Capabilities

Client	Purpose
AllegoClient	Control streaming/recording, retrieve live signals, configure DSP filters, manage stimulation, read hardware diagnostics
VidereClient	Link recorded files, retrieve signal segments, apply filters, compute signal-quality metrics and spike data
CurateClient	Filter, re-reference, downsample, and slice recorded datasets; supports bulk operations and reusable transform protocols

Documentation

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

Support

• Web: Contact Us
• Email: [e-mail]

License

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