mne-tools / mne-tools/mne-python

Add support for file-like objects to mne.io.read_raw_edf()

Open
#8,976 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ENH
Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

Describe the new feature or enhancement

I would like to have support for file-like objects for the mne.io.read_raw_edf() function (specifically a bytesIO object)

Describe your proposed implementation

new capability to an existing method

Describe possible alternatives

Possible alternative is allowing for a kwarg to detect if it's a file-like object as opposed to a filepath, but shouldn't be necessary

Additional comments

It looks like fiff files have that functionality in mne.io.read_raw(), it would be fantastic if edf had that functionality as well

Contributor guide

Open the contributing guide

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

Begin with the mne.io.read_raw_edf() entry point and compare it with mne.io.read_raw(), whose file-like support is cited in the issue. Trace how each reader receives its input, then verify that BytesIO support works while existing filepath behavior remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.