Skip to content

Commit

Permalink
MRG, DOC: Integrate manual parts (mne-tools#6767)
Browse files Browse the repository at this point in the history
* DOC: Integrate manual parts

* integrate SSP-api into tutorial

* add URL for MNE-C manual PDF

* fix: missing newline at EOF breaks RST rendering?

* fix dead crossref

* cleanups/tweaks

* STY: PEP8

* typos

* [skip travis][skip azp] tweaks to install doc sequence
  • Loading branch information
larsoner authored and Alex Rockhill committed Oct 1, 2019
1 parent c12ba92 commit bde0f98
Show file tree
Hide file tree
Showing 133 changed files with 676 additions and 14,889 deletions.
2 changes: 1 addition & 1 deletion doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ general neuroimaging concepts. If you think a term is missing, please consider
one anatomy to another. It is commonly referred as realignment in fMRI
literature. This operation is necessary for group studies (to get the
data in a common space for statistical analysis).
See :ref:`c_legacy_ch_morph` for more details.
See :ref:`ch_morph` for more details.

pick
An integer that is the index of a channel in the measurement info.
Expand Down
2 changes: 1 addition & 1 deletion doc/install/freesurfer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ need to install ``tcsh`` for FreeSurfer to work; ``tcsh`` is usually
pre-installed with macOS, and is available in the package repositories for
Linux-based systems (e.g., ``sudo apt install tcsh`` on Ubuntu-like systems).

**Next:** :doc:`mne_c`
**Next:** :doc:`advanced`

.. LINKS
Expand Down
11 changes: 9 additions & 2 deletions doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Installation — contents
=======================

The MNE software products are open-source tools for processing, analysis, and
MNE-Python is an open-source Python module for processing, analysis, and
visualization of functional neuroimaging data (EEG, MEG, sEEG, ECoG, and
fNIRS). Pages describing the installation procedure are listed below. The
:ref:`contributing guide <contributing>` has advanced installation instructions
Expand All @@ -15,5 +15,12 @@ for (future) contributors to MNE-Python.
pre_install
mne_python
freesurfer
mne_c
advanced

Installation instructions are also provided for MNE-C (the Unix command-line
tools originally developed by Matti Hämäläinen).

.. toctree::
:maxdepth: 2

mne_c
7 changes: 2 additions & 5 deletions doc/install/mne_c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,8 @@ disk space. MATLAB is an optional dependency; the free `MATLAB runtime`_ is
sufficient. If MATLAB is not present, the utilities ``mne_convert_mne_data``,
``mne_epochs2mat``, ``mne_raw2mat``, and ``mne_simu`` will not work.

For boundary-element model (BEM) mesh generation (see :doc:`Creating the BEM
meshes <../manual/appendix/bem_model>`), and for accessing the ``tkmedit``
program from ``mne_analyze`` (see :ref:`CACCHCBF`), MNE-C needs access to a
For boundary-element model (BEM) mesh generation, and for accessing the ``tkmedit``
program from ``mne_analyze``, MNE-C needs access to a
working installation of :doc:`FreeSurfer <freesurfer>`, including the
environment variables ``FREESURFER_HOME``, ``SUBJECTS_DIR``, and ``SUBJECT``.

Expand Down Expand Up @@ -183,8 +182,6 @@ a typical 64-bit Ubuntu-like system this would be accomplished by:
If you encounter other errors installing MNE-C, please send a message to the
`MNE mailing list`_.

**Next:** :doc:`advanced`

.. links
.. _MNE-C download page: http://www.nmr.mgh.harvard.edu/martinos/userInfo/data/MNE_register/index.php
Expand Down
32 changes: 15 additions & 17 deletions doc/install/pre_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ Before you install
Overview of the MNE tools suite
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- :doc:`MNE-C <../manual/c_reference>` was the initial stage of this project,
- 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.
data. These tools were written in C by Matti Hämäläinen, and are
documented `here <MNE-C manual_>`_.

- :doc:`MNE-Python <../python_reference>` reimplements the functionality of
MNE-C, and extends considerably the analysis and visualization capabilities.
MNE-Python is collaboratively developed and has more than 150 contributors.

- The :doc:`../manual/matlab` provides a MATLAB interface to the .fif file
- The :ref:`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
Expand Down Expand Up @@ -54,23 +55,20 @@ What should I install?
^^^^^^^^^^^^^^^^^^^^^^

If you intend only to perform ERP, ERF, or other sensor-level analyses,
:doc:`MNE-Python <mne_python>` is all you need. If you 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 MATLAB toolbox
is less actively developed than the MNE-Python module, and hence the MATLAB
code is considerably less feature-complete.
:doc:`MNE-Python <mne_python>` 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 most likely need:
activity, you will most likely also need :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:`gen_mne_flash_bem`, :ref:`gen_mne_watershed_bem`, and
:ref:`gen_mne_make_scalp_surfaces`).

- :doc:`FreeSurfer <freesurfer>` to convert structural MRI scans into
models of the scalp, inner/outer skull, and cortical surfaces

- :doc:`MNE-C <mne_c>` for constructing and solving a boundary-element
model of tissue conductance, and for aligning coordinate frames between the
structural MRI and the digitizations of M/EEG sensor locations

- :doc:`MNE-Python <mne_python>` can be used for everything else

Getting help
^^^^^^^^^^^^
Expand Down
1 change: 1 addition & 0 deletions doc/links.inc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
.. _`mne-python sample dataset`: https://s3.amazonaws.com/mne-python/datasets/MNE-sample-data-processed.tar.gz
.. _`mne command line utilities`: http://www.nmr.mgh.harvard.edu/martinos/userInfo/data/MNE_register/
.. _`mne-scripts`: https://github.com/mne-tools/mne-scripts/
.. _`MNE-C manual`: https://mne.tools/mne-c-manual/MNE-manual-2.7.3.pdf
.. _`MNE mailing list`: http://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis
.. _`GitHub issues page`: https://github.com/mne-tools/mne-python/issues/
.. _`MNE gitter channel`: https://gitter.im/mne-tools/mne-python
Expand Down
140 changes: 0 additions & 140 deletions doc/manual/appendix/c_EULA.rst

This file was deleted.

104 changes: 0 additions & 104 deletions doc/manual/appendix/c_misc.rst

This file was deleted.

Loading

0 comments on commit bde0f98

Please sign in to comment.