From 3d422ca05c44c97794a24fdfa3da75f5eaf48f5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Richard=20H=C3=B6chenberger?= Date: Mon, 22 Mar 2021 11:11:56 +0100 Subject: [PATCH] Prepare release 0.7 (#746) --- .mailmap | 1 + doc/_templates/navbar.html | 3 ++- doc/authors.rst | 1 + doc/whats_new.rst | 32 +++++++++++++++++++++++--------- mne_bids/__init__.py | 2 +- 5 files changed, 28 insertions(+), 11 deletions(-) diff --git a/.mailmap b/.mailmap index 8dd5ee9ab..1145303c7 100644 --- a/.mailmap +++ b/.mailmap @@ -27,3 +27,4 @@ Robert Luke <748691+rob-luke@users.noreply.github.com> Evgenii Kalenkovich Eduard Ort Eduard Ort +Tom Donoghue diff --git a/doc/_templates/navbar.html b/doc/_templates/navbar.html index 77ddbdcb8..26a9af013 100644 --- a/doc/_templates/navbar.html +++ b/doc/_templates/navbar.html @@ -9,7 +9,8 @@
  • Development
  • Stable
    • -
  • v0.6
    • +
  • v0.7
    • +
  • v0.6
  • v0.5
  • v0.4
  • v0.3
    • diff --git a/doc/authors.rst b/doc/authors.rst index 8585a770c..146212ab2 100644 --- a/doc/authors.rst +++ b/doc/authors.rst @@ -21,3 +21,4 @@ .. _Ethan Knights: https://github.com/ethanknights .. _Diego Lozano-Soldevilla: https://github.com/dieloz .. _Eduard Ort: https://github.com/eort +.. _Tom Donoghue: https://github.com/TomDonoghue diff --git a/doc/whats_new.rst b/doc/whats_new.rst index 66222871c..7cbb0a05f 100644 --- a/doc/whats_new.rst +++ b/doc/whats_new.rst @@ -10,26 +10,40 @@ What's new? .. currentmodule:: mne_bids .. _changes_0_7: -Version 0.7 (unreleased) ------------------------- +Version 0.7 +----------- -xxx +This release brings numerous enhancements and bug fixes that enhance reading +and writing BIDS data, and improve compatibility with the latest BIDS +specifications. Notable changes ~~~~~~~~~~~~~~~ -- xxx +- Channel names in ``*_channels.tsv`` and ``*_electrodes.tsv`` files now always + take precedence over the names stored in the raw files. +- When reading data where the same trial type refers to different trigger + values, we will now automatically create hierarchical event names in the + form of ``trial_type/value1``, `trial_type/value2`` etc. +- :func:`mne_bids.write_raw_bids` now allows users to specify a format + conversion via the new ``format`` parameter. +- Various improvements to data reading and :class:`mne_bids.BIDSPath` make + working with real-life data easier. +- Many bug fixes in :func:`mne_bids.write_raw_bids` and in the MNE-BIDS + Inspector. Authors ~~~~~~~ * `Adam Li`_ -* `Richard Höchenberger`_ -* `Stefan Appelhoff`_ +* `Alexandre Gramfort`_ +* `Austin Hurst`_ * `Diego Lozano-Soldevilla`_ * `Eduard Ort`_ -* `Alexandre Gramfort`_ * `Maximilien Chaumon`_ +* `Richard Höchenberger`_ +* `Stefan Appelhoff`_ +* `Tom Donoghue`_ Detailed list of changes ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -39,7 +53,7 @@ Enhancements - Some datasets out in the real world have a non-standard ``stim_type`` instead of a ``trial_type`` column in ``*_events.tsv``. :func:`mne_bids.read_raw_bids` now makes use of this column, and emits a warning, encouraging users to rename it, by `Richard Höchenberger`_ (:gh:`680`) - When reading data where the same event name or trial type refers to different event or trigger values, we will now create a hierarchical event name in the form of ``trial_type/value``, e.g. ``stimulus/110``, by `Richard Höchenberger`_ (:gh:`688`) -- When reading data via :func:`mne_bids.read_raw_bids`, the channel names specified in the BIDS ``*_channels.tsv`` and ``*_electrodes.tsv`` files now always take precedence (and do not need to match) the channel names stored in the raw files anymore, by `Adam Li`_ and `Richard Höchenberger`_ (:gh:`691`, :gh:`704`) +- When reading data via :func:`mne_bids.read_raw_bids`, the channel names specified in the BIDS ``*_channels.tsv`` and ``*_electrodes.tsv`` files now always take precedence over (and do not need to match) the channel names stored in the raw files anymore, by `Adam Li`_ and `Richard Höchenberger`_ (:gh:`691`, :gh:`704`) - Improve the ``Convert iEEG data to BIDS`` tutorial to include a note on how BIDS and MNE-Python coordinate frames are handled, by `Adam Li`_ (:gh:`717`) - More detailed error messages when trying to write modified data via :func:`mne_bids.write_raw_bids`, by `Richard Höchenberger`_ (:gh:`719`) - If ``check=True``, :class:`mne_bids.BIDSPath` now checks the ``space`` entity to be valid according to BIDS specification Appendix VIII, by `Stefan Appelhoff`_ (:gh:`724`) @@ -52,7 +66,7 @@ Enhancements API and behavior changes ^^^^^^^^^^^^^^^^^^^^^^^^ -- Add ``format`` kwarg to :func:`write_raw_bids` that allows users to specify if they want to force conversion to ``BrainVision`` or ``FIF`` file format, by `Adam Li`_ (:gh:`672`) +- Add ``format`` kwarg to :func:`mne_bids.write_raw_bids` that allows users to specify if they want to force conversion to ``BrainVision`` or ``FIF`` file format, by `Adam Li`_ (:gh:`672`) - :func:`mne_bids.read_raw_bids` now stores the ``participant_id`` value from ``participants.tsv`` in ``raw.info['subject_info']['his_id']``, not in ``raw.info['subject_info']['participant_id']`` anymore, by `Richard Höchenberger`_ (:gh:`745`) Requirements diff --git a/mne_bids/__init__.py b/mne_bids/__init__.py index b02b9615a..3070b534a 100644 --- a/mne_bids/__init__.py +++ b/mne_bids/__init__.py @@ -1,6 +1,6 @@ """MNE software for easily interacting with BIDS compatible datasets.""" -__version__ = '0.7.dev0' +__version__ = '0.7' from mne_bids import commands from mne_bids.report import make_report from mne_bids.path import (BIDSPath, get_datatypes, get_entity_vals,