index.rst

|:brain:| meegkit: EEG and MEG denoising in Python

Introduction

meegkit is a collection of EEG and MEG denoising techniques for Python 3.8+. Please feel free to contribute, or suggest new analyses. Keep in mind that this is mostly development code, and as such is likely to change without any notice. Also, while most of the methods have been fairly robustly tested, bugs can (and should!) be expected.

The source code of the project is hosted on Github at the following address: https://github.com/nbara/python-meegkit

To get started, follow the installation instructions in the README.

Available modules

Here is a list of the methods and techniques available in meegkit:

.. currentmodule:: meegkit

.. toctree::
   :maxdepth: 1

.. autosummary::
   :caption: meegkit

   ~meegkit.asr
   ~meegkit.cca
   ~meegkit.dss
   ~meegkit.detrend
   ~meegkit.lof
   ~meegkit.phase
   ~meegkit.ress
   ~meegkit.sns
   ~meegkit.star
   ~meegkit.trca
   ~meegkit.tspca
   ~meegkit.utils

Examples gallery

A number of example scripts and notebooks are available:

.. toctree::
   :maxdepth: 2

   auto_examples/index

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`