Skip to content

Commit ed9e15b

Browse files
committed
Add Singularity instructions to the FAQs.
1 parent 3adcb26 commit ed9e15b

File tree

3 files changed

+31
-3
lines changed

3 files changed

+31
-3
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ We recommend installing Mindboggle and its dependencies as a cross-platform
7171
Docker container for greater convenience and reproducibility of results.
7272
All the examples below assume you are using this Docker container,
7373
with the path /home/jovyan/work/ pointing to your host machine.
74-
(Alternatively, Mindboggle can be installed from scratch on a Linux machine
75-
using
74+
(Alternatively, one can `create a Singularity image <faq>`_,
75+
or Mindboggle can be installed from scratch on a Linux machine using
7676
`this script <https://raw.githubusercontent.com/nipy/mindboggle/master/install_mindboggle.sh>`_).
7777

7878
1. `Install and run Docker <https://docs.docker.com/engine/installation/>`_
@@ -87,7 +87,7 @@ terminal window)::
8787
over 6GB.*
8888

8989
*Note 2: You may need to increase memory allocated by Docker to at least 5GB.
90-
For example: `By default, Docker for Mac is set to use 2 GB runtime memory <https://docs.docker.com/docker-for-mac/>`_.*
90+
For example:* `By default, Docker for Mac is set to use 2 GB runtime memory <https://docs.docker.com/docker-for-mac/>`_.
9191

9292
3. Optionally download sample data. To try out the ``mindboggle`` examples
9393
below, download and unzip the directory of example input data

docs/faq.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@
1111
faq/citing_mindboggle
1212
faq/run_time
1313
labels
14+
faq/singularity

docs/faq/singularity.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _singularity:
2+
3+
------------------------------------------------------------------------------
4+
How do I create and use a Singularity image rather than Docker?
5+
------------------------------------------------------------------------------
6+
7+
To convert the Mindboggle Docker image to a Singularity image, run::
8+
9+
singularity pull mindboggle.img docker://nipy/mindboggle
10+
11+
After the conversion, you'll need 3 mounts (data, working directory, and
12+
home directory) for it to work. Here is an example of the full command
13+
together with some of the optional arguments, using the same
14+
environment variables as in the `README <http://mindboggle.info/software.html>`_::
15+
16+
singularity run \
17+
-B $HOST:$DOCK:ro \
18+
-B $PWD:$DOCK \
19+
-B $PWD/jovyan:/home/jovyan \
20+
-e mindboggle.img \
21+
$DOCK/example_mri_data/T1.nii.gz \
22+
--id arno \
23+
--fs_T2image $DOCK/example_mri_data/T2.nii.gz \
24+
--plugin MultiProc --plugin_args "dict(n_procs=2)" \
25+
--fs_openmp 5 --ants_num_threads 5 --mb_num_threads 10
26+
27+
Thanks, Satra!

0 commit comments

Comments
 (0)