Skip to main 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+.

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/radiens-core-python/latest/

Support

License

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

Metadata

Release files for radiens-core 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for radiens-core 0.1.0
File Size Uploaded
radiens_core-0.1.0.tar.gz 449.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for radiens-core 0.1.0
File Interpreter ABI Platform
radiens_core-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 873.6 kB

Release files / radiens_core-0.1.0.tar.gz

Download URL radiens_core-0.1.0.tar.gz
Size 449.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1873c625c5ff492178ce7190e79d1020b1d38085c62bba91ceaf75d6da090355
BLAKE2b-256 checksum
How to use checksums
d142123f78ee3fd4ec9c281d4577efd14c4ba15a1d7901482a4dd688194bfab1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 8, 2026.

Transparency log

Release files / radiens_core-0.1.0-py3-none-any.whl

Download URL radiens_core-0.1.0-py3-none-any.whl
Size 424.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
318d94faaa8872291ec5d5eb320df9019a78cf62389ca32a6e49da6c371f4ea1
BLAKE2b-256 checksum
How to use checksums
df3f02df355e2bbec793958108c9e593dc98a63ecfa511f42ed46e87a09b1688
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 8, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page