|
9 | 9 | What was new in previous releases? |
10 | 10 | ================================== |
11 | 11 |
|
| 12 | +.. _changes_0_17: |
| 13 | + |
| 14 | +Version 0.17 (2025-09-10) |
| 15 | +------------------------- |
| 16 | + |
| 17 | +👩🏽💻 Authors |
| 18 | +~~~~~~~~~~~~~~~ |
| 19 | + |
| 20 | +The following authors contributed for the first time. Thank you so much! 🤩 |
| 21 | + |
| 22 | +* `Nathan Azrak`_ |
| 23 | +* `Matthias Dold`_ |
| 24 | +* `Berk Gerçek`_ |
| 25 | +* `Arne Gottwald`_ |
| 26 | +* `Christian O'Reilly`_ |
| 27 | +* `Harrison Ritz`_ |
| 28 | +* `waldie11`_ |
| 29 | + |
| 30 | +The following authors had contributed before. Thank you for sticking around! 🤘 |
| 31 | + |
| 32 | +* `Stefan Appelhoff`_ |
| 33 | +* `Teon Brooks`_ |
| 34 | +* `Pierre Guetschel`_ |
| 35 | +* `Richard Höchenberger`_ |
| 36 | +* `Scott Huberty`_ |
| 37 | +* `Eric Larson`_ |
| 38 | +* `Daniel McCloy`_ |
| 39 | + |
| 40 | + |
| 41 | +Detailed list of changes |
| 42 | +~~~~~~~~~~~~~~~~~~~~~~~~ |
| 43 | + |
| 44 | +🚀 Enhancements |
| 45 | +^^^^^^^^^^^^^^^ |
| 46 | + |
| 47 | +- :func:`mne_bids.write_raw_bids()` can now handle mne `Raw` objects with `eyegaze` and `pupil` channels, by `Christian O'Reilly`_ (:gh:`1344`) |
| 48 | +- :func:`mne_bids.get_entity_vals()` has a new parameter ``ignore_suffixes`` to easily ignore sidecar files, by `Daniel McCloy`_ (:gh:`1362`) |
| 49 | +- 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`_ (:gh:`1364`) |
| 50 | +- Path matching is now implemenented in a more efficient manner within :meth:`mne_bids.BIDSPath.match()` and :func:`mne_bids.find_matching_paths()`, by `Arne Gottwald` (:gh:`1355`) |
| 51 | +- :func:`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` (:gh:`1355`) |
| 52 | +- Data from ``events.tsv`` can now be read into an OrderedDict using :func:`mne_bids.events_file_to_annotation_kwargs()`, by `Matthias Dold` (:gh:`1389`) |
| 53 | +- Read the optionally present extra columns from ``events.tsv`` and pass them to :class:`mne.Annotations`, by `Pierre Guetschel` (:gh:`1401`) |
| 54 | +- ``_filter_fnames()`` now correctly checks the default extension, correcting suffix filtering, by `Nathan Azrak` (:gh:`1427`) |
| 55 | + |
| 56 | + |
| 57 | +🧐 API and behavior changes |
| 58 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 59 | + |
| 60 | +- :func:`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`_ (:gh:`1384`) |
| 61 | +- Add requirements that ``root``, ``subject``, ``task`` attributes must be set when using :func:`mne_bids.read_raw_bids` to avoid implicit behavior and file ambiguity, by `Teon Brooks`_ (:gh:`1414`) |
| 62 | + |
| 63 | +🛠 Requirements |
| 64 | +^^^^^^^^^^^^^^^ |
| 65 | + |
| 66 | +- MNE-BIDS now requires ``mne`` 1.8 or higher. |
| 67 | + |
| 68 | +🪲 Bug fixes |
| 69 | +^^^^^^^^^^^^ |
| 70 | + |
| 71 | +- :func:`mne_bids.read_raw_bids` can optionally return an ``event_id`` dictionary suitable for use with :func:`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`_ (:gh:`1349`) |
| 72 | +- BIDS dictates that the recording entity should be displayed as "_recording-" in the filename. This PR makes :class:`mne_bids.BIDSPath` correctly display "_recording-" (instead of "_rec-") in BIDSPath.fpath. By `Scott Huberty`_ (:gh:`1348`) |
| 73 | +- :func:`mne_bids.make_dataset_description` now correctly encodes the dataset description as UTF-8 on disk, by `Scott Huberty`_ (:gh:`1357`) |
| 74 | +- Corrects extension when filtering filenames in :meth:`mne_bids.BIDSPath.match()` and :func:`mne_bids.find_matching_paths()`, by `Arne Gottwald` (:gh:`1355`) |
| 75 | +- Fix :class:`mne_bids.BIDSPath` partially matching a value, by `Pierre Guetschel` (:gh:`1388`) |
| 76 | +- Ensures that ``check`` parameter in :meth:`mne_bids.BIDSPath.update()` is passed to :class:`mne_bids.BIDSPath`, by `Teon Brooks`_ (:gh:`1411`) |
| 77 | +- minor: added `T2w` to the suffix allowlist, by `Harrison Ritz`_ (:gh:`1420`) |
| 78 | + |
| 79 | +⚕️ Code health |
| 80 | +^^^^^^^^^^^^^^ |
| 81 | + |
| 82 | +- Tests that were adding or deleting files to/from a session-scoped dataset now properly clean up after themselves, by `Daniel McCloy`_ (:gh:`1347`) |
| 83 | + |
| 84 | +:doc:`Find out what was new in previous releases <whats_new_previous_releases>` |
| 85 | + |
| 86 | +.. include:: authors.rst |
| 87 | + |
| 88 | + |
12 | 89 | .. _changes_0_16: |
13 | 90 |
|
14 | 91 | Version 0.16 (2024-11-16) |
|
0 commit comments