|
4 | 4 | Installation
|
5 | 5 | ------------
|
6 | 6 |
|
7 |
| -There are two ways to use *fMRIPrep*: |
| 7 | +There are two ways to get *fMRIPrep* installed: |
8 | 8 |
|
9 |
| -* within a `Manually Prepared Environment (Python 3.5+)`_; or |
| 9 | +* within a `Manually Prepared Environment (Python 3.5+)`_, also known as |
| 10 | + *bare-metal installation*; or |
10 | 11 | * using container technologies (RECOMMENDED), such as :ref:`run_docker`
|
11 | 12 | or :ref:`run_singularity`.
|
12 | 13 |
|
13 |
| -Once you are ready to run *fMRIPrep* via either of the options above, |
14 |
| -see :ref:`usage` for details. |
15 |
| - |
| 14 | +Once you have your *bare-metal* environment set-up (first option above), |
| 15 | +the next step is executing the ``fmriprep`` command-line. |
| 16 | +The ``fmriprep`` command-line options are documented in the :ref:`usage` |
| 17 | +section. |
| 18 | +The ``fmriprep`` command-line adheres to the `BIDS-Apps recommendations |
| 19 | +for the user interface <usage.html#execution-and-the-bids-format>`__. |
| 20 | +Therefore, the command-line has the following structure: |
| 21 | +:: |
| 22 | + |
| 23 | + $ fmriprep <input_bids_path> <derivatives_path> <analysis_level> <named_options> |
| 24 | + |
| 25 | +On the other hand, if you chose a container infrastructure, then |
| 26 | +the command-line will be composed of a preamble to configure the |
| 27 | +container execution followed by the ``fmriprep`` command-line options |
| 28 | +as if you were running it on a *bare-metal* installation. |
| 29 | +The command-line structure above is then modified as follows: |
| 30 | +:: |
| 31 | + |
| 32 | + $ <container_command_and_options> <container_image> \ |
| 33 | + <input_bids_path> <derivatives_path> <analysis_level> <fmriprep_named_options> |
| 34 | + |
| 35 | +Therefore, once specified the container options and the image to be run |
| 36 | +the command line is the same as for the *bare-metal* installation but dropping |
| 37 | +the ``fmriprep`` executable name. |
16 | 38 |
|
17 | 39 | Container technologies: Docker and Singularity
|
18 | 40 | ==============================================
|
|
0 commit comments