File: getting_started.rst

package info (click to toggle)
python-mne 0.17%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 95,104 kB
  • sloc: python: 110,639; makefile: 222; sh: 15
file content (77 lines) | stat: -rw-r--r-- 2,108 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
: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-C’s functionality, offer transparent scripting,
        and extend MNE-C’s 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.