Skip to content

Commit

Permalink
start developing 0.16
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Jun 4, 2024
1 parent 8ea1024 commit db40a04
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 42 deletions.
50 changes: 8 additions & 42 deletions doc/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,20 @@
What's new?
===========

.. _changes_0_15:
.. _changes_0_16:

Version 0.15 (unreleased)
Version 0.16 (unreleased)
-------------------------

👩🏽‍💻 Authors
~~~~~~~~~~~~~~~

The following authors contributed for the first time. Thank you so much! 🤩

* `Mara Wolter`_
* `Julius Welzel`_
* nobody yet

The following authors had contributed before. Thank you for sticking around! 🤘

* `Alex Rockhill`_
* `Daniel McCloy`_
* `Eric Larson`_
* `Laetitia Fesselier`_
* `Mathieu Scheltienne`_
* `Richard Höchenberger`_
* `Stefan Appelhoff`_

Detailed list of changes
Expand All @@ -36,54 +29,27 @@ Detailed list of changes
🚀 Enhancements
^^^^^^^^^^^^^^^

- Including a description for ``onset`` and ``duration`` in the ``events.json`` file, by `Julius Welzel`_ (:gh:`1255`)
- nothing yet

🧐 API and behavior changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^

- The experimental support for running MNE-BIDS examples from your browser using Binder has
been removed, by `Stefan Appelhoff`_ (:gh:`1202`)
- MNE-BIDS will no longer zero-pad ("zfill") entity indices passed to :class:`~mne_bids.BIDSPath`.
For example, If ``run=1`` is passed to MNE-BIDS, it will no longer be silently auto-converted to ``run-01``, by `Alex Rockhill`_ (:gh:`1215`)
- MNE-BIDS will no longer warn about missing leading punctuation marks for extensions passed :class:`~mne_bids.BIDSPath`.
For example, MNE-BIDS will now silently auto-convert ``edf`` to ```.edf``, by `Alex Rockhill`_ (:gh:`1215`)
- MNE-BIDS will no longer error during `~mne_bids.write_raw_bids` if there are ``BAD_ACQ_SKIP`` annotations in the raw file and no corresponding key in ``event_id``.
Instead, it will automatically add the necessary key and assign an unused integer event code to it. By `Daniel McCloy`_ (:gh:`1258`)
- nothing yet

🛠 Requirements
^^^^^^^^^^^^^^^

- MNE-BIDS now requires Python 3.9 or higher.
- MNE-BIDS now requires MNE-Python 1.5.0 or higher.
- ``edfio`` replaces ``EDFlib-Python`` for export to EDF with MNE-Python >= 1.7.0.
- Installing ``mne-bids[full]`` will now also install ``defusedxml`` on all platforms.
- Version requirements for optional dependency packages have been bumped up, see installation instructions.
- nothing yet

🪲 Bug fixes
^^^^^^^^^^^^

- The datatype in the dataframe returned by :func:`mne_bids.stats.count_events` is now
``pandas.Int64Dtype`` instead of ``float64``, by `Eric Larson`_ (:gh:`1227`)
- The :func:`mne_bids.copyfiles.copyfile_ctf` now accounts for files with ``.{integer}_meg4`` extension, instead of only .meg4,
when renaming the files of a .ds folder, by `Mara Wolter`_ (:gh:`1230`)
- We fixed handling of time zones when reading ``*_scans.tsv`` files; specifically, non-UTC timestamps are now processed correctly,
by `Stefan Appelhoff`_ and `Richard Höchenberger`_ (:gh:`1240`)
- nothing yet

⚕️ Code health
^^^^^^^^^^^^^^

- The configuration of MNE-BIDS has been consolidated from several files (e.g., ``setup.cfg``,
``setup.py``, ``requirements.txt``) and is now specified in a standard ``pyproject.toml``
file, by `Stefan Appelhoff`_ (:gh:`1202`)
- Linting and code formatting is now done entirely using ``ruff``. Previously used tools
(e.g., ``flake8``, ``black``) have been fully replaced, by `Stefan Appelhoff`_ (:gh:`1203`)
- The package build backend has been switched from ``setuptools`` to ``hatchling``. This
only affects users who build and install MNE-BIDS from source, and should not lead to
changed runtime behavior, by `Richard Höchenberger`_ (:gh:`1204`)
- Display of the version number on the website is now truncated for over-long version strings,
by `Daniel McCloy`_ (:gh:`1206`)
- The long deprecated ``events_data`` parameter has been fully removed from
:func:`~mne_bids.write_raw_bids` in favor of ``events``, by `Stefan Appelhoff`_ (:gh:`1229`)
- nothing yet

:doc:`Find out what was new in previous releases <whats_new_previous_releases>`

Expand Down
78 changes: 78 additions & 0 deletions doc/whats_new_previous_releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,84 @@
What was new in previous releases?
==================================

.. _changes_0_15:

Version 0.15 (2024-06-04)
-------------------------

👩🏽‍💻 Authors
~~~~~~~~~~~~~~~

The following authors contributed for the first time. Thank you so much! 🤩

* `Mara Wolter`_
* `Julius Welzel`_

The following authors had contributed before. Thank you for sticking around! 🤘

* `Alex Rockhill`_
* `Daniel McCloy`_
* `Eric Larson`_
* `Laetitia Fesselier`_
* `Mathieu Scheltienne`_
* `Richard Höchenberger`_
* `Stefan Appelhoff`_

Detailed list of changes
~~~~~~~~~~~~~~~~~~~~~~~~

🚀 Enhancements
^^^^^^^^^^^^^^^

- Including a description for ``onset`` and ``duration`` in the ``events.json`` file, by `Julius Welzel`_ (:gh:`1255`)

🧐 API and behavior changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^

- The experimental support for running MNE-BIDS examples from your browser using Binder has
been removed, by `Stefan Appelhoff`_ (:gh:`1202`)
- MNE-BIDS will no longer zero-pad ("zfill") entity indices passed to :class:`~mne_bids.BIDSPath`.
For example, If ``run=1`` is passed to MNE-BIDS, it will no longer be silently auto-converted to ``run-01``, by `Alex Rockhill`_ (:gh:`1215`)
- MNE-BIDS will no longer warn about missing leading punctuation marks for extensions passed :class:`~mne_bids.BIDSPath`.
For example, MNE-BIDS will now silently auto-convert ``edf`` to ```.edf``, by `Alex Rockhill`_ (:gh:`1215`)
- MNE-BIDS will no longer error during `~mne_bids.write_raw_bids` if there are ``BAD_ACQ_SKIP`` annotations in the raw file and no corresponding key in ``event_id``.
Instead, it will automatically add the necessary key and assign an unused integer event code to it. By `Daniel McCloy`_ (:gh:`1258`)

🛠 Requirements
^^^^^^^^^^^^^^^

- MNE-BIDS now requires Python 3.9 or higher.
- MNE-BIDS now requires MNE-Python 1.5.0 or higher.
- ``edfio`` replaces ``EDFlib-Python`` for export to EDF with MNE-Python >= 1.7.0.
- Installing ``mne-bids[full]`` will now also install ``defusedxml`` on all platforms.
- Version requirements for optional dependency packages have been bumped up, see installation instructions.

🪲 Bug fixes
^^^^^^^^^^^^

- The datatype in the dataframe returned by :func:`mne_bids.stats.count_events` is now
``pandas.Int64Dtype`` instead of ``float64``, by `Eric Larson`_ (:gh:`1227`)
- The :func:`mne_bids.copyfiles.copyfile_ctf` now accounts for files with ``.{integer}_meg4`` extension, instead of only .meg4,
when renaming the files of a .ds folder, by `Mara Wolter`_ (:gh:`1230`)
- We fixed handling of time zones when reading ``*_scans.tsv`` files; specifically, non-UTC timestamps are now processed correctly,
by `Stefan Appelhoff`_ and `Richard Höchenberger`_ (:gh:`1240`)

⚕️ Code health
^^^^^^^^^^^^^^

- The configuration of MNE-BIDS has been consolidated from several files (e.g., ``setup.cfg``,
``setup.py``, ``requirements.txt``) and is now specified in a standard ``pyproject.toml``
file, by `Stefan Appelhoff`_ (:gh:`1202`)
- Linting and code formatting is now done entirely using ``ruff``. Previously used tools
(e.g., ``flake8``, ``black``) have been fully replaced, by `Stefan Appelhoff`_ (:gh:`1203`)
- The package build backend has been switched from ``setuptools`` to ``hatchling``. This
only affects users who build and install MNE-BIDS from source, and should not lead to
changed runtime behavior, by `Richard Höchenberger`_ (:gh:`1204`)
- Display of the version number on the website is now truncated for over-long version strings,
by `Daniel McCloy`_ (:gh:`1206`)
- The long deprecated ``events_data`` parameter has been fully removed from
:func:`~mne_bids.write_raw_bids` in favor of ``events``, by `Stefan Appelhoff`_ (:gh:`1229`)

.. _changes_0_14:

Version 0.14 (2023-11-16)
Expand Down

0 comments on commit db40a04

Please sign in to comment.