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).

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, curation, and transformation (VidereClient)

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; filter, re-reference, downsample, and slice 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.8.tar.gz (488.5 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.8-py3-none-any.whl (361.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: radiens_core-0.0.8.tar.gz
  • Upload date:
  • Size: 488.5 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.8.tar.gz
Algorithm Hash digest
SHA256 cb5f2cd5df5c636faaa45a81af3db67ad9c05cac9f73ee30c6e2506958617381
MD5 024076444bbd72486fbd3ef23f3803e4
BLAKE2b-256 e93f6cb962b0c792dd713f2eea887f22be0c6391c709f2098d6d35902d156cec

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: radiens_core-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 361.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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 678f15aa2d8e5a999a21190bd29ad9e101e21ba85e0c39bc39a229a2b3ed8c15
MD5 4ba01a063bf52abc0c9babac25e3afca
BLAKE2b-256 280773e5d53ca7eeb46b667ffb09fa97ebfe623cf67deade23333c4470bb7994

See more details on using hashes here.

Provenance

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