Contributing to FMRIPREP¶
This document explains how to prepare a new development environment and update an existing environment, as necessary.
Development in Docker is encouraged, for the sake of consistency and portability. By default, work should be built off of poldracklab/fmriprep:latest (see the installation guide for the basic procedure for running).
Patching working repositories¶
In order to test new code without rebuilding the Docker image, it is
possible to mount working repositories as source directories within the
In the docker container, the following Python sources are kept in
/root/src ├── fmriprep/ ├── nipype/ └── niworkflows/
To patch in working repositories, for instance contained in
$HOME/projects/, add the following arguments to your docker command:
-v $HOME/projects/fmriprep:/root/src/fmriprep:ro -v $HOME/projects/niworkflows:/root/src/niworkflows:ro -v $HOME/projects/nipype:/root/src/nipype:ro
$ docker run --rm -v $HOME/fullds005:/data:ro -v $HOME/dockerout:/out \ -v $HOME/projects/fmriprep:/root/src/fmriprep:ro \ poldracklab/fmriprep:latest /data /out/out participant \ -w /out/work/ -t ds005
In order to work directly in the container, use
omit the fmriprep arguments:
$ docker run --rm -v $HOME/fullds005:/data:ro -v $HOME/dockerout:/out \ -v $HOME/projects/fmriprep:/root/src/fmriprep:ro --entrypoint=bash \ poldracklab/fmriprep:latest
Preparing repository for patching¶
In order to patch a working repository into the docker image, its egg-info
must be built.
The first time this is done, the repository should be mounted read/write,
and be installed in editable mode.
For instance, to prepare to patch in fmriprep, niworkflows and nipype,
all located under
$ docker run --rm -it --entrypoint=bash \ -v $HOME/projects/fmriprep:/root/src/fmriprep \ -v $HOME/projects/niworkflows:/root/src/niworkflows \ -v $HOME/projects/nipype:/root/src/nipype \ poldracklab/fmriprep:latest root@03e5df018c5e:~# cd ~/src/fmriprep/ root@03e5df018c5e:~/src/fmriprep# pip install -e . root@03e5df018c5e:~# cd ~/src/niworkflows/ root@03e5df018c5e:~/src/niworkflows# pip install -e . root@03e5df018c5e:~# cd ~/src/nipype/ root@03e5df018c5e:~/src/nipype# pip install -e .
New dependencies to be inserted into the Docker image will either be Python or non-Python dependencies. Python dependencies may be added in three places, depending on whether the package is large or non-release versions are required. The image must be rebuilt after any dependency changes.
Finally, if a specific version of a repository needs to be pinned, edit
See the current
file for examples.
Non-Python dependencies must also be installed in the Dockerfile, via a
For example, installing an
apt package may be done as follows:
RUN apt-get update && \ apt-get install -y <PACKAGE>
Rebuilding Docker image¶
If it is necessary to rebuild the Docker image, a local image named
fmriprep may be built from within the working fmriprep
repository, located in
~/projects/fmriprep$ docker build -t fmriprep .
To work in this image, replace
fmriprep in any of the above commands.