Skip to content

Commit 2c49300

Browse files
committed
Merge remote-tracking branch 'upstream/master' into maint/run-docker-as-user
2 parents 6c5b425 + 84344a8 commit 2c49300

File tree

5 files changed

+23
-8
lines changed

5 files changed

+23
-8
lines changed

docs/environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ dependencies:
2828
- svgutils
2929
- nitime
3030
- nilearn
31-
- niworkflows>=0.5.4,<0.6
31+
- niworkflows>=0.7.2,<0.8.0a0
3232
- smriprep>=0.0.4,<0.1.0a0
3333
- tedana>=0.0.5

docs/installation.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,33 @@ In order to run fmriprep in a Docker container, Docker must be `installed
2626
<https://docs.docker.com/engine/installation/>`_.
2727
Once Docker is installed, the recommended way to run fmriprep is to use the
2828
fmriprep-docker_ wrapper, which requires Python and an Internet connection.
29+
``fmriprep-docker`` is a command that allows you to write your command line
30+
as if you were running ``fmriprep`` directly, and converts it into a ``docker``
31+
command.
2932

3033
To install::
3134

3235
$ pip install --user --upgrade fmriprep-docker
3336

34-
When run, ``fmriprep-docker`` will generate a Docker command line for you,
35-
print it out for reporting purposes, and then run the command, e.g.::
37+
When you run ``fmriprep-docker``, it will generate a Docker command line for you,
38+
print it out for reporting purposes, and then execute it without further action
39+
needed, e.g.::
3640

3741
$ fmriprep-docker /path/to/data/dir /path/to/output/dir participant
3842
RUNNING: docker run --rm -it -v /path/to/data/dir:/data:ro \
3943
-v /path/to_output/dir:/out poldracklab/fmriprep:1.0.0 \
4044
/data /out participant
4145
...
4246

47+
``fmriprep-docker`` accepts all of the typical options for ``fmriprep``,
48+
automatically translating directories into Docker mount points.
49+
50+
We have published a `step-by-step tutorial
51+
<http://reproducibility.stanford.edu/fmriprep-tutorial-running-the-docker-image/>`_
52+
illustrating how to run ``fmriprep-docker``.
53+
This tutorial also provides valuable troubleshooting insights and advice on
54+
what to do after fmriprep has run.
55+
4356
You may also invoke ``docker`` directly::
4457

4558
$ docker run -ti --rm \
@@ -76,7 +89,7 @@ image directly on the HCP.
7689
This is as simple as: ::
7790

7891
$ singularity build /my_images/fmriprep-<version>.simg docker://poldracklab/fmriprep:<version>
79-
92+
8093
Where ``<version>`` should be replaced with the desired version of fMRIPrep that you want to download.
8194

8295

fmriprep/__about__.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
'nilearn',
9090
'nipype>=1.1.6',
9191
'nitime',
92-
'niworkflows',
92+
'niworkflows>=0.7.2,<0.8.0a0',
9393
'numpy',
9494
'pandas',
9595
'psutil>=5.4',
@@ -104,8 +104,6 @@
104104

105105

106106
LINKS_REQUIRES = [
107-
'git+https://github.com/poldracklab/niworkflows.git@'
108-
'b97787ee2f1b93cafb104664b60fa0c4fd81253a#egg=niworkflows-0.7.1',
109107
]
110108

111109
TESTS_REQUIRES = [

fmriprep/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@
2828

2929
# cmp is not used by fmriprep, so ignore nipype-generated warnings
3030
warnings.filterwarnings('ignore', r'cmp not installed')
31+
warnings.filterwarnings('ignore', r'This has not been fully tested. Please report any failures.')
32+
warnings.filterwarnings('ignore', r"can't resolve package from __spec__ or __package__")
33+
warnings.simplefilter('ignore', DeprecationWarning)
34+
warnings.simplefilter('ignore', ResourceWarning)

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
pybids>=0.7.0,<0.8.0a0
2-
git+https://github.com/poldracklab/niworkflows.git@b97787ee2f1b93cafb104664b60fa0c4fd81253a#egg=niworkflows-0.7.1
2+
niworkflows>=0.7.2,<0.8.0a0
33
smriprep>=0.0.5,<0.1.0a0
44
templateflow>=0.0.4

0 commit comments

Comments
 (0)