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 access to the same acquisition, analysis, and curation workflows available in the Radiens desktop applications (Allego, Videre, Curate).

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 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 (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

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.6.tar.gz (438.8 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.6-py3-none-any.whl (308.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for radiens_core-0.0.6.tar.gz
Algorithm Hash digest
SHA256 d5212e735d8434104a456402bd7118e6ae0f8e62f43f17b019bf79314bd7d23e
MD5 ba751ba108685fa795e58ea62e498576
BLAKE2b-256 499825bc56d528b0b6dc54ae090ff64b6c6a0dd1f4adfe5db07034183ac4a5b3

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for radiens_core-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2a70f394a92f173a3d7f420b082ac88b434f29e48cee5779d5831621f401320d
MD5 7e2038a1325310a8146b644f6a8a740e
BLAKE2b-256 b4b8f2ede0fd387f714a79a5d32fa5f3ed8dad873c3afe84e4e7b162d400c4dd

See more details on using hashes here.

Provenance

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