/shimming-toolbox

Staging area for my contributions to ST

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

shimming-toolbox

Build Status Coverage Status Documentation Status Twitter Follow

Code for performing real-time shimming using external MRI shim coils

Installation

The first dependency you need is dcm2niix >= v1.0.20200331. You can download precompiled binaries from https://github.com/rordenlab/dcm2niix/releases/latest -- make sure to add them to your PATH. It is also in the AUR (pikaur -Sy dcm2niix), brew (brew install dcm2niix), and conda (conda install -c conda-forge/label/cf202003 dcm2niix). Unfortunately, the version currently in Debian/Ubuntu (apt install dcm2niix) is too old to work reliably.

You will also need to install FSL using Python 2.

Once you have dcm2niix and FSL, install this package and the rest of its dependencies with:

$ pip install shimmingtoolbox@git+https://github.com/shimming-toolbox/shimming-toolbox

Depending on your system, you may need to prefix this command with sudo (for a global install), or write it with install --user (for a user-local install) in order to be allowed to install it.

Development

Please see the documentation for instructions on building and testing a development version of shimming-toolbox.

Contributing

Please see our contribution guidelines.