Skip to content

mne_tools_suite.rst

Latest commit

 

History

History
72 lines (54 loc) · 3.04 KB

mne_tools_suite.rst

File metadata and controls

72 lines (54 loc) · 3.04 KB

Overview of the MNE tools suite

.. tags:: installation, interoperability, mne-c, mne-python

MNE-Python is an open-source Python module for processing, analysis, and visualization of functional neuroimaging data (EEG, MEG, sEEG, ECoG, and fNIRS). There are several related or interoperable software packages that you may also want to install, depending on your analysis needs.

Related software

  • MNE-C was the initial stage of this project, providing a set of interrelated command-line and GUI programs focused on computing cortically constrained Minimum Norm Estimates from MEG and EEG data. These tools were written in C by Matti Hämäläinen, and are documented `here <MNE-C manual_>`_. See :ref:`install_mne_c` for installation instructions.
  • MNE-Python reimplements the functionality of MNE-C, extends considerably the analysis and visualization capabilities, and adds support for additional data types like functional near-infrared spectroscopy (fNIRS). MNE-Python is collaboratively developed and has more than 200 contributors.
  • `MNE-MATLAB`_ provides a MATLAB interface to the .fif file format and other MNE data structures, and provides example MATLAB implementations of some of the core analysis functionality of MNE-C. It is distributed alongside MNE-C, and can also be downloaded from the `MNE-MATLAB`_ GitHub repository.
  • :ref:`MNE-CPP <mne_cpp>` provides core MNE functionality implemented in C++ and is primarily intended for embedded and real-time applications.

There is also a growing ecosystem of other Python packages that work alongside MNE-Python, including:

Note

Something missing?

If you know of a package that is related but not listed here, feel free to to add it to this list by :ref:`making a pull request <contributing>` to update doc/sphinxext/related_software.py.

.. related-software::

What should I install?

If you intend only to perform ERP, ERF, or other sensor-level analyses, :ref:`MNE-Python <standard-instructions>` is all you need. If you prefer to work with shell scripts and the Unix command line, or prefer MATLAB over Python, probably all you need is :doc:`MNE-C <mne_c>` — the MNE MATLAB toolbox is distributed with it — although note that the C tools and the MATLAB toolbox are less actively developed than the MNE-Python module, and hence are considerably less feature-complete.

If you want to transform sensor recordings into estimates of localized brain activity, you will need MNE-Python, plus :doc:`FreeSurfer <freesurfer>` to convert structural MRI scans into models of the scalp, inner/outer skull, and cortical surfaces (specifically, for command-line functions :ref:`mne flash_bem`, :ref:`mne watershed_bem`, and :ref:`mne make_scalp_surfaces`).

Getting help

Help with installation is available through the `MNE Forum`_. See the :ref:`help` page for more information.