@@ -6,7 +6,7 @@ Installation
6
6
7
7
There are four ways to use fmriprep: on the free cloud service OpenNeuro.org,
8
8
in a `Docker Container `_, in a `Singularity Container `_, or in a `Manually
9
- Prepared Environment `_.
9
+ Prepared Environment (Python 3.5+) `_.
10
10
Using OpenNeuro or a local container method is highly recommended.
11
11
Once you are ready to run fmriprep, see Usage _ for details.
12
12
@@ -159,8 +159,8 @@ If the data to be preprocessed is also on the HPC, you are ready to run fmriprep
159
159
--participant-label 387 --nthreads 16 \
160
160
--omp-nthreads 16
161
161
162
- Manually Prepared Environment
163
- =============================
162
+ Manually Prepared Environment (Python 3.5+)
163
+ ===========================================
164
164
165
165
.. warning ::
166
166
@@ -170,15 +170,36 @@ Manually Prepared Environment
170
170
Make sure all of fmriprep's `External Dependencies `_ are installed.
171
171
These tools must be installed and their binaries available in the
172
172
system's ``$PATH ``.
173
- In particular, FreeSurfer requires a license file (see :ref: `fs_license `).
173
+ A relatively interpretable description of how your environment can be set-up
174
+ is found in the `Dockerfile <https://github.com/poldracklab/fmriprep/blob/master/Dockerfile >`_.
175
+ As an additional installation setting, FreeSurfer requires a license file (see :ref: `fs_license `).
174
176
175
- If you have pip installed, install fmriprep ::
177
+ On a functional Python 3.5 (or above) environment with ``pip `` installed,
178
+ fMRIPrep can be installed using the habitual command ::
176
179
177
180
$ pip install fmriprep
178
181
179
- If you have your data on hand, you are ready to run fmriprep: ::
182
+ Check your installation with the `` --version `` argument ::
180
183
181
- $ fmriprep data/dir output/dir participant --participant-label label
184
+ $ fmriprep --version
185
+
186
+
187
+ External Dependencies
188
+ ---------------------
189
+
190
+ FMRIPrep is written using Python 3.5 (or above), and is based on
191
+ nipype _.
192
+
193
+ FMRIPrep requires some other neuroimaging software tools that are
194
+ not handled by the Python's packaging system (Pypi) used to deploy
195
+ the ``fmriprep `` package:
196
+
197
+ - FSL _ (version 5.0.9)
198
+ - ANTs _ (version 2.2.0 - NeuroDocker build)
199
+ - AFNI _ (version Debian-16.2.07)
200
+ - `C3D <https://sourceforge.net/projects/c3d/ >`_ (version 1.0.0)
201
+ - FreeSurfer _ (version 6.0.1)
202
+ - `ICA-AROMA <https://github.com/rhr-pruim/ICA-AROMA/ >`_ (version 0.4.1-beta)
182
203
183
204
184
205
.. _fs_license :
@@ -232,17 +253,3 @@ would be equivalent to the latest example: ::
232
253
-v /path/to_output/dir:/out poldracklab/fmriprep:1.0.0 \
233
254
/data /out participant
234
255
...
235
-
236
-
237
- External Dependencies
238
- =====================
239
-
240
- FMRIPrep is implemented using nipype _, but it requires some other neuroimaging
241
- software tools:
242
-
243
- - FSL _ (version 5.0.9)
244
- - ANTs _ (version 2.2.0 - NeuroDocker build)
245
- - AFNI _ (version Debian-16.2.07)
246
- - `C3D <https://sourceforge.net/projects/c3d/ >`_ (version 1.0.0)
247
- - FreeSurfer _ (version 6.0.1)
248
- - `ICA-AROMA <https://github.com/rhr-pruim/ICA-AROMA/ >`_ (version 0.4.1-beta)
0 commit comments