Skip to main content

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

mrsiprep_docker-1.0.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mrsiprep_docker-1.0.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file mrsiprep_docker-1.0.0.tar.gz.

File metadata

  • Download URL: mrsiprep_docker-1.0.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for mrsiprep_docker-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ea7c2063af08fe103c283d60c773518f35921e64224aa796f278aa00dc8a532d
MD5 3f2810f20446489bcb95d314713c5d9b
BLAKE2b-256 b4c5b6facc4d3bf77682a37b2506db530a940553d5096908810f85ab79bd6294

See more details on using hashes here.

File details

Details for the file mrsiprep_docker-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mrsiprep_docker-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48a121ff57968c0d2abc08efb447c200ec0ff5c8defc795ad0653f0670c2cc66
MD5 7220e1b73b2ade4afafb51ee4ed1febd
BLAKE2b-256 e099e8e4de761f591473d80dbe831f339cc07416144db5cb96cf4976d3e59c9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page