What’s new?#

Version 0.17 (2025-09-10)#

The following authors contributed for the first time. Thank you so much! 🤩

The following authors had contributed before. Thank you for sticking around! 🤘

mne_bids.write_raw_bids() can now handle mne Raw objects with eyegaze and pupil channels, by Christian O’Reilly (#1344)
mne_bids.get_entity_vals() has a new parameter ignore_suffixes to easily ignore sidecar files, by Daniel McCloy (#1362)
Empty-room matching now preferentially finds recordings in the subject directory tagged as task-noise before looking in the sub-emptyroom directories. This adds support for a part of the BIDS specification for ER recordings, by Berk Gerçek (#1364)
Path matching is now implemenented in a more efficient manner within mne_bids.BIDSPath.match() and mne_bids.find_matching_paths(), by Arne Gottwald (#1355)
mne_bids.get_entity_vals() has a new parameter include_match to prefilter item matching and ignore non-matched items from begin of directory scan, by Arne Gottwald (#1355)
Data from events.tsv can now be read into an OrderedDict using mne_bids.events_file_to_annotation_kwargs(), by Matthias Dold (#1389)
Read the optionally present extra columns from events.tsv and pass them to mne.Annotations, by Pierre Guetschel (#1401)
_filter_fnames() now correctly checks the default extension, correcting suffix filtering, by Nathan Azrak (#1427)

mne_bids.make_dataset_description() will now auto-generate basic GeneratedBy fields if generated_by=None. To suppress the auto-generated fields, pass an empty list. By Daniel McCloy (#1384)
Add requirements that root, subject, task attributes must be set when using mne_bids.read_raw_bids() to avoid implicit behavior and file ambiguity, by Teon Brooks (#1414)

mne_bids.read_raw_bids() can optionally return an event_id dictionary suitable for use with mne.events_from_annotations(), and if a values column is present in events.tsv it will be used as the source of the integer event ID codes, by Daniel McCloy (#1349)
BIDS dictates that the recording entity should be displayed as “_recording-” in the filename. This PR makes mne_bids.BIDSPath correctly display “_recording-” (instead of “_rec-”) in BIDSPath.fpath. By Scott Huberty (#1348)
mne_bids.make_dataset_description() now correctly encodes the dataset description as UTF-8 on disk, by Scott Huberty (#1357)
Corrects extension when filtering filenames in mne_bids.BIDSPath.match() and mne_bids.find_matching_paths(), by Arne Gottwald (#1355)
Fix mne_bids.BIDSPath partially matching a value, by Pierre Guetschel (#1388)
Ensures that check parameter in mne_bids.BIDSPath.update() is passed to mne_bids.BIDSPath, by Teon Brooks (#1411)
minor: added T2w to the suffix allowlist, by Harrison Ritz (#1420)

Tests that were adding or deleting files to/from a session-scoped dataset now properly clean up after themselves, by Daniel McCloy (#1347)