Skip to content

Commit

Permalink
updating readme and singularity for v105, updating license with citation
Browse files Browse the repository at this point in the history
  • Loading branch information
leonyichencai committed Feb 5, 2021
1 parent cbc464e commit ade798e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ PART B. DOWNLOADING AGREEMENT - License from Vanderbilt with Right to Sublicense

9. Any publications that make use of the Software should include an acknowledgement to Vanderbilt University and the software developers using the citation below:

**Leon Y. Cai, Qi Yang, Colin B. Hansen, Vishwesh Nath, Karthik Ramadass, Graham W. Johnson, Benjamin N. Conrad, Brian D. Boyd, John P. Begnoche, Lori L. Beason-Held, Andrea T. Shafer, Susan M. Resnick, Warren D. Taylor, Gavin R. Price, Victoria L. Morgan, Baxter P. Rogers, Kurt G. Schilling, Bennett A. Landman. *PreQual: An automated pipeline for integrated preprocessing and quality assurance of diffusion weighted MRI images*. bioRxiv, 2020. Preprint.**
**Leon Y. Cai, Qi Yang, Colin B. Hansen, Vishwesh Nath, Karthik Ramadass, Graham W. Johnson, Benjamin N. Conrad, Brian D. Boyd, John P. Begnoche, Lori L. Beason-Held, Andrea T. Shafer, Susan M. Resnick, Warren D. Taylor, Gavin R. Price, Victoria L. Morgan, Baxter P. Rogers, Kurt G. Schilling, Bennett A. Landman. *PreQual: An automated pipeline for integrated preprocessing and quality assurance of diffusion weighted MRI images*. Magnetic Resonance in Medicine, 2021.**

10. For commercial use rights, contact the Vanderbilt University Center for Technology Transfer and Commercialization at cttc@vanderbilt.edu or call 615-343-2430 and inquire about the Program.

Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@

## Authors and Reference

[Leon Y. Cai](mailto:leon.y.cai@vanderbilt.edu), Qi Yang, Colin B. Hansen, Vishwesh Nath, Karthik Ramadass, Graham W. Johnson, Benjamin N. Conrad, Brian D. Boyd, John P. Begnoche, Lori L. Beason-Held, Andrea T. Shafer, Susan M. Resnick, Warren D. Taylor, Gavin R. Price, Victoria L. Morgan, Baxter P. Rogers, Kurt G. Schilling, Bennett A. Landman. *PreQual: An automated pipeline for integrated preprocessing and quality assurance of diffusion weighted MRI images*. [bioRxiv](https://www.biorxiv.org/content/10.1101/2020.09.14.260240v3), 2020. Preprint.
[Leon Y. Cai](mailto:leon.y.cai@vanderbilt.edu), Qi Yang, Colin B. Hansen, Vishwesh Nath, Karthik Ramadass, Graham W. Johnson, Benjamin N. Conrad, Brian D. Boyd, John P. Begnoche, Lori L. Beason-Held, Andrea T. Shafer, Susan M. Resnick, Warren D. Taylor, Gavin R. Price, Victoria L. Morgan, Baxter P. Rogers, Kurt G. Schilling, Bennett A. Landman. *PreQual: An automated pipeline for integrated preprocessing and quality assurance of diffusion weighted MRI images*. [Magnetic Resonance in Medicine](https://onlinelibrary.wiley.com/doi/full/10.1002/mrm.28678), 2021.

[Medical-image Analysis and Statistical Interpretation (MASI) Lab](https://my.vanderbilt.edu/masi), Vanderbilt University, Nashville, TN, USA

## Containerization of Source Code

git clone https://github.com/MASILab/PreQual.git
cd /path/to/repo/PreQual
git checkout v1.0.4
git checkout v1.0.5
sudo singularity build /path/to/prequal.simg Singularity

We use Singularity version 3.4 with root permissions.
Expand Down Expand Up @@ -199,6 +199,12 @@ Run `topup` with a synthetic b0 generated with the Synb0-DisCo deep-learning fra

Default = on

**--topup\_first\_b0s\_only**

Run `topup` with only the first b0 from each input image. At the time of writing, **FSL's topup cannot be parallelized**, and the runtime of topup can increase dramatically as more b0 volumes are included. This flag allows for faster processing at the expense of information lost from any interleaved b0s.

Default = use ALL b0s

**--extra\_topup\_args="string”**

Extra arguments to pass to FSL’s `topup`. `Topup` will run with the following by default (as listed in the `/SUPPLEMENTAL/topup.cnf` configuration file) but will be overwritten by arguments passed to `--extra_topup_args`:
Expand Down Expand Up @@ -306,7 +312,7 @@ Default = do NOT keep intermediates

**--num\_threads N**

A positive integer indicating the number of threads to use when running portions of the pipeline that can be multithreaded (i.e. MRTrix3, ANTs, and FSL’s eddy without GPU acceleration). Please note that at the time of writing, **FSL's topup cannot be parallelized**, and that the runtime of topup can increase dramatically as more b0 volumes are included.
A positive integer indicating the number of threads to use when running portions of the pipeline that can be multithreaded (i.e. MRTrix3, ANTs, and FSL’s eddy without GPU acceleration). Please note that at the time of writing, **FSL's topup cannot be parallelized**, and that the runtime of topup can increase dramatically as more b0 volumes are included. See `--topup_first_b0s_only` for more information.

Note: Due to resource concerns, special permission needed to multi-thread on XNAT.

Expand Down
2 changes: 1 addition & 1 deletion Singularity
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ From: ubuntu:18.04
cd /INSTALLERS
git clone https://github.com/MASILab/PreQual.git
cd PreQual
git checkout v1.0.4
git checkout v1.0.5
mv src/APPS/* /APPS
mv src/CODE/* /CODE
mv src/SUPPLEMENTAL/* /SUPPLEMENTAL
Expand Down

0 comments on commit ade798e

Please sign in to comment.