bids-standard / pybv

A lightweight I/O utility for the BrainVision data format, written in Python.

Home Page:https://pybv.readthedocs.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Why is `_export_mne_raw()` private?

cbrnr opened this issue Β· comments

Is there a reason why _export_mne_raw() is a private function? It's only used in some tests, but it would probably be useful for some people (like me πŸ˜„).

It's because exporting should be done from MNE-Python, using https://mne.tools/stable/generated/mne.export.export_raw.html#mne.export.export_raw

this way we only really have to maintain one API, instead of two. And people who want to export from mne to brainvision would have both dependencies (mne, pybv) anyhow.

Does that make sense? I'm happy to discuss alternatives.

actually, we probably should have a small section "exporting from mne-python" right about here: https://github.com/bids-standard/pybv?tab=readme-ov-file#writing-brainvision-files

I totally agree that pybv should not have two APIs, but why is this export function not in MNE-Python then? And yes, we should amend the docs.