Skip to content

Commit b32bd9e

Browse files
authored
Merge pull request #1515 from franklin-feingold/master
[DOC] fmriprep-docker documentation
2 parents 99afda1 + 2afad64 commit b32bd9e

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/installation.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,33 @@ In order to run fmriprep in a Docker container, Docker must be `installed
2626
<https://docs.docker.com/engine/installation/>`_.
2727
Once Docker is installed, the recommended way to run fmriprep is to use the
2828
fmriprep-docker_ wrapper, which requires Python and an Internet connection.
29+
``fmriprep-docker`` is a command that allows you to write your command line
30+
as if you were running ``fmriprep`` directly, and converts it into a ``docker``
31+
command.
2932

3033
To install::
3134

3235
$ pip install --user --upgrade fmriprep-docker
3336

34-
When run, ``fmriprep-docker`` will generate a Docker command line for you,
35-
print it out for reporting purposes, and then run the command, e.g.::
37+
When you run ``fmriprep-docker``, it will generate a Docker command line for you,
38+
print it out for reporting purposes, and then execute it without further action
39+
needed, e.g.::
3640

3741
$ fmriprep-docker /path/to/data/dir /path/to/output/dir participant
3842
RUNNING: docker run --rm -it -v /path/to/data/dir:/data:ro \
3943
-v /path/to_output/dir:/out poldracklab/fmriprep:1.0.0 \
4044
/data /out participant
4145
...
4246

47+
``fmriprep-docker`` accepts all of the typical options for ``fmriprep``,
48+
automatically translating directories into Docker mount points.
49+
50+
We have published a `step-by-step tutorial
51+
<http://reproducibility.stanford.edu/fmriprep-tutorial-running-the-docker-image/>`_
52+
illustrating how to run ``fmriprep-docker``.
53+
This tutorial also provides valuable troubleshooting insights and advice on
54+
what to do after fmriprep has run.
55+
4356
You may also invoke ``docker`` directly::
4457

4558
$ docker run -ti --rm \
@@ -76,7 +89,7 @@ image directly on the HCP.
7689
This is as simple as: ::
7790

7891
$ singularity build /my_images/fmriprep-<version>.simg docker://poldracklab/fmriprep:<version>
79-
92+
8093
Where ``<version>`` should be replaced with the desired version of fMRIPrep that you want to download.
8194

8295

0 commit comments

Comments
 (0)