Skip to content

Commit 00ef72b

Browse files
committed
update docs again
1 parent 61c2cf8 commit 00ef72b

File tree

2 files changed

+40
-29
lines changed

2 files changed

+40
-29
lines changed

docs/installation.rst

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,44 @@
44
Installation
55
============
66

7+
Docker Container
8+
================
79

8-
Stable release
9-
--------------
10+
.. code-block:: console
11+
12+
$ git clone https://github.com/josephmje/dmriprep
13+
$ cd dmriprep
14+
$ make docker
15+
16+
If you don't want to log into the docker image:
17+
18+
.. code-block:: console
19+
20+
$ docker run -ti -v $BIDS_INPUT_DIR:/inputs -v $OUTPUT_DIR:/outputs dmriprep:prod dmriprep /inputs /outputs
21+
22+
If you want to log into the image:
23+
24+
.. code-block:: console
25+
26+
$ docker run -ti -v $BIDS_INPUT_DIR:/inputs -v $OUTPUT_DIR:/outputs dmriprep:prod
27+
28+
Run this inside the docker image:
29+
30+
.. code-block:: console
31+
32+
$ dmriprep /inputs /output --participant-label 01
33+
34+
Singularity Container
35+
=====================
36+
37+
Preparing a Singularity image (Singularity version < 2.5)
38+
---------------------------------------------------------
39+
40+
Running a Singularity Image
41+
---------------------------
42+
43+
Manually Prepared Environment (Python 3.5+)
44+
===========================================
1045

1146
To install dmriprep, run this command in your terminal:
1247

@@ -50,29 +85,5 @@ Once you have a copy of the source, you can install it with:
5085
.. _Github repo: https://github.com/josephmje/dmriprep
5186
.. _tarball: https://github.com/josephmje/dmriprep/tarball/master
5287

53-
Docker container
54-
----------------
55-
56-
.. code-block:: console
57-
58-
$ git clone https://github.com/josephmje/dmriprep
59-
$ cd dmriprep
60-
$ make docker
61-
62-
If you don't want to log into the docker image:
63-
64-
.. code-block:: console
65-
66-
$ docker run -ti -v $BIDS_INPUT_DIR:/inputs -v $OUTPUT_DIR:/outputs dmriprep:prod dmriprep /inputs /outputs
67-
68-
If you want to log into the image:
69-
70-
.. code-block:: console
71-
72-
$ docker run -ti -v $BIDS_INPUT_DIR:/inputs -v $OUTPUT_DIR:/outputs dmriprep:prod
73-
74-
Run this inside the docker image:
75-
76-
.. code-block:: console
77-
78-
$ dmriprep /inputs /output --participant-label 01
88+
External Dependencies
89+
---------------------

docs/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The common parts of the command follow the `BIDS-Apps
3838

3939
Example: ::
4040

41-
dmriprep data/bids_root/ out/ participant -w work/
41+
dmriprep data/bids out/ participant -w work/
4242

4343

4444
Command-Line Arguments

0 commit comments

Comments
 (0)