Skip to content

Commit 9967b48

Browse files
committed
fix: move fmriprep-docker installation to installation page
1 parent a2a30fe commit 9967b48

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

docs/docker.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,8 @@ command line, or you can use a lightweight wrapper we created for convenience.
2323

2424
Running *fMRIPrep* with the ``fmriprep-docker`` wrapper
2525
-------------------------------------------------------
26-
This is the easiest way to run *fMRIPrep*.
27-
The `Docker wrapper`_ script is a command that allows
28-
you to write your command line as if you were running ``fmriprep`` directly,
29-
and converts it into a ``docker`` command.
30-
The wrapper just requires Python and an Internet connection.
31-
Install the wrapper using a Python distribution system, e.g.::
32-
33-
$ pip install --user --upgrade fmriprep-docker
34-
26+
Before starting, make sure you
27+
`have the wrapper installed <installation.html#the-fmriprep-docker-wrapper>`__.
3528
When you run ``fmriprep-docker``, it will generate a Docker command line for you,
3629
print it out for reporting purposes, and then execute it without further action
3730
needed, e.g.::

docs/installation.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ see :ref:`usage` for details.
1616

1717
Container technologies: Docker and Singularity
1818
==============================================
19-
2019
Container technologies are operating-system-level virtualization methods to run Linux systems
2120
using the host's Linux kernel.
2221
This is a lightweight approach to virtualization, as compares to virtual machines.
@@ -26,7 +25,6 @@ This is a lightweight approach to virtualization, as compares to virtual machine
2625

2726
Docker (recommended for PC/laptop and commercial Cloud)
2827
-------------------------------------------------------
29-
3028
Probably, the most popular framework to execute containers is Docker.
3129
If you are to run *fMRIPrep* on your PC/laptop, this is the RECOMMENDED way of execution.
3230
Please make sure you follow the `Docker installation`_ instructions.
@@ -62,6 +60,18 @@ and `check out our documentation <docker.html>`_ to run the *fMRIPrep* image.
6260
The list of Docker images ready to use is found at the `Docker Hub`_,
6361
under the ``poldracklab/fmriprep`` identifier.
6462

63+
The ``fmriprep-docker`` wrapper
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65+
This is the easiest way to `run fMRIPrep using Docker
66+
<docker.html#running-fmriprep-with-the-fmriprep-docker-wrapper>`__.
67+
The `Docker wrapper`_ is a Python script that operates the Docker Engine seamlessly
68+
as if you were running ``fmriprep`` directly.
69+
To that end, ``fmriprep-docker`` reinterprets the command-line you are passing and
70+
converts it into a ``docker run`` command.
71+
The wrapper just requires Python and an Internet connection.
72+
Install the wrapper using a Python distribution system, e.g.::
73+
74+
$ python -m pip install --user --upgrade fmriprep-docker
6575

6676
Singularity (recommended for HPC)
6777
---------------------------------

0 commit comments

Comments
 (0)