Skip to content

Commit 3c937b7

Browse files
author
Jakub Kaczmarzyk
committed
docs: merge docker and singularity generators
1 parent f433665 commit 3c937b7

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

doc/users/neurodocker.rst

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Usage
2020

2121
To view the Neurodocker help message
2222
::
23-
docker run --rm kaczmarj/neurodocker:0.4.0 generate --help
23+
docker run --rm kaczmarj/neurodocker:0.4.0 generate [docker|singularity] --help
24+
25+
Note: choose between ``docker`` and ``singularity`` in ``[docker|singularity]``.
2426

2527
1. Users must specify a base Docker image and the package manager. Any Docker
2628
image on DockerHub can be used as your base image. Common base images
@@ -44,20 +46,11 @@ To view the Neurodocker help message
4446
Create a Dockerfile or Singularity recipe with FSL, Python 3.6, and Nipype
4547
--------------------------------------------------------------------------
4648

47-
This command prints a Dockerfile (the specification for a Docker image) to the
49+
This command prints a Dockerfile (the specification for a Docker image) or a
50+
Singularity recipe (the specification for a Singularity container) to the
4851
terminal.
4952
::
50-
$ docker run --rm kaczmarj/neurodocker:0.4.0 generate docker \
51-
--base debian:stretch --pkg-manager apt \
52-
--fsl version=5.0.10 \
53-
--miniconda create_env=neuro \
54-
conda_install="python=3.6 traits" \
55-
pip_install="nipype"
56-
57-
This command prints a Singularity recipe (the specification for a Singularity
58-
container) to the terminal.
59-
::
60-
$ docker run --rm kaczmarj/neurodocker:0.4.0 generate singularity \
53+
$ docker run --rm kaczmarj/neurodocker:0.4.0 generate [docker|singularity] \
6154
--base debian:stretch --pkg-manager apt \
6255
--fsl version=5.0.10 \
6356
--miniconda create_env=neuro \
@@ -92,7 +85,7 @@ The Singularity recipe can be saved and used to build the Singularity container
9285
--miniconda create_env=neuro \
9386
conda_install="python=3.6 traits" \
9487
pip_install="nipype" > Singularity
95-
$ singularity build Singularity my_nipype.sqsh
88+
$ singularity build my_nipype.simg Singularity
9689

9790

9891
Use NeuroDebian
@@ -120,7 +113,7 @@ running the container.
120113
::
121114
$ docker run --rm kaczmarj/neurodocker:0.4.0 generate docker \
122115
--base centos:7 --pkg-manager yum \
123-
--dcm2niix version=master \
116+
--dcm2niix version=master method=source \
124117
--user neuro \
125118
--miniconda create_env=neuro conda_install="jupyter traits nipype" \
126119
> Dockerfile
@@ -129,8 +122,10 @@ running the container.
129122

130123
Copy local files into a container.
131124
::
132-
$ docker run --rm kaczmarj/neurodocker:v0.3.2 generate [docker|singularity] \
125+
$ docker run --rm kaczmarj/neurodocker:0.4.0 generate [docker|singularity] \
133126
--base ubuntu:16.04 --pkg-manager apt \
134127
--copy relative/path/to/source.txt /absolute/path/to/destination.txt
135128

129+
See the `Neurodocker examples page <https://github.com/kaczmarj/neurodocker/tree/master/examples/>`_ for more.
130+
136131
.. include:: ../links_names.txt

0 commit comments

Comments
 (0)