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.4.tar.gz (427.7 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.4-py3-none-any.whl (301.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: radiens_core-0.0.4.tar.gz
  • Upload date:
  • Size: 427.7 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.4.tar.gz
Algorithm Hash digest
SHA256 3d42a47f512c0a8e43b5497d6b7802904c01644136baff24581ccc88beda57b1
MD5 424a8e00d304ee14e18e2c01a619de74
BLAKE2b-256 6350d225de3bfe41eb500d144d4bf4f745a3fa473f2f73c41e45e897d1423ee7

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: radiens_core-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 301.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cade8a994d115528a0467c3b6e20a9298a2424aea09b0fa8fa7bcdedc06cd33d
MD5 22d1bb8f9de53f8043cfd1acbe376ee4
BLAKE2b-256 0616250e6b8a4bfd6b97a656f8a3e1550d310494e1ec1d12ae5149f321375758

See more details on using hashes here.

Provenance

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