The MRSIPrep on Docker wrapper
MRSIPrep is distributed as a Docker image; there is no supported host
installation of the pipeline itself. This is a lightweight, dependency-free
Python wrapper (mirroring the fmriprep-docker wrapper) that builds and runs
the appropriate docker run command using the normal MRSIPrep BIDS App
syntax. Docker must be installed and running (check with docker info).
Install
pip install mrsiprep-docker
Use
mrsiprep-docker /path/to/bids /path/to/derivatives participant \
--participant-label S001 --session-label V1 \
--mode mni-norm --nthreads 8 \
--fs-license-file /path/to/freesurfer/license.txt
This generates and runs the equivalent of:
docker run --rm -it -u "$(id -u):$(id -g)" \
-e TZ="$(cat /etc/timezone)" \
-v /path/to/freesurfer/license.txt:/opt/freesurfer/license.txt:ro \
-e FS_LICENSE=/opt/freesurfer/license.txt \
-v /path/to/bids:/data:ro \
-v /path/to/derivatives:/out \
mrsiup/mrsiprep:cpu \
/data /out participant \
--participant-label S001 --session-label V1 \
--mode mni-norm --nthreads 8
All ordinary mrsiprep arguments (--mode, --participant-label,
--tissue-backend, --parcellation-mode, --nproc, --verbose, ...) are
passed straight through to the container unchanged. The wrapper only
special-cases the few options that need a bind mount or an environment
variable: --fs-license-file, --fs-subjects-dir, --work-dir, and
--participants.
-u "$(id -u):$(id -g)" (the default; override with -u/--user) plus the
container's own permission-fixing entrypoint means output files are owned by
the invoking user, not root. -e TZ=... (skip with --no-tz) keeps console
and logbook timestamps in sync with the host clock.
See the main repository's documentation for the full MRSIPrep CLI reference: https://mrsiprep.readthedocs.io/
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mrsiprep_docker-1.0.1.tar.gz.
File metadata
- Download URL: mrsiprep_docker-1.0.1.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73f70333485690e06fe47c773903251b353db350803d89543f742a7f9f8a3183
|
|
| MD5 |
d4e919124864d0157c328d513562fbe3
|
|
| BLAKE2b-256 |
b757f93c0c20342ce019057caf3df6bc09c60de104e6386153314e509f5a2b40
|
File details
Details for the file mrsiprep_docker-1.0.1-py3-none-any.whl.
File metadata
- Download URL: mrsiprep_docker-1.0.1-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39cb2a03108ea982c8199a2c2786a21e6e56d90863eeeb6ff2919352b0cb2a05
|
|
| MD5 |
9adf7a92ea428ca848c4d114d8a174e1
|
|
| BLAKE2b-256 |
94c057bf2d3752b8dff7f1419cc80373d38eb381f22caa4a67e8e083b6795812
|