Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/_includes/bem_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Using the watershed algorithm

The watershed algorithm [Segonne *et al.*,
2004] is part of the FreeSurfer software.
The name of the program is mri_watershed_.
The name of the program is `mri_watershed <https://surfer.nmr.mgh.harvard.edu/fswiki/mri_watershed>`__.
Its use in the MNE environment is facilitated by the script
:ref:`mne watershed_bem`.

Expand Down
4 changes: 3 additions & 1 deletion doc/api/mri.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Step by step instructions for using :func:`gui.coregistration`:
- `Coregistration for subjects with structural MRI
<https://www.slideshare.net/mne-python/mnepython-coregistration>`_
- `Scaling a template MRI for subjects for which no MRI is available
<https://www.slideshare.net/mne-python/mnepython-scale-mri>`_
<MRI scaling slides_>`__

See also:

Expand Down Expand Up @@ -39,3 +39,5 @@ See also:
transforms.compute_volume_registration
vertex_to_mni
coreg.Coregistration

.. include:: ../links.inc
2 changes: 2 additions & 0 deletions doc/changes/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
.. _current:

.. towncrier-draft-entries:: Version |release| (development)

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/dev.rst.template
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
.. _current:

.. towncrier-draft-entries:: Version |release| (development)

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ of commits):
* 41 Emily Ruzich
* 2 Martin Luessi
* 9 Matti Hämäläinen

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,5 @@ The committer list for this release is the following (preceded by number of comm
* 3 Daniel McCloy
* 3 Daniel Strohmeier
* 1 Jussi Nurminen

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,5 @@ The committer list for this release is the following (preceded by number of comm
* 2 emilyps14
* 2 lennyvarghese
* 1 Marian Dovgialo

.. include:: names.inc
4 changes: 4 additions & 0 deletions doc/changes/v0.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,3 +209,7 @@ The committer list for this release is the following (preceded by number of comm
* 1 pbnsilva
* 1 sviter
* 1 zuxfoucault

.. include:: names.inc

.. include:: ../links.inc
6 changes: 5 additions & 1 deletion doc/changes/v0.13.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ API

5. Previously, if the filter was as long or longer than the signal of interest, direct FFT-based computations were used. Now a single code path (overlap-add filtering) is used for all FIR filters. This could cause minor changes in how short signals are filtered.

- Support for Python 2.6 has been dropped, and the minimum supported dependencies are NumPy_ 1.8, SciPy_ 0.12, and Matplotlib_ 1.3 by `Eric Larson`_
- Support for Python 2.6 has been dropped, and the minimum supported dependencies are `NumPy <http://www.numpy.org>`__ 1.8, `SciPy <http://www.scipy.org>`__ 0.12, and Matplotlib_ 1.3 by `Eric Larson`_

- When CTF gradient compensation is applied to raw data, it is no longer reverted on save of :meth:`mne.io.Raw.save` by `Eric Larson`_

Expand Down Expand Up @@ -246,3 +246,7 @@ The committer list for this release is the following (sorted by alphabetical ord
* Simon-Shlomo Poil
* Teon Brooks
* Yaroslav Halchenko

.. include:: names.inc

.. include:: ../links.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.14.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,3 +248,5 @@ People who contributed to this release (in alphabetical order):
* Stefan Repplinger
* Teon Brooks
* Yaroslav Halchenko

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.15.rst
Original file line number Diff line number Diff line change
Expand Up @@ -327,3 +327,5 @@ People who contributed to this release (in alphabetical order):
* Simon Kern
* Teon Brooks
* Yousra Bekhti

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.16.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,3 +256,5 @@ People who contributed to this release (in alphabetical order):
* Stefan Repplinger
* Tommy Clausner
* Yaroslav Halchenko

.. include:: names.inc
6 changes: 5 additions & 1 deletion doc/changes/v0.17.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Changelog

- Add helmet for Artemis123 for :func:`mne.viz.plot_alignment` by `Eric Larson`_

- Add support for reading MATLAB ``v7.3+`` files in :func:`mne.io.read_raw_eeglab` and :func:`mne.read_epochs_eeglab` via `pymatreader`_ by `Steven Gutstein`_, `Eric Larson`_, and `Thomas Hartmann`_
- Add support for reading MATLAB ``v7.3+`` files in :func:`mne.io.read_raw_eeglab` and :func:`mne.read_epochs_eeglab` via `pymatreader <https://gitlab.com/obob/pymatreader>`__ by `Steven Gutstein`_, `Eric Larson`_, and `Thomas Hartmann`_

- Add support for raw PSD plots in :meth:`mne.Report.parse_folder` via ``raw_psd`` argument of :class:`mne.Report` by `Eric Larson`_

Expand Down Expand Up @@ -315,3 +315,7 @@ People who contributed to this release (in alphabetical order):
* Tristan Stenner
* buildqa
* jeythekey

.. include:: names.inc

.. include:: ../links.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.18.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,3 +266,5 @@ API
- The peak finder that was formerly accessible via ``from mne.preprocessing.peak_finder import peak_finder`` should now be imported directly from the enclosing namespace as ``from mne.preprocessing import peak_finder`` by `Eric Larson`_

- Deprecate ``mne.realtime`` module to make a standalone module ``mne-realtime`` that will live outside of this package by `Teon Brooks`_

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.19.rst
Original file line number Diff line number Diff line change
Expand Up @@ -230,3 +230,5 @@ API
- Reading annotations contained in GDF files with :func:`mne.io.read_raw_gdf` now returns numeric event codes as descriptions (instead of textual descriptions) due to restrictive licensing of the GDF event code table from BioSig by `Clemens Brunner`_

- ``channels.find_ch_connectivity`` now returns pre-built neighbor maps for KIT systems when available, by `Christian Brodbeck`_

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,5 @@ of commits):
* 12 Martin Luessi
* 2 Yaroslav Halchenko
* 1 Manfred Kitzbichler

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.20.rst
Original file line number Diff line number Diff line change
Expand Up @@ -405,3 +405,5 @@ People who contributed to this release (in alphabetical order):
* Thomas Hartmann
* Victor Férat
* Yu-Han Luo

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.21.rst
Original file line number Diff line number Diff line change
Expand Up @@ -472,3 +472,5 @@ People who contributed to this release in alphabetical order
* Yu-Han Luo
* chapochn
* mshader

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.22.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,3 +251,5 @@ People who contributed to this release in alphabetical order
* Thomas Hartmann
* Tod Flak +
* Victoria Peterson +

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.23.rst
Original file line number Diff line number Diff line change
Expand Up @@ -366,3 +366,5 @@ People who contributed to this release in alphabetical order
* Victoria Peterson
* Yu-Han Luo
* Zhi Zhang+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.24.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,3 +394,5 @@ People who contributed to this release in alphabetical order
* Timothy Gates+
* Valerii Chirkov
* Xiaokai Xia+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,5 @@ of commits):

* 80 Alexandre Gramfort
* 51 Martin Luessi

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,5 @@ of commits):
* 4 Christian Brodbeck
* 4 Louis Thibault
* 2 Brad Buran

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,5 @@ of commits):
* 6 Daniel Strohmeier
* 4 Teon Brooks
* 1 Dan G. Wakeman

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,5 @@ of commits):
* 5 Brad Buran
* 1 Andrew Dykstra
* 1 Christoph Dinh

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,5 @@ of commits):
* 1 Luke Bloy
* 1 Emanuele Olivetti
* 1 Yousra BEKHTI

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,5 @@ The committer list for this release is the following (preceded by number of comm
* 2 Alan Leggitt
* 1 Jean-Rémi King
* 1 Matti Hämäläinen

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v0.9.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,3 +237,5 @@ The committer list for this release is the following (preceded by number of comm
* 1 Romain Trachel
* 1 mads jensen
* 1 sviter

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -305,3 +305,5 @@ Authors
* Stefan Appelhoff
* Steve Matindi
* Thomas Hartmann

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,3 +269,5 @@ Authors
* Stefan Appelhoff
* T. Wang+
* Tziona NessAiver+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,5 @@ Authors
* Wei Xu+
* Yixiao Shen+
* user27182+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,5 @@ Authors
* Tom Ma
* Wouter Kroot+
* Young Truong

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,5 @@ Authors
- Thomas S. Binns
- Varun Kasyap Pentamaraju+
- Victor Férat

.. include:: names.inc
4 changes: 4 additions & 0 deletions doc/changes/v1.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,7 @@ Authors
* Stefan Appelhoff
* Valerii Chirkov
* luzpaz+

.. include:: names.inc

.. include:: ../links.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,5 @@ Authors
* Timon Merk
* Tom Ma+
* Toomas Erik Anijärv+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,5 @@ Authors
* Tom Stone+
* Toomas Erik Anijärv
* Zvi Baratz+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,5 @@ Authors
* Stefan Appelhoff
* Thomas Moreau
* Yiping Zuo+

.. include:: names.inc
2 changes: 2 additions & 0 deletions doc/changes/v1.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,5 @@ Authors
* Santeri Ruuskanen
* Scott Huberty
* Stefan Appelhoff

.. include:: names.inc
8 changes: 6 additions & 2 deletions doc/changes/v1.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Version 1.7.1 (2024-06-14)
Bugfixes
--------

- Fix bug where :func:`mne.time_frequency.csd_multitaper`, :func:`mne.time_frequency.csd_fourier`, :func:`mne.time_frequency.csd_array_multitaper`, and :func:`mne.time_frequency.csd_array_fourier` would return cross-spectral densities with the ``fmin`` and ``fmax`` frequencies missing, by `Thomas Binns`_ (`#12633 <https://github.com/mne-tools/mne-python/pull/12633>`__)
- Fix incorrect RuntimeWarning (different channel filter settings) in EDF/BDF import, by `Clemens Brunner`_. (`#12661 <https://github.com/mne-tools/mne-python/pull/12661>`__)
- Fix bug where :func:`mne.time_frequency.csd_multitaper`, :func:`mne.time_frequency.csd_fourier`, :func:`mne.time_frequency.csd_array_multitaper`, and :func:`mne.time_frequency.csd_array_fourier` would return cross-spectral densities with the ``fmin`` and ``fmax`` frequencies missing, by `Thomas Binns`_ (:gh:`12633`)
- Fix incorrect RuntimeWarning (different channel filter settings) in EDF/BDF import, by `Clemens Brunner`_. (:gh:`12661`)

Authors
-------
Expand Down Expand Up @@ -195,3 +195,7 @@ Authors
* Velu Prabhakar Kumaravel+
* Will Turner+
* btkcodedev+

.. include:: names.inc

.. include:: ../links.inc
6 changes: 4 additions & 2 deletions doc/changes/v1.8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Bugfixes
- Fix overflow when plotting source estimates where data is all zero (or close to zero), and fix the range of allowed values for the colorbar sliders, by `Marijn van Vliet`_. (`#12612 <https://github.com/mne-tools/mne-python/pull/12612>`__)
- Fix adding channels to :class:`~mne.time_frequency.EpochsTFR` objects, by `Clemens Brunner`_. (`#12616 <https://github.com/mne-tools/mne-python/pull/12616>`__)
- Fix for new sklearn metadata routing protocol in decoding search_light, by `Alex Gramfort`_ (`#12620 <https://github.com/mne-tools/mne-python/pull/12620>`__)
- Fix bug where :func:`mne.time_frequency.csd_multitaper`, :func:`mne.time_frequency.csd_fourier`, :func:`mne.time_frequency.csd_array_multitaper`, and :func:`mne.time_frequency.csd_array_fourier` would return cross-spectral densities with the ``fmin`` and ``fmax`` frequencies missing, by `Thomas Binns`_ (`#12633 <https://github.com/mne-tools/mne-python/pull/12633>`__)
- Fix bug where :func:`mne.time_frequency.csd_multitaper`, :func:`mne.time_frequency.csd_fourier`, :func:`mne.time_frequency.csd_array_multitaper`, and :func:`mne.time_frequency.csd_array_fourier` would return cross-spectral densities with the ``fmin`` and ``fmax`` frequencies missing, by `Thomas Binns`_ (:gh:`12633`)
- Output types of sparse arrays were changed from ``matrix`` to ``array`` in
:func:`~mne.channels.read_ch_adjacency`, :func:`~mne.channels.find_ch_adjacency`,
:func:`~mne.stats.combine_adjacency`, :func:`~mne.spatio_temporal_src_adjacency`,
Expand All @@ -45,7 +45,7 @@ Bugfixes
for both ``np.matrix`` and ``np.ndarray`` objects, and if a matrix is desired
the outputs can be cast directly, for example as ``scipy.sparse.csr_matrix(out)``.
Changed by `Eric Larson`_. (`#12646 <https://github.com/mne-tools/mne-python/pull/12646>`__)
- Fix incorrect RuntimeWarning (different channel filter settings) in EDF/BDF import, by `Clemens Brunner`_. (`#12661 <https://github.com/mne-tools/mne-python/pull/12661>`__)
- Fix incorrect RuntimeWarning (different channel filter settings) in EDF/BDF import, by `Clemens Brunner`_. (:gh:`12661`)
- In :func:`mne.export.export_raw` (``fmt='edf'``), when padding data to create equal-length data blocks,
edge-padding is favored over zero-padding in order to avoid accidentally enlarging physical range, by `Qian Chu`_. (`#12676 <https://github.com/mne-tools/mne-python/pull/12676>`__)
- In :func:`mne.io.read_raw_eyelink`, gracefully handle missing datetime in file by `Scott Huberty`_. (`#12687 <https://github.com/mne-tools/mne-python/pull/12687>`__)
Expand Down Expand Up @@ -171,3 +171,5 @@ Authors
* Stefan Appelhoff
* Thomas S. Binns
* Xabier de Zuazo+

.. include:: names.inc
4 changes: 3 additions & 1 deletion doc/changes/v1.9.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Version 1.9.0 (2024-12-18)
Dependencies
------------

- Minimum supported dependencies were updated in accordance with SPEC0_, most notably Python 3.10+ is now required. (`#12798 <https://github.com/mne-tools/mne-python/pull/12798>`__)
- Minimum supported dependencies were updated in accordance with `SPEC0 <https://scientific-python.org/specs/spec-0000>`__, most notably Python 3.10+ is now required. (`#12798 <https://github.com/mne-tools/mne-python/pull/12798>`__)
- Importing from ``mne.decoding`` now explicitly requires ``scikit-learn`` to be installed,
by `Eric Larson`_. (`#12834 <https://github.com/mne-tools/mne-python/pull/12834>`__)
- Compatibility improved for Python 3.13, by `Eric Larson`_. (`#13021 <https://github.com/mne-tools/mne-python/pull/13021>`__)
Expand Down Expand Up @@ -126,3 +126,5 @@ Authors
* Thomas S. Binns
* Victor Férat
* Ziyi ZENG+

.. include:: names.inc
17 changes: 13 additions & 4 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@
sys.path.append(str(curpath / "sphinxext"))

from credit_tools import generate_credit_rst # noqa: E402
from mne_doc_utils import report_scraper, reset_warnings, sphinx_logger # noqa: E402
from mne_doc_utils import ( # noqa: E402
check_links,
report_scraper,
reset_warnings,
sphinx_logger,
)

# -- Project information -----------------------------------------------------

Expand Down Expand Up @@ -1097,11 +1102,14 @@ def fix_sklearn_inherited_docstrings(app, what, name, obj, options, lines):
rst_prolog += """
.. |ensp| unicode:: U+2002 .. EN SPACE

.. include:: /links.inc
.. include:: /changes/names.inc

.. currentmodule:: mne
"""
# NB: names.inc (~400 contributor-name targets) and links.inc are deliberately
# NOT part of rst_prolog. Parsing them into every document is wasteful (and
# Sphinx's ReorderConsecutiveTargetAndIndexNodes transform is quadratic in the
# length of a consecutive run of targets, so names.inc alone cost over a minute
# of build time this way). The pages that use these link targets include the
# files explicitly instead.

# -- Dependency info ----------------------------------------------------------

Expand Down Expand Up @@ -1517,6 +1525,7 @@ def setup(app):
app.connect("autodoc-process-docstring", append_attr_meth_examples)
app.connect("autodoc-process-docstring", fix_sklearn_inherited_docstrings)
# High prio, will happen before SG
app.connect("builder-inited", check_links, priority=5)
app.connect("builder-inited", generate_credit_rst, priority=10)
app.connect("builder-inited", report_scraper.set_dirs, priority=20)
app.connect("build-finished", make_gallery_redirects)
Expand Down
2 changes: 2 additions & 0 deletions doc/credits/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ and the :ref:`supporting institutions and sponsors <funding>` that together make
leaders
credit
sponsors

.. include:: ../changes/names.inc
6 changes: 5 additions & 1 deletion doc/credits/leaders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Advisory Board
Community Participation Guidelines Response Leads
-------------------------------------------------

See our `Community Participation Guidelines <https://github.com/mne-tools/.github/blob/main/CODE_OF_CONDUCT.md>`__
See our `Community Participation Guidelines <code of conduct_>`__
for explanation. Current Response Leads are:

* `Daniel McCloy`_
Expand All @@ -90,3 +90,7 @@ Document history
----------------

https://github.com/mne-tools/mne-python/commits/main/doc/overview/people.rst

.. include:: ../changes/names.inc

.. include:: ../links.inc
Loading
Loading