Skip to content

Commit f08fde1

Browse files
edits to fmriprep-docker
1 parent 3b46aae commit f08fde1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/installation.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ In order to run fmriprep in a Docker container, Docker must be `installed
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.
2929
``fmriprep-docker`` is a streamlined command to run fmriprep without having to
30-
properly mount directories (``fmriprep-docker`` does this for you)
30+
properly mount directories (``fmriprep-docker`` does this for you).
3131

3232
To install::
3333

3434
$ pip install --user --upgrade fmriprep-docker
3535

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

4040
$ fmriprep-docker /path/to/data/dir /path/to/output/dir participant
@@ -43,14 +43,16 @@ needed, e.g.::
4343
/data /out participant
4444
...
4545

46-
For ``fmriprep-docker`` all the options you would typically pass to fmriprep,
47-
you can use for ``fmriprep-docker``. ``fmriprep-docker`` is mostly mounting
48-
the paths and environmental variables.
46+
For ``fmriprep-docker`` all the arguments you would typically pass to fmriprep,
47+
you can use for ``fmriprep-docker`` (i.e. ignoring slice time corrections).
48+
Additionally, ``fmriprep-docker`` handles mounting the paths and environmental
49+
variables automatically.
4950

5051
We have published a `step-by-step tutorial
5152
<http://reproducibility.stanford.edu/fmriprep-tutorial-running-the-docker-image/>`_
52-
illustrating how to run ``fmriprep-docker``. This tutorial also provides valuable
53-
troubleshooting insights and advice on what to do after fmriprep has run.
53+
illustrating how to run ``fmriprep-docker``.
54+
This tutorial also provides valuable troubleshooting insights and advice on
55+
what to do after fmriprep has run.
5456

5557

5658
You may also invoke ``docker`` directly::

0 commit comments

Comments
 (0)