• Stars
    star
    2,556
  • Rank 17,820 (Top 0.4 %)
  • Language
    Python
  • License
    BSD 3-Clause "New...
  • Created over 13 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

MNE: Magnetoencephalography (MEG) and Electroencephalography (EEG) in Python

PyPI conda-forge Zenodo Discourse Codecov Bandit OpenSSF

MNE

MNE-Python

MNE-Python software is an open-source Python package for exploring, visualizing, and analyzing human neurophysiological data such as MEG, EEG, sEEG, ECoG, and more. It includes modules for data input/output, preprocessing, visualization, source estimation, time-frequency analysis, connectivity analysis, machine learning, and statistics.

Documentation

MNE documentation for MNE-Python is available online.

Forum

Our user forum is https://mne.discourse.group and is the best place to ask questions about MNE-Python usage or about the contribution process. It also includes job opportunities and other announcements.

Installing MNE-Python

To install the latest stable version of MNE-Python, you can use pip in a terminal:

$ pip install --upgrade mne
  • MNE-Python 0.17 was the last release to support Python 2.7
  • MNE-Python 0.18 requires Python 3.5 or higher
  • MNE-Python 0.21 requires Python 3.6 or higher
  • MNE-Python 0.24 requires Python 3.7 or higher
  • MNE-Python 1.4 requires Python 3.8 or higher

For more complete instructions and more advanced installation methods (e.g. for the latest development version), see the installation guide.

Get the latest code

To install the latest version of the code using pip open a terminal and type:

$ pip install --upgrade git+https://github.com/mne-tools/mne-python@main

To get the latest code using git, open a terminal and type:

$ git clone https://github.com/mne-tools/mne-python.git

Dependencies

The minimum required dependencies to run MNE-Python are:

  • Python >= 3.8
  • NumPy >= 1.21.2
  • SciPy >= 1.7.1
  • Matplotlib >= 3.4.3
  • pooch >= 1.5
  • tqdm
  • Jinja2
  • decorator
  • lazy_loader

For full functionality, some functions require:

  • Scikit-learn >= 1.0
  • joblib >= 0.15 (for parallelization control)
  • mne-qt-browser >= 0.1 (for fast raw data visualization)
  • Qt5 >= 5.12 via one of the following bindings (for fast raw data visualization and interactive 3D visualization):
    • PyQt6 >= 6.0
    • PySide6 >= 6.0
    • PyQt5 >= 5.12
    • PySide2 >= 5.12
  • Numba >= 0.54.0
  • NiBabel >= 3.2.1
  • OpenMEEG >= 2.5.6
  • Pandas >= 1.3.2
  • Picard >= 0.3
  • CuPy >= 9.0.0 (for NVIDIA CUDA acceleration)
  • DIPY >= 1.4.0
  • Imageio >= 2.8.0
  • PyVista >= 0.32 (for 3D visualization)
  • pyvistaqt >= 0.4 (for 3D visualization)
  • mffpy >= 0.5.7
  • h5py
  • h5io
  • pymatreader

Contributing to MNE-Python

Please see the documentation on the MNE-Python homepage:

https://mne.tools/dev/install/contributing.html

Licensing

MNE-Python is BSD-licenced (BSD-3-Clause):

This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative.

Copyright (c) 2011-2022, authors of MNE-Python. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the names of MNE-Python authors nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission.

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

More Repositories

1

mne-cpp

MNE-CPP: A Framework for Electrophysiology
C++
148
star
2

mne-bids-pipeline

Automatically process entire electrophysiological datasets using MNE-Python.
Python
137
star
3

mne-features

MNE-Features software for extracting features from multivariate time series
Python
134
star
4

mne-bids

MNE-BIDS is a Python package that allows you to read and write BIDS-compatible datasets with the help of MNE-Python.
Python
129
star
5

mne-icalabel

Automatic labeling of ICA components in Python.
Python
88
star
6

mne-nirs

Process Near-Infrared Spectroscopy Data in MNE
Python
79
star
7

mne-connectivity

Connectivity algorithms that leverage the MNE-Python API.
Python
68
star
8

mne-realtime

Realtime data analysis with MNE-Python
Python
52
star
9

mne-lsl

A framework for real-time brain signal streaming with MNE-Python.
Python
46
star
10

mne-qt-browser

A new backend for the 2D data browser in MNE-Python
Python
39
star
11

mne-matlab

MNE scripting with Matlab
MATLAB
34
star
12

mne-workshops

A collection of workshop materials.
Jupyter Notebook
31
star
13

dipole-simulator

Interactive demonstration of how dipole location and orientation affect MEG and EEG sensor signals
Python
29
star
14

mne-r

Fast Access to MNE-Python From Within R
R
28
star
15

mne-python-notebooks

IPython notebooks for EEG/MEG data processing using mne-python
25
star
16

mne-torch

Repository of sample scripts to train deep learning model with PyTorch and MNE
Python
23
star
17

mne-testing-data

Data for mne-python testing
HolyC
22
star
18

mne-biomag-group-demo

Group analysis demo with MNE
Python
22
star
19

mne-hcp

MNE-HCP for processing the Human Connectome Project MEG data using MNE-Python
Python
22
star
20

mne-incubator

Experimental versions of M/EEG analysis code
Python
16
star
21

mne-hfo

Estimate/compute high-frequency oscillations (HFOs) from iEEG data that are BIDS and MNE compatible using a scikit-learn-style API.
Python
13
star
22

mne-tools.github.io

GitHub pages for mne-tools
HTML
11
star
23

mne-docker

Repository for mne docker images
Jupyter Notebook
11
star
24

mne-gsoc2018-3d

Sandbox for GSoC 2018 3D Viz
Python
9
star
25

awesome-mne

A curated list of awesome MNE tutorials, projects and communities.
8
star
26

mne-installers

Installers for MNE-Python.
Shell
8
star
27

mne-scripts

Sample scripts based on MNE
Shell
8
star
28

mne-binder

Integration with mybinder.org
Dockerfile
5
star
29

mne-dash

Remote visualization for mne tools
Python
4
star
30

mne-python-intro-slides

MNE-Python presentation
CSS
4
star
31

fiff-constants

Bookkeeping and documentation of FIFF file format constants
4
star
32

mne-cpp-presentations

MNE-CPP toolbox & applications presentations
4
star
33

mne-misc-data

Miscellaneous data
AGS Script
3
star
34

mne-kit-gui

Python
2
star
35

sprint2019

MNE Code Sprint 2019 @ Hosted at Facebook
CSS
2
star
36

mne-project-template

MNE Project Template - Helps getting started with your project !
Python
2
star
37

mne-cpp-test-data

Minimal MNE-CPP test data set
1
star
38

mne-openmeeg

Integration of MNE and OpenMEEG
Python
1
star