Skip to content

Commit 3c9b253

Browse files
enh: Docker italicalization & link to installation docs
Related-To: https://github.com/nipreps/nipreps.github.io/pull/47/files#r1904836364 Co-Authored-By: McKenzie P. Hagen <[email protected]>
1 parent 3f79fc2 commit 3c9b253

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

docs/apps/docker.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@
55

66
## Before you start: install Docker
77

8-
Probably, the most popular framework to execute containers is Docker.
8+
Probably, the most popular framework to execute containers is *Docker*.
99
If you are to run a *NiPrep* on your PC/laptop, this is the **RECOMMENDED** way of execution.
10-
Please make sure you follow the Docker installation instructions.
11-
You can check your Docker Runtime installation running their `hello-world` image:
10+
Please make sure you follow the
11+
[*Docker Engine*'s installation instructions](https://docs.docker.com/engine/install/).
12+
You can check your installation running their `hello-world` image:
1213

1314
```Shell
1415
$ docker run --rm hello-world
@@ -39,7 +40,8 @@ For more examples and ideas, visit:
3940
https://docs.docker.com/get-started/
4041
```
4142

42-
After checking your Docker Engine is capable of running Docker images, you are ready to pull your first *NiPreps* container image.
43+
After checking your *Docker Engine* is capable of running *Docker*
44+
images, you are ready to pull your first *NiPreps* container image.
4345

4446
!!! tip "Troubleshooting"
4547

@@ -50,10 +52,10 @@ After checking your Docker Engine is capable of running Docker images, you are r
5052
Once verified the problem is not related to the container system,
5153
then follow the specific application debugging guidelines.
5254

53-
## Docker images
55+
## *Docker* images
5456

55-
For every new version of the particular *NiPrep* app that is released, a corresponding Docker image is generated.
56-
The Docker image *becomes* a container when the execution engine loads the image and adds an extra layer that makes it *runnable*. In order to run *NiPreps* Docker images, the Docker Runtime must be installed.
57+
For every new version of the particular *NiPreps* application that is released, a corresponding *Docker* image is generated.
58+
The Docker image *becomes* a container when the execution engine loads the image and adds an extra layer that makes it *runnable*. In order to run *NiPreps*' *Docker* images, the *Docker Engine* must be installed.
5759
<!-- (see `installation_docker`{.interpreted-text
5860
role="ref"}).-->
5961

@@ -63,7 +65,7 @@ Taking *fMRIPrep* to illustrate the usage, first you might want to make sure of
6365
$ docker pull nipreps/fmriprep:<latest-version>
6466
```
6567

66-
You can run *NiPreps* interacting directly with the Docker Engine via the `docker run` interface.
68+
You can run *NiPreps* interacting directly with the *Docker Engine* via the `docker run` interface.
6769

6870

6971
## Running a *NiPrep* with a lightweight wrapper
@@ -81,21 +83,21 @@ RUNNING: docker run --rm -it -v /path/to/data/dir:/data:ro \
8183
...
8284
```
8385

84-
`fmriprep-docker` implements [the unified command-line interface of BIDS Apps](framework.md#a-unified-command-line-interface), and automatically translates directories into Docker mount points for you.
86+
`fmriprep-docker` implements [the unified command-line interface of *BIDS Apps*](framework.md#a-unified-command-line-interface), and automatically translates directories into *Docker* mount points for you.
8587

8688
We have published a [step-by-step tutorial](http://reproducibility.stanford.edu/fmriprep-tutorial-running-the-docker-image/) illustrating how to run `fmriprep-docker`.
8789
This tutorial also provides valuable troubleshooting insights and advice on what to do after
8890
*fMRIPrep* has run.
8991

90-
## Running a *NiPrep* directly interacting with the Docker Engine
92+
## Running a *NiPrep* directly interacting with the *Docker Engine*
9193

92-
If you need a finer control over the container execution, or you feel comfortable with the Docker Engine, avoiding the extra software layer of the wrapper might be a good decision.
94+
If you need a finer control over the container execution, or you feel comfortable with the *Docker Engine*, avoiding the extra software layer of the wrapper might be a good decision.
9395

9496
### Accessing filesystems in the host within the container
9597

9698
Containers are confined in a sandbox, so they can't access the data on the host
9799
unless explicitly enabled.
98-
The Docker Engine provides mounting filesystems into the container with the `-v` argument and the following syntax:
100+
The *Docker Engine* provides mounting filesystems into the container with the `-v` argument and the following syntax:
99101
`-v some/path/in/host:/absolute/path/within/container:ro`,
100102
where the trailing `:ro` specifies that the mount is read-only.
101103
The mount permissions modifiers can be omitted, which means the mount
@@ -218,7 +220,7 @@ $ docker run -ti --rm \
218220

219221
### Running containers as a user
220222

221-
By default, Docker will run the container with the
223+
By default, *Docker* will run the container with the
222224
user id (uid) **0**, which is reserved for the default **root**
223225
account in *Linux*.
224226
In other words, by default *Docker* will use the superuser account
@@ -278,7 +280,7 @@ $ docker run -ti --rm \
278280

279281
### Application-specific options
280282

281-
Once the Docker Engine arguments are written, the remainder of the
283+
Once the *Docker Engine* arguments are written, the remainder of the
282284
command line follows the interface defined by the specific
283285
*BIDS App* (for instance,
284286
[*fMRIPrep*](https://fmriprep.readthedocs.io/en/latest/usage.html)
@@ -347,7 +349,7 @@ to limit resources such as memory, memory policies, number of CPUs, etc.
347349

348350
**Memory will be a common culprit** when working with large datasets
349351
(+10GB).
350-
However, *Docker* engine is limited to 2GB of RAM by default
352+
However, the *Docker Engine* is limited to 2GB of RAM by default
351353
for some installations of *Docker* for *MacOSX* and *Windows*.
352354
The general resource settings can be also modified through the *Docker Desktop*
353355
graphical user interface.

0 commit comments

Comments
 (0)