Skip to content

Commit cd7ec89

Browse files
authored
Merge pull request #1249 from poldracklab/docs/python-version
[DOC] Clearly indicate that fMRIPrep requires Python 3.5+
2 parents 0d3e4dc + 9e5b72d commit cd7ec89

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

docs/installation.rst

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Installation
66

77
There are four ways to use fmriprep: on the free cloud service OpenNeuro.org,
88
in a `Docker Container`_, in a `Singularity Container`_, or in a `Manually
9-
Prepared Environment`_.
9+
Prepared Environment (Python 3.5+)`_.
1010
Using OpenNeuro or a local container method is highly recommended.
1111
Once you are ready to run fmriprep, see Usage_ for details.
1212

@@ -159,8 +159,8 @@ If the data to be preprocessed is also on the HPC, you are ready to run fmriprep
159159
--participant-label 387 --nthreads 16 \
160160
--omp-nthreads 16
161161

162-
Manually Prepared Environment
163-
=============================
162+
Manually Prepared Environment (Python 3.5+)
163+
===========================================
164164

165165
.. warning::
166166

@@ -170,15 +170,36 @@ Manually Prepared Environment
170170
Make sure all of fmriprep's `External Dependencies`_ are installed.
171171
These tools must be installed and their binaries available in the
172172
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`).
174176

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 ::
176179

177180
$ pip install fmriprep
178181

179-
If you have your data on hand, you are ready to run fmriprep: ::
182+
Check your installation with the ``--version`` argument ::
180183

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)
182203

183204

184205
.. _fs_license:
@@ -232,17 +253,3 @@ would be equivalent to the latest example: ::
232253
-v /path/to_output/dir:/out poldracklab/fmriprep:1.0.0 \
233254
/data /out participant
234255
...
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

Comments
 (0)