Skip to content

Commit b85b5e3

Browse files
committed
enh: reorganize documentation and redirect to nipreps docs
1 parent d7f9c89 commit b85b5e3

File tree

4 files changed

+39
-144
lines changed

4 files changed

+39
-144
lines changed

docs/source/docker.rst

Lines changed: 0 additions & 106 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Contents
1414

1515
about
1616
install
17-
running
18-
docker
17+
usage
1918
measures
2019
reports
2120
workflows

docs/source/install.rst

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,22 @@
11

2-
Installation
3-
************
4-
Containerized versions
5-
----------------------
6-
If you have Docker installed, the quickest way to get ``mriqc`` to work
7-
is following :ref:`the running with docker guide <docker>`.
8-
9-
We recommend trying containerized versions first to avoid installation
10-
issues.
11-
MRIQC uses bleeding-edge (oftentimes unreleased) versions of
12-
``nipype`` and ``niworkflows`` and "bare-metal" installations can
13-
be hard.
14-
Nonetheless, we offer support on our `github repository
15-
<https://github.com/nipreps/mriqc/issues>`_.
16-
2+
Installing *MRIQC*
3+
******************
4+
*MRIQC* is a *NiPreps* (`www.nipreps.org <https://nipreps.org>`__)
5+
*BIDS App* [BIDSApps]_.
6+
As such, *MRIQC* can be installed manually (*Bare-metal installation*,
7+
see below) or containerized.
8+
For containerized execution with *Docker* or *Singularity*, please
9+
follow the documentation on the *NiPreps* site
10+
(`introduction <https://www.nipreps.org/apps/framework/>`__).
1711

1812
"Bare-metal" installation
1913
-------------------------
20-
If, for some reason, you really need a bare-metal installation,
21-
MRIQC can be installed as follows.
14+
If, for some reason, you really need a custom installation,
15+
*MRIQC* can be installed as follows.
2216
First, please make sure you have the execution system dependencies
2317
installed (see below).
2418
Second, the latest development version of MRIQC can be installed from
25-
github using ``pip`` on a Python 3 environment: ::
19+
github using ``pip`` on a Python 3 environment:
2620

2721
python -m pip install -U mriqc
2822

@@ -55,8 +49,6 @@ github using ``pip`` on a Python 3 environment: ::
5549

5650
$ sed -i 's/\(backend *: \).*$/\1Agg/g' $( python -c "import matplotlib; print(matplotlib.matplotlib_fname())" )
5751
58-
59-
6052
Execution system dependencies
6153
.............................
6254
If you are using a a `Neurodebian <http://neuro.debian.net/>`_ Linux distribution,

docs/source/running.rst renamed to docs/source/usage.rst

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,34 @@
33

44
Running *MRIQC*
55
***************
6-
.. tip::
7-
Try MRIQC online on `OpenNeuro <https://www.openneuro.org/>`_ - without
8-
installation!
9-
10-
MRIQC is a `BIDS-App <http://bids-apps.neuroimaging.io/>`_ [BIDSApps]_,
6+
*MRIQC* is a `BIDS-App <http://bids-apps.neuroimaging.io/>`_ [BIDSApps]_,
117
and therefore it inherently understands the :abbr:`BIDS (brain
12-
imaging data structure)` standard [BIDS]_ and follows the
13-
BIDS-Apps standard command line interface::
8+
imaging data structure)` standard [BIDS]_.
9+
Before moving forward, please make sure to have read and understood
10+
*NiPreps*'s
11+
`introductory documentation <https://www.nipreps.org/apps/framework/>`__).
12+
13+
Containerized execution with *Docker* and *Singularity*
14+
-------------------------------------------------------
15+
For containerized execution with *Docker* or *Singularity*, please
16+
follow the documentation on the *NiPreps* site, which contains
17+
tip and troubleshooting guidelines for both
18+
`Docker <https://www.nipreps.org/apps/docker/>`__, and
19+
`Singularity or Apptainer <https://www.nipreps.org/apps/singularity/>`__.
20+
In addition to container-specific guidelines, the documentation
21+
also includes specific
22+
`help for processing DataLad-managed datasets <https://www.nipreps.org/apps/datalad/>`__
23+
24+
The rest of this documentation page applies to both *bare-metal*
25+
and containerized execution modes.
26+
27+
A *BIDS Apps* command line interface
28+
------------------------------------
29+
*MRIQC* follows the *BIDS Apps* standard command line interface::
1430

1531
mriqc bids-root/ output-folder/ participant
1632

17-
That simple command runs MRIQC on all the *T1w* and *BOLD* images found
33+
That simple command runs *MRIQC* on all the *T1w* and *BOLD* images found
1834
under the BIDS-compliant folder ``bids-root/``.
1935
The last ``participant`` keyword indicates that the first level analysis
2036
is run. (i.e. extracting the :abbr:`IQMs (image quality metrics)` from the
@@ -80,14 +96,10 @@ Command line interface
8096

8197
Running mriqc on HPC clusters
8298
-----------------------------
83-
Singularity containers
84-
......................
85-
Requesting resources
86-
....................
8799
We have profiled cores and memory usages with the *resource profiler*
88-
tool of nipype.
100+
tool of *Nipype*.
89101

90-
An MRIQC run of one subject (from the ABIDE) dataset, containing only one
102+
An *MRIQC* run of one subject (from the ABIDE) dataset, containing only one
91103
run, one BOLD task (resting-state) yielded the following report:
92104

93105
.. raw:: html
@@ -117,5 +129,3 @@ on ds030 of OpenfMRI:
117129
.. [BIDS] `Brain Imaging Data Structure <http://bids.neuroimaging.io/>`_
118130
.. [BIDSApps] `BIDS-Apps: portable neuroimaging pipelines that understand BIDS
119131
datasets <http://bids-apps.neuroimaging.io/>`_
120-
121-
.. include:: license.rst

0 commit comments

Comments
 (0)