Skip to content

Commit

Permalink
Prepare release 0.7 (#746)
Browse files Browse the repository at this point in the history
  • Loading branch information
hoechenberger authored Mar 22, 2021
1 parent a2b0350 commit 3d422ca
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 11 deletions.
1 change: 1 addition & 0 deletions .mailmap
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ Robert Luke <[email protected]>
Evgenii Kalenkovich <[email protected]>
Eduard Ort <[email protected]>
Eduard Ort <[email protected]> <[email protected]>
Tom Donoghue <[email protected]>
3 changes: 2 additions & 1 deletion doc/_templates/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
<ul class="dropdown-menu" aria-labelledby="dropdownMenu1">
<li><a href="https://mne.tools/mne-bids/dev/index.html">Development</a></li>
<li><a href="https://mne.tools/mne-bids/stable/index.html">Stable</a></li>
<li><a href="https://mne.tools/mne-bids/v0.5/index.html">v0.6</a></li>
<li><a href="https://mne.tools/mne-bids/v0.7/index.html">v0.7</a></li>
<li><a href="https://mne.tools/mne-bids/v0.6/index.html">v0.6</a></li>
<li><a href="https://mne.tools/mne-bids/v0.5/index.html">v0.5</a></li>
<li><a href="https://mne.tools/mne-bids/v0.4/index.html">v0.4</a></li>
<li><a href="https://mne.tools/mne-bids/v0.3/index.html">v0.3</a></li>
Expand Down
1 change: 1 addition & 0 deletions doc/authors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
32 changes: 23 additions & 9 deletions doc/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -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`)
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion mne_bids/__init__.py
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit 3d422ca

Please sign in to comment.