|
3 | 3 |
|
4 | 4 | Running *MRIQC*
|
5 | 5 | ***************
|
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]_, |
11 | 7 | 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:: |
14 | 30 |
|
15 | 31 | mriqc bids-root/ output-folder/ participant
|
16 | 32 |
|
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 |
18 | 34 | under the BIDS-compliant folder ``bids-root/``.
|
19 | 35 | The last ``participant`` keyword indicates that the first level analysis
|
20 | 36 | is run. (i.e. extracting the :abbr:`IQMs (image quality metrics)` from the
|
@@ -80,14 +96,10 @@ Command line interface
|
80 | 96 |
|
81 | 97 | Running mriqc on HPC clusters
|
82 | 98 | -----------------------------
|
83 |
| -Singularity containers |
84 |
| -...................... |
85 |
| -Requesting resources |
86 |
| -.................... |
87 | 99 | We have profiled cores and memory usages with the *resource profiler*
|
88 |
| -tool of nipype. |
| 100 | +tool of *Nipype*. |
89 | 101 |
|
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 |
91 | 103 | run, one BOLD task (resting-state) yielded the following report:
|
92 | 104 |
|
93 | 105 | .. raw:: html
|
@@ -117,5 +129,3 @@ on ds030 of OpenfMRI:
|
117 | 129 | .. [BIDS] `Brain Imaging Data Structure <http://bids.neuroimaging.io/>`_
|
118 | 130 | .. [BIDSApps] `BIDS-Apps: portable neuroimaging pipelines that understand BIDS
|
119 | 131 | datasets <http://bids-apps.neuroimaging.io/>`_
|
120 |
| -
|
121 |
| -.. include:: license.rst |
|
0 commit comments