@@ -26,20 +26,33 @@ In order to run fmriprep in a Docker container, Docker must be `installed
26
26
<https://docs.docker.com/engine/installation/> `_.
27
27
Once Docker is installed, the recommended way to run fmriprep is to use the
28
28
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.
29
32
30
33
To install::
31
34
32
35
$ pip install --user --upgrade fmriprep-docker
33
36
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.::
36
40
37
41
$ fmriprep-docker /path/to/data/dir /path/to/output/dir participant
38
42
RUNNING: docker run --rm -it -v /path/to/data/dir:/data:ro \
39
43
-v /path/to_output/dir:/out poldracklab/fmriprep:1.0.0 \
40
44
/data /out participant
41
45
...
42
46
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
+
43
56
You may also invoke ``docker `` directly::
44
57
45
58
$ docker run -ti --rm \
@@ -76,7 +89,7 @@ image directly on the HCP.
76
89
This is as simple as: ::
77
90
78
91
$ singularity build /my_images/fmriprep-<version>.simg docker://poldracklab/fmriprep:<version>
79
-
92
+
80
93
Where ``<version> `` should be replaced with the desired version of fMRIPrep that you want to download.
81
94
82
95
0 commit comments