From a6567f6037934376293ce7d88d5a2d1061bf6645 Mon Sep 17 00:00:00 2001 From: Thomas Samuel Binns Date: Wed, 11 Dec 2024 11:54:15 +0000 Subject: [PATCH 1/3] Add missing changelog entries --- doc/authors.inc | 1 + doc/whats_new.rst | 21 +++++++++++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/authors.inc b/doc/authors.inc index 61ead35b8..a2edeb73e 100644 --- a/doc/authors.inc +++ b/doc/authors.inc @@ -16,3 +16,4 @@ .. _Richard Köhler: https://github.com/richardkoehler .. _Mohammad Orabe: https://github.com/orabe .. _Mina Jamshidi: https://github.com/minajamshidi +.. _Marijn van Vliet: https://github.com/wmvanvliet \ No newline at end of file diff --git a/doc/whats_new.rst b/doc/whats_new.rst index 1738fd14b..39380c353 100644 --- a/doc/whats_new.rst +++ b/doc/whats_new.rst @@ -19,20 +19,37 @@ Here we list a changelog of MNE-connectivity. Version 0.8 (in dev) -------------------- +Functionality now requires ``Python >= 3.10``. + Enhancements ~~~~~~~~~~~~ - +- Add a new :class:`~mne_connectivity.decoding.CoherencyDecomposition` class for decomposing connectivity sources using multivariate coherency-based methods, by `Thomas Binns`_ (:pr:`193`). +- Add new plotting methods :meth:`~mne_connectivity.decoding.CoherencyDecomposition.plot_filters` and :meth:`~mne_connectivity.decoding.CoherencyDecomposition.plot_patterns` to the :class:`~mne_connectivity.decoding.CoherencyDecomposition` class for visualising the decomposed connectivity sources, by `Thomas Binns`_ (:pr:`208`). +- Add support for computing multiple components of multivariate connectivity in the :func:`~mne_connectivity.spectral_connectivity_epochs` and :func:`~mne_connectivity.spectral_connectivity_time` functions and :class:`~mne_connectivity.decoding.CoherencyDecomposition` class, and add support for storing data with a components dimension in all :class:`~mne_connectivity.Connectivity` classes, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`213`). +- Add support for :class:`mne.time_frequency.EpochsSpectrum` objects to be passed as data to the :func:`~mne_connectivity.spectral_connectivity_epochs` function, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`220`). +- Update the cross-references for relevant function and classes and make data types more explicit throughout the documentation, by `Thomas Binns`_ (:pr:`214`). +- Improve the documentation of the ``fmin`` and ``cwt_freqs`` parameters in the :func:`~mne_connectivity.spectral_connectivity_epochs` function, by `Richard Köhler`_ and `Daniel McCloy`_ (:pr:`242`). Bug ~~~ +API +~~~ + +- Add a new ``min_distance`` parameter to the :func:`~mne_connectivity.viz.plot_sensors_connectivity` function which offers greater control over the minimum distance required between sensors to plot a connection between them, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`221`). + Authors ~~~~~~~ - +* `Thomas Binns`_ +* `Richard Köhler`_ +* `Adam Li`_ +* `Marijn van Vliet`_ +* `Eric Larson`_ +* `Daniel McCloy`_ :doc:`Find out what was new in previous releases ` From e554f0e51c3ac941c2117db6d7b8e5725eebedd0 Mon Sep 17 00:00:00 2001 From: "Thomas S. Binns" Date: Wed, 11 Dec 2024 18:46:49 +0000 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Daniel McCloy --- doc/authors.inc | 2 +- doc/whats_new.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/authors.inc b/doc/authors.inc index a2edeb73e..5d75113f2 100644 --- a/doc/authors.inc +++ b/doc/authors.inc @@ -16,4 +16,4 @@ .. _Richard Köhler: https://github.com/richardkoehler .. _Mohammad Orabe: https://github.com/orabe .. _Mina Jamshidi: https://github.com/minajamshidi -.. _Marijn van Vliet: https://github.com/wmvanvliet \ No newline at end of file +.. _Marijn van Vliet: https://github.com/wmvanvliet diff --git a/doc/whats_new.rst b/doc/whats_new.rst index 39380c353..fb39247cd 100644 --- a/doc/whats_new.rst +++ b/doc/whats_new.rst @@ -19,13 +19,13 @@ Here we list a changelog of MNE-connectivity. Version 0.8 (in dev) -------------------- -Functionality now requires ``Python >= 3.10``. +Minimum supported Python version is now 3.10. Enhancements ~~~~~~~~~~~~ - Add a new :class:`~mne_connectivity.decoding.CoherencyDecomposition` class for decomposing connectivity sources using multivariate coherency-based methods, by `Thomas Binns`_ (:pr:`193`). -- Add new plotting methods :meth:`~mne_connectivity.decoding.CoherencyDecomposition.plot_filters` and :meth:`~mne_connectivity.decoding.CoherencyDecomposition.plot_patterns` to the :class:`~mne_connectivity.decoding.CoherencyDecomposition` class for visualising the decomposed connectivity sources, by `Thomas Binns`_ (:pr:`208`). +- Add new plotting methods :meth:`CoherencyDecomposition.plot_filters() ` and :meth:`CoherencyDecomposition.plot_patterns() ` for visualising the decomposed connectivity sources, by `Thomas Binns`_ (:pr:`208`). - Add support for computing multiple components of multivariate connectivity in the :func:`~mne_connectivity.spectral_connectivity_epochs` and :func:`~mne_connectivity.spectral_connectivity_time` functions and :class:`~mne_connectivity.decoding.CoherencyDecomposition` class, and add support for storing data with a components dimension in all :class:`~mne_connectivity.Connectivity` classes, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`213`). - Add support for :class:`mne.time_frequency.EpochsSpectrum` objects to be passed as data to the :func:`~mne_connectivity.spectral_connectivity_epochs` function, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`220`). - Update the cross-references for relevant function and classes and make data types more explicit throughout the documentation, by `Thomas Binns`_ (:pr:`214`). From 1e441d496b4c6835782856fce395e587e804c9b5 Mon Sep 17 00:00:00 2001 From: Thomas Samuel Binns Date: Wed, 11 Dec 2024 18:50:24 +0000 Subject: [PATCH 3/3] Add further suggestions from review --- doc/whats_new.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/whats_new.rst b/doc/whats_new.rst index fb39247cd..ef9bd4c47 100644 --- a/doc/whats_new.rst +++ b/doc/whats_new.rst @@ -28,13 +28,12 @@ Enhancements - Add new plotting methods :meth:`CoherencyDecomposition.plot_filters() ` and :meth:`CoherencyDecomposition.plot_patterns() ` for visualising the decomposed connectivity sources, by `Thomas Binns`_ (:pr:`208`). - Add support for computing multiple components of multivariate connectivity in the :func:`~mne_connectivity.spectral_connectivity_epochs` and :func:`~mne_connectivity.spectral_connectivity_time` functions and :class:`~mne_connectivity.decoding.CoherencyDecomposition` class, and add support for storing data with a components dimension in all :class:`~mne_connectivity.Connectivity` classes, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`213`). - Add support for :class:`mne.time_frequency.EpochsSpectrum` objects to be passed as data to the :func:`~mne_connectivity.spectral_connectivity_epochs` function, by `Thomas Binns`_ and `Eric Larson`_ (:pr:`220`). -- Update the cross-references for relevant function and classes and make data types more explicit throughout the documentation, by `Thomas Binns`_ (:pr:`214`). -- Improve the documentation of the ``fmin`` and ``cwt_freqs`` parameters in the :func:`~mne_connectivity.spectral_connectivity_epochs` function, by `Richard Köhler`_ and `Daniel McCloy`_ (:pr:`242`). +- Update the cross-references for relevant functions and classes and make data types more explicit throughout the documentation, by `Thomas Binns`_ (:pr:`214`). Bug ~~~ - +- Improve the documentation of the ``fmin`` and ``cwt_freqs`` parameters in the :func:`~mne_connectivity.spectral_connectivity_epochs` function, by `Richard Köhler`_ and `Daniel McCloy`_ (:pr:`242`). API ~~~