Giter Club home page Giter Club logo

matteomancini / trampolino Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 2.0 113 KB

TRAMPOLINO (TRActography Meta-Pipeline cOmmand LINe tOol) is a CLI for brain tractography. It leverages Nipype to offer an immediate way to reconstruct an orientation distribution function, use it to track the streamlines and eventually filter them, all using existing software toolboxes.

Home Page: https://trampolino.readthedocs.io

License: MIT License

Makefile 1.48% Python 97.64% Dockerfile 0.88%
brainweb tractography

trampolino's Introduction

TRAMPOLINO

image Documentation Status

TRAMPOLINO (TRActography Meta-Pipeline cOmmand LINe tOol) is a command line interface tool for brain tractography, written in Python. It leverages the Nipype Python package to offer an immediate way to reconstruct an orientation distribution function, use it to track the streamlines and eventually filter them, all using existing software toolboxes.

At the moment it is under active development but supports already several software packages and the plan is to include as many software alternatives as possible.

Features

  • Composable command line interfaces built using the Click Python package;
  • One-command generation of multiple results using different parameters (e.g. angular thresholds, tracking algorithm);
  • Ensemble tractography implementation;
  • Short-cut workflows to rapidly generate results from sample data;
  • Native support to containers (through the Docker API);

Requirements

TRAMPOLINO requires Python 3 and the GraphViz visualization software. The Python packages required are listed in the [requirements.txt]{.title-ref} file.

At the moment, TRAMPOLINO can be used to run the following tools:

The current container image supports MRtrix3 (3.0.0) and Trekker (0.7). To run those workflows directly in a container, you need to install the Docker API:

pip install docker

Installing TRAMPOLINO

TRAMPOLINO can be easily installed using pip:

pip install trampolino

Running TRAMPOLINO

To try TRAMPOLINO, you can download some example data using this script:

get_example_data

It will download the Sherbrooke multi-shell dataset from dipy. Then you can run:

trampolino -n msmt_csd -r example_results recon -i sherbrooke_3shell/dwi.nii.gz -v sherbrooke_3shell/bvec.txt -b sherbrooke_3shell/bval.txt mrtrix_msmt_csd track --angle 30,45 --algorithm iFOD2,SD_Stream mrtrix_tckgen

And you have your first results!

Contributors

Matteo Mancini

Bastian David - https://github.com/bastiandavid

Want to contribute? Have suggestions/crazy ideas/evil plans? Get in touch!

Credits

TRAMPOLINO is built on top of the amazing Nipype toolkit. At the moment, some of the interfaces already available in Nipype are included in order to fix and/or add features for the sake of compatibility with modern tools. This is only temporary, and once those features are merge in Nipype, TRAMPOLINO will use directly the native interfaces. Other important tools for TRAMPOLINO are nibabel and dipy, currently used respectively for conversion and fetching data. Be sure to check them out!

TRAMPOLINO has started its life during Brainhack School (Montreal, August 2019) and has been first extended during the OHBM Brainhack in 2020 (virtual event). Therefore, TRAMPOLINO would not exist if it wasn't for Brainhack!

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

trampolino's People

Contributors

bastiandavid avatar dependabot[bot] avatar matteomancini avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

trampolino's Issues

[ENH] Adding --force functionality and refactored data grabber

I have added a --force functionality to Trampolino. Adding the --force flag to the trampolino command now enables the user to specify only one of the three processing steps (reconstruction, tracking or filtering of streamlines), even without supplying their own data (see screenshot below). Trampolino will in turn download an example dataset and execute all preceeding processing steps using the same analysis interface as specified in the user input.

For future specification of different example datasets, I have furthermore refactored the data grabber to now accept a data source and output directory argument.

I described the new functionality in the docs.

trampolinio_force_example

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.