Pre/Post-processing pipeline for tractography wrapped around nipype and mrtrix3
Project description
Pipetography
Nipype and mrtrix3 based pre-/post- processing pipeline for brain diffusion-MRI and generation of structural connectomes of the brain.
This repo currently only has pre-processing capabilities! More will be added in the near future.
The pre-processing workflow has been updated to reflect what's seen in the optimal DESIGNER pipeline and on mrtrix3 cloud apps on brainlife.io.
Install
Since most usages will be on HPC resources, I highly recommend that you use the Singularity
or Docker
recipe in the repository instead of installing the Python module.
Singularity:
-
Currently has pathing issues as seen in the singularity issues page: https://github.com/hpcng/singularity/issues/5040, the 3.6 release candidate should fix this... For now, use docker image if you can. If not, the singularity container will not be able to execute freesurfer
recon-all
step of the workflow. All DWI preprocessing steps will work though. -
Obtain the singularity image with
singularity pull docker://axiezai/pipetography:0.2.8
orsingularity build --remote pipetography.sif docker://axiezai/pipetography:0.2.8
. The second option allows you to build remotely via Syslabs Cloud, this will require a remote log tokeen in which you can obtain after registering at https://cloud.sylabs.io/builder.
Docker:
-
Pull the docker image:
docker pull axiezai/pipetography:0.2.8
-
Run with BIDS directory and interactive bash terminal:
docker run -v <BIDS_DIR>:<Docker_BIDS_DIR> -it axiezai/pipetography:0.2.8 bash
Known container issues:
-
Singularity image missing freesurfer path to
nu_correct
as part of$PATH
. -
If
singularity build
fails withapt-get install
error complaining about unauthenticated packages, add--allow-unauthenticated
to everyapt-get
line in thesinngularity.def
file. -
Freesurfer6.0.0-min
recon-all
is missing commands if-parallel
or-openmp
are set toTrue
. The default-parallel
setting has been set to False forpipetography.pipeline
.
Creating your own environment and install pipetography
as a Python module:
pip install pipetography
Since pipetography
is a Nipype
wrapper around mrtrix3
, ANTs
, and FSL
, you have to follow their installation instructions and set them up appropriately on your machine as well:
The pipeline:
Currently supports -rpe_none
and -rpe_all
options.
Project details
Release history Release notifications | RSS feed
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
Hashes for pipetography-0.2.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8a5636096c01611a28d034d0e8b01b6799b90371c39565bdef60518c03d9d72 |
|
MD5 | 1bec23ff40a0276310c1ec63dcc01d60 |
|
BLAKE2b-256 | da6ed43674481239098200cbb28fa97cdf61a2e14df0183ff9ee079e9ee639de |