Skip to content

Commit ade798e

Browse files
committed
updating readme and singularity for v105, updating license with citation
1 parent cbc464e commit ade798e

3 files changed

Lines changed: 11 additions & 5 deletions

File tree

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ PART B. DOWNLOADING AGREEMENT - License from Vanderbilt with Right to Sublicense
5252

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

55-
**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.**
55+
**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.**
5656

5757
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.
5858

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@
5151

5252
## Authors and Reference
5353

54-
[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.
54+
[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.
5555

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

5858
## Containerization of Source Code
5959

6060
git clone https://github.com/MASILab/PreQual.git
6161
cd /path/to/repo/PreQual
62-
git checkout v1.0.4
62+
git checkout v1.0.5
6363
sudo singularity build /path/to/prequal.simg Singularity
6464

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

200200
Default = on
201201

202+
**--topup\_first\_b0s\_only**
203+
204+
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.
205+
206+
Default = use ALL b0s
207+
202208
**--extra\_topup\_args="string”**
203209

204210
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`:
@@ -306,7 +312,7 @@ Default = do NOT keep intermediates
306312

307313
**--num\_threads N**
308314

309-
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.
315+
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.
310316

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

Singularity

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ From: ubuntu:18.04
8484
cd /INSTALLERS
8585
git clone https://github.com/MASILab/PreQual.git
8686
cd PreQual
87-
git checkout v1.0.4
87+
git checkout v1.0.5
8888
mv src/APPS/* /APPS
8989
mv src/CODE/* /CODE
9090
mv src/SUPPLEMENTAL/* /SUPPLEMENTAL

0 commit comments

Comments
 (0)