Files
mne-python/doc/getting_started.rst
Eric Larson d902ce646a MRG+3: Refactor documentation (#4173)
* prototype new tutorials

* updating style of tutorials_new

* updating tutorials -> guide

* updates to the guide

* updating doc headers etc

* updating titles

* remove faq from navbar

* FIX: Minor fixes

* collapsible lists

* top level section to io

* rearrange IO examples

* FIX: Distribute examples

* Update documentation.rst

* de-capitalize

* FIX: Fix text [ci skip]
2017-05-02 16:00:00 +02:00

78 lines
2.1 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
:orphan:
.. include:: links.inc
.. _installation:
Installation
============
To get started with MNE, visit the installation instructions for
the :ref:`MNE<install_python_and_mne_python>`. You can optionally also
install :ref:`MNE-C <install_mne_c>`:
.. container:: row
.. container:: panel panel-default halfpad
.. container:: panel-heading nosize
MNE python module
.. container:: panel-body nosize
.. toctree::
:maxdepth: 2
install_mne_python
.. container:: panel panel-default halfpad
.. container:: panel-heading nosize
MNE-C
.. container:: panel-body nosize
.. toctree::
:maxdepth: 2
install_mne_c
.. container:: row
.. container:: panel panel-default
.. container:: panel-heading nosize
Historical notes
.. container:: panel-body nosize
MNE started as tool written in C by Matti Hämäläinen while at MGH in
Boston.
- :ref:`MNE-C <c_reference>` is Matti's C code. Historically, MNE was
a software package for computing cortically constrained Minimum Norm
Estimates from MEG and EEG data.
- The MNE python module was built in the Python programming language to
reimplement all MNE-Cs functionality, offer transparent scripting,
and extend MNE-Cs functionality considerably (see left). Thus it is
the primary focus of this documentation.
- :ref:`ch_matlab` is available mostly to allow reading and writing
FIF files.
- :ref:`mne_cpp` aims to provide modular and open-source tools for
real-time acquisition, visualization, and analysis. It provides
a :ref:`separate website <mne_cpp>` for documentation and releases.
The MNE tools are based on the FIF file format from Neuromag.
However, MNE can read native CTF, BTI/4D, KIT and various
EEG formats (see :ref:`IO functions <ch_convert>`).
If you have been using MNE-C, there is no need to convert your fif
files to a new system or database -- MNE works nicely with
the historical fif files.