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.3b0.tar.gz (382.4 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.3b0-py3-none-any.whl (269.3 kB view details)

Uploaded Python 3

File details

Details for the file radiens_core-0.0.3b0.tar.gz.

File metadata

  • Download URL: radiens_core-0.0.3b0.tar.gz
  • Upload date:
  • Size: 382.4 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.3b0.tar.gz
Algorithm Hash digest
SHA256 4cc24a1db960fb89f18dce4f8710d714ee413950536f23dfadb40411debf60ba
MD5 8e82c7f15c892cda946114fd35e591c3
BLAKE2b-256 7f2f418e2c32b7a56e3471bfb3b5bd6c48fff1ebe7731229820264d111e9260d

See more details on using hashes here.

Provenance

The following attestation bundles were made for radiens_core-0.0.3b0.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.3b0-py3-none-any.whl.

File metadata

  • Download URL: radiens_core-0.0.3b0-py3-none-any.whl
  • Upload date:
  • Size: 269.3 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.3b0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f205f33c19ba37a71c550c3c282c7b45708e6a4a90a9633bf667cfbe85a6207
MD5 e4ccb92725f5ebb8caa0414b010bb0e8
BLAKE2b-256 7b2f9a821f2c54f1f92d5f809cfbe3af78109c8260f7b60dde0d4259545806a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for radiens_core-0.0.3b0-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