SpikeInterface / SpikeInterface/spikeinterface

SpikeInterface objects and xarray DataTree conversion functions

Open
#3,929 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
847
Forks
280
Avg merge
3d 9h
Merged PRs (30d)
29

Description

Hi,

I use xarray datatypes for most of my scripts and I feel all spikeinterfaces objects could fit in the xarray datatree datatype with almost no drawback (we keep lazyness, chunks, ...). I would really enjoy to be able to use spikeinterface objects and functions for most of my pipeline, but every now and then, have a function to convert to a xarray datatree and vice-versa (perhaps requiring a specific structure of the datatree).

Are conversions functions from and to xarray datatree a feature that may be added to SpikeInterface in the future?

In a more broad function, my understanding of spikeinterface machinery is that it has its own chunk/lazyness handler, and those mostly operate on time chunks. Would there be any drawback in using xarray with Dask as back-end instead, except for the complete code overhaul ?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing SpikeInterface's existing object and function interfaces alongside the proposed xarray DataTree structure; define the required conversion directions and compatibility boundary before deciding whether a Dask-backed overhaul is viable.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.