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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
.. include:: ../links.inc
.. _manual-install:
.. _standard-instructions:
Install via :code:`pip` or :code:`conda`
========================================
.. hint::
If you're unfamiliar with Python, we recommend using our :ref:`installers`
instead.
MNE-Python requires Python version |min_python_version| or higher. If you
need to install Python, please see :ref:`install-python`.
Installing MNE-Python with all dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
We suggest to install MNE-Python into its own ``conda`` environment.
The dependency stack is large and may take a long time (several tens of
minutes) to resolve on some systems via the default ``conda`` solver. We
therefore highly recommend using `mamba <https://mamba.readthedocs.io/>`__
instead, a ``conda`` replacement that is **much** faster.
Run in your terminal:
.. code-block:: console
$ conda install --channel=conda-forge --name=base mamba
$ mamba create --override-channels --channel=conda-forge --name=mne mne
This will create a new ``conda`` environment called ``mne`` (you can adjust
this by passing a different name via ``--name``) and install all
dependencies into it.
If you need to convert structural MRI scans into models
of the scalp, inner/outer skull, and cortical surfaces, you will also need
:doc:`FreeSurfer <freesurfer>`.
Installing a minimal MNE-Python with core functionality only
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you only need MNE-Python's core functionality including 2D plotting (but
**without 3D visualization**), install via :code:`pip`:
.. code-block:: console
$ pip install mne
or via :code:`conda`:
.. code-block:: console
$ conda create --strict-channel-priority --channel=conda-forge --name=mne mne-base
This will create a new ``conda`` environment called ``mne`` (you can adjust
this by passing a different name via ``--name``).
Installing a minimal MNE-Python with EEGLAB I/O support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you plan to use MNE-Python's functions that require **HDF5 I/O** (this
includes :func:`mne.io.read_raw_eeglab`, :meth:`mne.SourceMorph.save`, and
others), you should run via :code:`pip`:
.. code-block:: console
$ pip install mne[hdf5]
or via :code:`conda`
.. code-block:: console
$ conda create --strict-channel-priority --channel=conda-forge --name=mne mne-base h5io h5py pymatreader
This will create a new ``conda`` environment called ``mne`` (you can adjust
this by passing a different name via ``--name``).
Installing MNE-Python for other scenarios
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The :ref:`advanced_setup` page has additional
tips and tricks for special situations (servers, notebooks, CUDA, installing
the development version, etc). The :ref:`contributing` has additional
installation instructions for (future) contributors to MNE-Python (e.g, extra
dependencies for running our tests and building our documentation).
Python IDEs
===========
Most users find it convenient to write and run their code in an `Integrated
Development Environment`_ (IDE). Some popular choices for scientific
Python development are:
- `Visual Studio Code`_ (often shortened to "VS Code" or "vscode") is a
development-focused text editor that supports many programming languages in
addition to Python, includes an integrated terminal console, and has a rich
ecosystem of packages to extend its capabilities. Installing
`Microsoft's Python Extension
<https://marketplace.visualstudio.com/items?itemName=ms-python.python>`__ is
enough to get most Python users up and running. VS Code is free and
open-source.
- `Spyder`_ is a free and open-source IDE developed by and for scientists who
use Python. It is included by default in the ``base`` environment when you
install Anaconda, and can be started from a terminal with the command
``spyder`` (or on Windows or macOS, launched from the Anaconda Navigator GUI).
It can also be installed with `dedicated installers <https://www.spyder-ide.org/#section-download>`_.
To avoid dependency conflicts with Spyder, you should install ``mne`` in a
separate environment, like explained in the earlier sections. Then, set
Spyder to use the ``mne`` environment as its default interpreter by opening
Spyder and navigating to
:samp:`Tools > Preferences > Python Interpreter > Use the following interpreter`.
There, paste the output of the following terminal commands
.. code-block:: console
$ conda activate mne
$ python -c "import sys; print(sys.executable)"
It should be something like ``C:\Users\user\anaconda3\envs\mne\python.exe``
(Windows) or ``/Users/user/opt/anaconda3/envs/mne/bin/python`` (macOS).
If the Spyder console can not start because ``spyder-kernels`` is missing,
install the required version in the ``mne`` environment with the following
commands in the terminal, where you replace ``...`` with the exact version of
``spyder-kernels`` that Spyder tells you it requires.
.. code-block:: console
$ conda activate mne
$ conda install --strict-channel-priority --channel=conda-forge spyder-kernels=...
Refer to the `Spyder documentation <https://docs.spyder-ide.org/current/troubleshooting/common-illnesses.html#spyder-kernels-not-installed-incompatible>`_
for more information about ``spyder-kernels`` and the version matching.
If the Spyder graphic backend is not set to ``inline`` but to e.g. ``Qt5``,
``PyQt5`` (``pip``) or ``pyqt`` (``conda``) must be installed in the ``mne``
environment.
- `PyCharm`_ is an IDE specifically for Python development that provides an
all-in-one installation (no extension packages needed). PyCharm comes in a
free "community" edition and a paid "professional" edition, and is
closed-source.
|
