Prepare release (#658)

* Update changelog

* Include Python 3.9?

* Bump version number

* Update navbar

* Test on Python 3.9

.github/workflows/unit_tests.yml

@@ -91,7 +91,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-18.04, ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.8]
+        python-version: [3.8, 3.9]
         bids-validator: [master, stable]
 
     env:

doc/_templates/navbar.html

@@ -9,6 +9,7 @@
   <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.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>

doc/authors.rst

@@ -18,3 +18,4 @@
 .. _Evgenii Kalenkovich: https://github.com/kalenkovich
 .. _Austin Hurst: https://github.com/a-hurst
 .. _Robert Luke: https://github.com/rob-luke
+.. _Ethan Knights: https://github.com/ethanknights

doc/whats_new.rst

@@ -10,32 +10,58 @@ What's new?
 .. currentmodule:: mne_bids
 .. _changes_0_6:
 
-Version 0.6 (unreleased)
-------------------------
-xxx
+Version 0.6 🎄
+--------------
+
+These are challenging days for many of us, and to make your lives
+ever so slightly easier, we've been working hard to deliver this early
+Christmas present 🎁 And even if you do not celebrate Christmas, we are quite
+certain you will like what we got for you! So – what are you waiting for? It's
+time to unwrap!
 
 Notable changes
 ~~~~~~~~~~~~~~~
-xxx
+
+- The new Inspector, which can be invoked via :func:`mne_bids.inspect_dataset`,
+  allows you to interactively explore your raw data, change
+  the bad channels selection, and edit :class:`mne.Annotations`. It also
+  performs automated detection of flat data segments or channels, to assist
+  you during visual inspection. The capabilities of the inspector will be
+  further expanded in upcoming releases of MNE-BIDS.
+
+- To further assist you during data inspection, we have added a function to
+  summarize all events present in a dataset,
+  :func:`mne_bids.stats.count_events`.
+
+- Sidecar JSON files can now be updated using a template via
+  :func:`mne_bids.update_sidecar_json`.
+
+- You can now read and write FLASH MRI images using
+  :func:`mne_bids.write_anat`. We also fixed some issues with MRI defacing
+  along the way.
+
+- Event durations are now preserved upon reading and writing data (we used to
+  set all event durations to zero before).
 
 Authors
 ~~~~~~~
+
 * `Stefan Appelhoff`_
 * `Adam Li`_
-* `Richard Höchenberger`_
+* `Alex Rockhill`_
 * `Alexandre Gramfort`_
 * `Austin Hurst`_
-* `Alex Rockhill`_
+* `Ethan Knights`_  (new contributor)
+* `Mainak Jas`_ 
+* `Richard Höchenberger`_
 
 Detailed list of changes
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 Enhancements
 ^^^^^^^^^^^^
 
-- The function :func:`mne_bids.print_dir_tree` has a new parameter ``return_str`` which allows it to return a str of the dir tree instead of printing it, by `Stefan Appelhoff`_ (`#600 <https://github.com/mne-tools/mne-bids/pull/600>`_)
-- :func:`mne_bids.write_raw_bids` now preserves event durations when writing :class:`mne.Annotations` to ``*_events.tsv`` files, and :func:`mne_bids.read_raw_bids` restores these durations upon reading, by `Richard Höchenberger`_ (`#603 <https://github.com/mne-tools/mne-bids/pull/603>`_)
-- Writing BrainVision data via :func:`mne_bids.write_raw_bids` will now set the unit of EEG channels to µV for enhanced interoperability with other software, by `Alexandre Gramfort`_, `Stefan Appelhoff`_, and `Richard Höchenberger`_ (`#610 <https://github.com/mne-tools/mne-bids/pull/610>`_)
+- The function :func:`mne_bids.print_dir_tree` has a new parameter ``return_str`` which allows it to return a str of the dir tree instead of printing it, by `Stefan Appelhoff`_ (:gh:`600`)
 - The function :func:`mne_bids.print_dir_tree` has a new parameter ``return_str`` which allows it to return a str of the dir tree instead of printing it, by `Stefan Appelhoff`_ (:gh:`600`)
 - :func:`mne_bids.write_raw_bids` now preserves event durations when writing :class:`mne.Annotations` to ``*_events.tsv`` files, and :func:`mne_bids.read_raw_bids` restores these durations upon reading, by `Richard Höchenberger`_ (:gh:`603`)
 - Writing BrainVision data via :func:`mne_bids.write_raw_bids` will now set the unit of EEG channels to µV for enhanced interoperability with other software, by `Alexandre Gramfort`_, `Stefan Appelhoff`_, and `Richard Höchenberger`_ (:gh:`610`)
@@ -44,9 +70,23 @@ Enhancements
 - Add support for anonymizing EDF and BDF files without converting to BrainVision format, by `Austin Hurst`_ (:gh:`636`)
 - Add support for writing FLASH MRI data with :func:`mne_bids.write_anat`, by `Alexandre Gramfort`_ (:gh:`641`)
 - Add interactive data inspector :func:`mne_bids.inspect_dataset`, by `Richard Höchenberger`_ (:gh:`561`)
+- Do not complain about missing events if it's likely we're dealing with resting-state data in :func:`mne_bids.write_raw_bids`, **by new contributor** `Ethan Knights`_ (:gh:`631`)
+
+API changes
+^^^^^^^^^^^
+
+- When passing event IDs to :func:`mne_bids.write_raw_bids` via ``events_data`` without an accompanying event description in ``event_id``, we will now raise a `ValueError`. This ensures that accidentally un-described events won't get written unnoticed, by `Richard Höchenberger`_ (:gh:`603`)
+- The :func:`mne_bids.get_head_mri_trans` now has a parameter ``extra_params`` to allow passing arguments specific to a file format, by `Mainak Jas`_ (:gh:`638`)
+- The first parameter of :func:`mne_bids.write_anat` is now called ``image`` and not ``t1w``, by `Alexandre Gramfort`_ (:gh:`641`)
+
+Requirements
+^^^^^^^^^^^^
+
+- Writing BrainVision data now requires ``pybv`` 0.4 or later.
 
 Bug fixes
 ^^^^^^^^^
+
 - Make sure large FIF files with splits are handled transparently on read and write, by `Alexandre Gramfort`_ (:gh:`612`)
 - The function :func:`mne_bids.write_raw_bids` now outputs ``*_electrodes.tsv`` and ``*_coordsystem.json`` files for EEG/iEEG data that are BIDS-compliant (only contain subject, session, acquisition, and space entities), by `Adam Li`_ (:gh:`601`)
 - Make sure writing empty-room data with anonymization shifts the session back in time, by `Alexandre Gramfort`_ (:gh:`611`)
@@ -59,16 +99,6 @@ Bug fixes
 - :func:`mne_bids.copyfiles.copyfile_eeglab` didn't handle certain EEGLAB files correctly, by `Richard Höchenberger`_ (:gh:`653`)
 - Fix bug where images with different orientations than the T1 used to define the landmarks were defaced improperly, by `Alex Rockhill`_ (:gh:`651`)
 
-API changes
-^^^^^^^^^^^
-- When passing event IDs to :func:`mne_bids.write_raw_bids` via ``events_data`` without an accompanying event description in ``event_id``, we will now raise a `ValueError`. This ensures that accidentally un-described events won't get written unnoticed, by `Richard Höchenberger`_ (:gh:`603`)
-- The :func:`mne_bids.get_head_mri_trans` now has a parameter ``extra_params`` to allow passing arguments specific to a file format, by `Mainak Jas`_ (:gh:`638`)
-- The first parameter of :func:`mne_bids.write_anat` is now called ``image`` and not ``t1w``, by `Alexandre Gramfort`_ (:gh:`641`)
-
-Requirements
-^^^^^^^^^^^^
-- Writing BrainVision data now requires ``pybv`` 0.4 or later.
-
 :doc:`Find out what was new in previous releases <whats_new_previous_releases>`
 
 .. include:: authors.rst

mne_bids/__init__.py

@@ -1,6 +1,6 @@
 """MNE software for easily interacting with BIDS compatible datasets."""
 
-__version__ = '0.6.dev0'
+__version__ = '0.6'
 from mne_bids import commands
 from mne_bids.report import make_report
 from mne_bids.path import (BIDSPath, get_datatypes, get_entity_vals,

setup.py

@@ -65,6 +65,7 @@
               'Programming Language :: Python :: 3.6',
               'Programming Language :: Python :: 3.7',
               'Programming Language :: Python :: 3.8',
+              'Programming Language :: Python :: 3.9',
           ],
           platforms='any',
           packages=find_packages(),