BIDS Converter Skill for EEG
Converts raw EEG datasets into spec-valid BIDS datasets. Supports EDF, BrainVision, EEGLAB .set, Biosemi BDF, GDF, CNT, Curry .cdt, MATLAB .mat, and any format MNE can read.
Requirements
-
Recommended: uv. Each script carries its dependencies as PEP 723 metadata, so
uv runhandles installation automatically. -
Alternative: Python 3.10+ with manual install:
pip install "mne>=1.6" "mne-bids>=0.14" "pybv>=0.7.3" \ pandas openpyxl edfio eeglabio curryreader bids-validator-deno
Installation
Download eeg-bids-converter.zip from Releases and extract, or clone this repo:
git clone https://github.com/iatosh/eeg-bids-converter.git
Then place the folder in your agent's skills directory.
Usage
Invoke eeg-bids-converter skill in your agent.
How It Works
| Step | Script | What It Does |
|---|---|---|
| 1. Survey | inspect_dataset.py |
List files, check readability, read documentation |
| 2. Map entities | inspect_dataset.py --pattern |
Extract subject, session, task, run, acq from filenames |
| 3. Collect metadata | interactive | PowerLineFrequency, EEGReference, EEGGround, Manufacturer, event codes, electrode provenance, license, citation |
| 4. Convert | convert_recording.py |
One call per recording; verify sampling rate, duration, waveform; convert non-standard formats to BrainVision |
| 5. Patch sidecars | patch_sidecar.py |
Write fields mne-bids cannot infer; fix Manufacturer misattribution |
| 6. Metadata & validate | write_bids_metadata.py, validate_bids.py |
Generate dataset_description.json, participants.tsv, README, CHANGES; run official validator and key-spelling check |
| 7. Report | — | Conversion summary, validator output, judgment calls with sources |
Agent Behavior
- Never modifies the source dataset. Repairs happen on scratch copies.
- Records what the dataset says, not what looks complete. A plausible guess is data corruption no validator will catch.
- Asks before falling back to
"n/a". Order: documentation, user,"n/a". - Fixes root causes on validation failure. Errors are never silenced.
- Zero validator errors is necessary, not sufficient. Structure is correct; content is verified by read-back and the final report.
Situational References
| File | When Used |
|---|---|
custom_formats.md |
MNE cannot open the file |
events.md |
Events not in raw.annotations; trigger code documentation |
electrodes.md |
Electrode positions and --montage |
derivatives.md |
Source ships pre-filtered copies |
bids_reference.md |
BIDS spec facts |
templates_and_examples.md |
Finished metadata file examples |
License
MIT. See LICENSE.
BIDS logo is (c) BIDS community: https://bids.neuroimaging.io/.
No comments yet
Be the first to share your take.