Skip to main content

Python client for Radiens neuroscience platform

Project description

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/

Support

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

radiens_core-0.0.2.tar.gz (377.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

radiens_core-0.0.2-py3-none-any.whl (265.7 kB view details)

Uploaded Python 3

File details

Details for the file radiens_core-0.0.2.tar.gz.

File metadata

  • Download URL: radiens_core-0.0.2.tar.gz
  • Upload date:
  • Size: 377.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for radiens_core-0.0.2.tar.gz
Algorithm Hash digest
SHA256 faf604b613502402c2513c9653f28003034181f3c287b06388bdede1db0b66e9
MD5 337e674f3bdeaa91a4870d791400544b
BLAKE2b-256 712a14e6681d3c7c67d0d3b11060108a1b2ff9134fa379cc8575f18adaa9f279

See more details on using hashes here.

Provenance

The following attestation bundles were made for radiens_core-0.0.2.tar.gz:

Publisher: publish.yml on NeuroNexus/radiens-core-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file radiens_core-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: radiens_core-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 265.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for radiens_core-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 573f26b8b45171d09b238517787a55c1ceb5c8a784e97734646fd79f5126b6cf
MD5 2cb5b93d177f717c6baef456f2a480cb
BLAKE2b-256 8ff8e0d9a718c555ce3259d66576aa2285d67fc817eaa1504b6a49b8d8437ed3

See more details on using hashes here.

Provenance

The following attestation bundles were made for radiens_core-0.0.2-py3-none-any.whl:

Publisher: publish.yml on NeuroNexus/radiens-core-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page