MRG: Start 0.10 dev cycle (#920)

doc/whats_new.rst

@@ -7,27 +7,17 @@
 What's new?
 ===========
 
-.. _changes_0_9:
+.. _changes_0_10:
 
-Version 0.9 (2021-11-23)
-------------------------
+Version 0.10 (unreleased)
+-------------------------
 
-This release brings compatibility with MNE-Python 0.24 and some new convenience
-functions and speedups of existing code to help you be more productive! 👩🏽‍💻
-And, of course, plenty of bug fixes. 🐞
+...
 
 Notable changes
 ~~~~~~~~~~~~~~~
 
-- 🧠 Compatibility with MNE-Python 0.24!
-- 👻 Anonymize an entire BIDS dataset via :func:`mne_bids.anonymize_dataset`!
-- 🏝 Conveniently turn a path into a :class:`BIDSPath` via
-  :func:`get_bids_path_from_fname`!
-- 🏎 :func:`mne_bids.stats.count_events` and :meth:`mne_bids.BIDSPath.match`
-  are operating **much** faster now!
-- 🔍 :func:`write_raw_bids` now stores the names of the input files in the
-  ``source`` column of ``*_scans.tsv``, making it easier for you to
-  *go back to the source* should you ever need to!
+- ...
 
 Authors
 ~~~~~~~
@@ -37,11 +27,7 @@ People who contributed to this release (in alphabetical order):
 * `Adam Li`_
 * `Alex Rockhill`_
 * `Alexandre Gramfort`_
-* `Clemens Brunner`_
-* `Franziska von Albedyll`_
-* `Julia Guiomar Niso Galán`_
 * `Mainak Jas`_
-* `Marijn van Vliet`_
 * `Richard Höchenberger`_
 * `Stefan Appelhoff`_
 
@@ -51,72 +37,22 @@ Detailed list of changes
 Enhancements
 ^^^^^^^^^^^^
 
-- :func:`mne_bids.get_anat_landmarks` now accepts a :class:`mne_bids.BIDSPath` as ``image`` parameter, by `Alex Rockhill`_ (:gh:`852`)
-
-- :func:`mne_bids.write_raw_bids` now accepts ``'EDF'`` as a ``'format'`` value to force conversion to EDF files, by `Adam Li`_ (:gh:`866`)
-
-- :func:`mne_bids.write_raw_bids` now adds ``SpatialCompensation`` information to the JSON sidecar for MEG data, by `Julia Guiomar Niso Galán`_ (:gh:`885`)
-
-- Modify iEEG tutorial to use MNE ``raw`` object, by `Alex Rockhill`_ (:gh:`859`)
-
-- Add :func:`mne_bids.search_folder_for_text` to find specific metadata entries (e.g. all ``"n/a"`` sidecar data fields, or to check that "60 Hz" was written properly as the power line frequency), by `Alex Rockhill`_ (:gh: `870`)
-
-- Add :func:`mne_bids.get_bids_path_from_fname` to return a :class:`mne_bids.BIDSPath` from a file path, by `Adam Li`_ (:gh:`883`)
-
-- Great performance improvements in :func:`mne_bids.stats.count_events` and :meth:`mne_bids.BIDSPath.match`, significantly reducing processing time, by `Richard Höchenberger`_ (:gh:`888`)
-
-- The command ``mne_bids count_events`` gained new parameters: ``--output`` to direct the output into a CSV file; ``--overwrite`` to overwrite an existing file; and  ``--silent`` to suppress output of the event counts to the console, by `Richard Höchenberger`_ (:gh:`888`)
-
-- The new function :func:`mne_bids.anonymize_dataset` can be used to anonymize an entire BIDS dataset, by `Richard Höchenberger`_ (:gh:`893`, :gh:`914`, :gh:`917`)
-
-- :meth:`mne_bids.BIDSPath.find_empty_room` gained a new parameter ``use_sidecar_only`` to limit empty-room search to the metadata stored in the sidecar files, by `Richard Höchenberger`_ (:gh:`893`)
-
-- :meth:`mne_bids.BIDSPath.find_empty_room` gained a new parameter ``verbose`` to limit verbosity of the output, by `Richard Höchenberger`_ (:gh:`893`)
-
-- :func:`mne_bids.write_raw_bids` can now write the source filename to ``scans.tsv`` in a new column, ``source``, by `Adam Li`_ (:gh:`890`)
+- ...
 
 API and behavior changes
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-- ``mne_bids.mark_bad_channels`` deprecated in favor of :func:`mne_bids.mark_channels`, which allows specifying the status to change channels to by `Adam Li`_ (:gh:`882`)
-
-- :func:`mne_bids.get_entities_from_fname` does not return ``suffix`` anymore as that is not considered a BIDS entity, by `Adam Li`_ (:gh:`883`)
-
-- Reading BIDS data with ``"HeadCoilFrequency"`` and ``"PowerLineFrequency"`` data specified in JSON sidecars will only "warn" in case of mismatches between Raw and JSON data, by `Franziska von Albedyll`_ (:gh:`855`)
-
-- Accessing :attr:`mne_bids.BIDSPath.fpath` emit a warning anymore if the path does not exist. This behavior was unreliable and yielded confusing error messages in certain use cases. Use `mne_bids.BIDSPath.fpath.exists()` to check whether the path exists in the file system, by `Richard Höchenberger`_ (:gh:`904`)
-
-- :func:`mne_bids.get_entity_vals` gained a new parameter, ``ignore_dirs``, to exclude directories from the search, by `Adam Li`_ and `Richard Höchenberger`_ (:gh:`899`, :gh:`908`)
-
-- In :func:`mne_bids.write_anat`, the deprecated parameters ``raw``, ``trans``, and ``t1w`` have been removed, by `Richard Höchenberger`_ (:gh:`909`)
-
-- In :func:`mne_bids.write_raw_bids`, any EDF output is always stored with lower-case extension (``.edf``), by `Adam Li`_ (:gh:`906`)
+- ...
 
 Requirements
 ^^^^^^^^^^^^
 
-- MNE-BIDS now requires MNE-Python 0.24 or newer.
-
-- Writing BrainVision files now requires ``pybv`` version 0.6, by `Stefan Appelhoff`_ (:gh:`880`)
+- ...
 
 Bug fixes
 ^^^^^^^^^
 
-- Fix writing Ricoh/KIT data that comes without an associated ``.mrk``, ``.elp``, or ``.hsp`` file using :func:`mne_bids.write_raw_bids`, by `Richard Höchenberger`_ (:gh:`850`)
-
-- Properly support CTF MEG data with 2nd-order gradient compensation, by `Mainak Jas`_ (:gh:`858`)
-
-- Fix writing and reading EDF files with upper-case extension (``.EDF``), by `Adam Li`_ (:gh:`868`)
-
-- Fix reading of TSV files with only a single column, by `Marijn van Vliet`_ (:gh:`886`)
-
-- Fix erroneous measurement date check in :func:`mne_bids.write_raw_bids` when requesting to anonymize empty-room data, by `Richard Höchenberger`_ (:gh:`893`)
-
-- :func:`mne_bids.write_raw_bids` now raises an exception if the provided :class:`mne_bids.BIDSPath` doesn't contain ``subject`` and ``task`` entities, which are required for neurophysiological data, by `Richard Höchenberger`_ (:gh:`903`)
-
-- :func:`mne_bids.read_raw_bids` now handles datasets with multiple electrophysiological data types correctly, by `Richard Höchenberger`_ (:gh:`910`, :gh`916`)
-
-- More robust handling of situations where :func:`mne_bids.read_raw_bids` tries to read a file that does not exist, by `Richard Höchenberger`_ (:gh:`904`)
+- ...
 
 :doc:`Find out what was new in previous releases <whats_new_previous_releases>`
 

doc/whats_new_previous_releases.rst

@@ -7,6 +7,117 @@
 What was new in previous releases?
 ==================================
 
+.. _changes_0_9:
+
+Version 0.9 (2021-11-23)
+------------------------
+
+This release brings compatibility with MNE-Python 0.24 and some new convenience
+functions and speedups of existing code to help you be more productive! 👩🏽‍💻
+And, of course, plenty of bug fixes. 🐞
+
+Notable changes
+~~~~~~~~~~~~~~~
+
+- 🧠 Compatibility with MNE-Python 0.24!
+- 👻 Anonymize an entire BIDS dataset via :func:`mne_bids.anonymize_dataset`!
+- 🏝 Conveniently turn a path into a :class:`BIDSPath` via
+  :func:`get_bids_path_from_fname`!
+- 🏎 :func:`mne_bids.stats.count_events` and :meth:`mne_bids.BIDSPath.match`
+  are operating **much** faster now!
+- 🔍 :func:`write_raw_bids` now stores the names of the input files in the
+  ``source`` column of ``*_scans.tsv``, making it easier for you to
+  *go back to the source* should you ever need to!
+
+Authors
+~~~~~~~
+
+People who contributed to this release (in alphabetical order):
+
+* `Adam Li`_
+* `Alex Rockhill`_
+* `Alexandre Gramfort`_
+* `Clemens Brunner`_
+* `Franziska von Albedyll`_
+* `Julia Guiomar Niso Galán`_
+* `Mainak Jas`_
+* `Marijn van Vliet`_
+* `Richard Höchenberger`_
+* `Stefan Appelhoff`_
+
+Detailed list of changes
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Enhancements
+^^^^^^^^^^^^
+
+- :func:`mne_bids.get_anat_landmarks` now accepts a :class:`mne_bids.BIDSPath` as ``image`` parameter, by `Alex Rockhill`_ (:gh:`852`)
+
+- :func:`mne_bids.write_raw_bids` now accepts ``'EDF'`` as a ``'format'`` value to force conversion to EDF files, by `Adam Li`_ (:gh:`866`)
+
+- :func:`mne_bids.write_raw_bids` now adds ``SpatialCompensation`` information to the JSON sidecar for MEG data, by `Julia Guiomar Niso Galán`_ (:gh:`885`)
+
+- Modify iEEG tutorial to use MNE ``raw`` object, by `Alex Rockhill`_ (:gh:`859`)
+
+- Add :func:`mne_bids.search_folder_for_text` to find specific metadata entries (e.g. all ``"n/a"`` sidecar data fields, or to check that "60 Hz" was written properly as the power line frequency), by `Alex Rockhill`_ (:gh: `870`)
+
+- Add :func:`mne_bids.get_bids_path_from_fname` to return a :class:`mne_bids.BIDSPath` from a file path, by `Adam Li`_ (:gh:`883`)
+
+- Great performance improvements in :func:`mne_bids.stats.count_events` and :meth:`mne_bids.BIDSPath.match`, significantly reducing processing time, by `Richard Höchenberger`_ (:gh:`888`)
+
+- The command ``mne_bids count_events`` gained new parameters: ``--output`` to direct the output into a CSV file; ``--overwrite`` to overwrite an existing file; and  ``--silent`` to suppress output of the event counts to the console, by `Richard Höchenberger`_ (:gh:`888`)
+
+- The new function :func:`mne_bids.anonymize_dataset` can be used to anonymize an entire BIDS dataset, by `Richard Höchenberger`_ (:gh:`893`, :gh:`914`, :gh:`917`)
+
+- :meth:`mne_bids.BIDSPath.find_empty_room` gained a new parameter ``use_sidecar_only`` to limit empty-room search to the metadata stored in the sidecar files, by `Richard Höchenberger`_ (:gh:`893`)
+
+- :meth:`mne_bids.BIDSPath.find_empty_room` gained a new parameter ``verbose`` to limit verbosity of the output, by `Richard Höchenberger`_ (:gh:`893`)
+
+- :func:`mne_bids.write_raw_bids` can now write the source filename to ``scans.tsv`` in a new column, ``source``, by `Adam Li`_ (:gh:`890`)
+
+API and behavior changes
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+- ``mne_bids.mark_bad_channels`` deprecated in favor of :func:`mne_bids.mark_channels`, which allows specifying the status to change channels to by `Adam Li`_ (:gh:`882`)
+
+- :func:`mne_bids.get_entities_from_fname` does not return ``suffix`` anymore as that is not considered a BIDS entity, by `Adam Li`_ (:gh:`883`)
+
+- Reading BIDS data with ``"HeadCoilFrequency"`` and ``"PowerLineFrequency"`` data specified in JSON sidecars will only "warn" in case of mismatches between Raw and JSON data, by `Franziska von Albedyll`_ (:gh:`855`)
+
+- Accessing :attr:`mne_bids.BIDSPath.fpath` emit a warning anymore if the path does not exist. This behavior was unreliable and yielded confusing error messages in certain use cases. Use `mne_bids.BIDSPath.fpath.exists()` to check whether the path exists in the file system, by `Richard Höchenberger`_ (:gh:`904`)
+
+- :func:`mne_bids.get_entity_vals` gained a new parameter, ``ignore_dirs``, to exclude directories from the search, by `Adam Li`_ and `Richard Höchenberger`_ (:gh:`899`, :gh:`908`)
+
+- In :func:`mne_bids.write_anat`, the deprecated parameters ``raw``, ``trans``, and ``t1w`` have been removed, by `Richard Höchenberger`_ (:gh:`909`)
+
+- In :func:`mne_bids.write_raw_bids`, any EDF output is always stored with lower-case extension (``.edf``), by `Adam Li`_ (:gh:`906`)
+
+Requirements
+^^^^^^^^^^^^
+
+- MNE-BIDS now requires MNE-Python 0.24 or newer.
+
+- Writing BrainVision files now requires ``pybv`` version 0.6, by `Stefan Appelhoff`_ (:gh:`880`)
+
+Bug fixes
+^^^^^^^^^
+
+- Fix writing Ricoh/KIT data that comes without an associated ``.mrk``, ``.elp``, or ``.hsp`` file using :func:`mne_bids.write_raw_bids`, by `Richard Höchenberger`_ (:gh:`850`)
+
+- Properly support CTF MEG data with 2nd-order gradient compensation, by `Mainak Jas`_ (:gh:`858`)
+
+- Fix writing and reading EDF files with upper-case extension (``.EDF``), by `Adam Li`_ (:gh:`868`)
+
+- Fix reading of TSV files with only a single column, by `Marijn van Vliet`_ (:gh:`886`)
+
+- Fix erroneous measurement date check in :func:`mne_bids.write_raw_bids` when requesting to anonymize empty-room data, by `Richard Höchenberger`_ (:gh:`893`)
+
+- :func:`mne_bids.write_raw_bids` now raises an exception if the provided :class:`mne_bids.BIDSPath` doesn't contain ``subject`` and ``task`` entities, which are required for neurophysiological data, by `Richard Höchenberger`_ (:gh:`903`)
+
+- :func:`mne_bids.read_raw_bids` now handles datasets with multiple electrophysiological data types correctly, by `Richard Höchenberger`_ (:gh:`910`, :gh`916`)
+
+- More robust handling of situations where :func:`mne_bids.read_raw_bids` tries to read a file that does not exist, by `Richard Höchenberger`_ (:gh:`904`)
+
 .. _changes_0_8:
 
 Version 0.8 (2021-07-15)

mne_bids/__init__.py

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