SOP series: Introduction to qMRLab and installation
Introduction
This qMRLab standard operating procedure (SOP) series is intended to be a step-by-step guide on how to process quantitative MRI data using qMRLab. In this blog post, we'll guide you through installing qMRLab, and upcoming blog posts will provide SOPs for specific qMRLab modules.
In addition, below is a video tutorial on how to use qMRLab and many of its features (eg., simulations, data fitting, quality checking, etc) using the quantitative MT moule. It was presented at the 2022 ISMRM conference.
Software Requirements
Minimum requirements
Optional
Installing qMRLab
qMRLab [1,2] is an open-source quantitative MRI software that can be used to process a large range of quantitative MRI maps (T1, T2, MTR, MTsat, MP2RAGE, etc), and is developed mainly by the NeuroPoly Lab.
Because it’s an open-source software, it’s continuously in development, so the packaged releases on the GitHub repository or main website may not contain the latest features needed, or may contain bugs that were since fixed.
For convenience, users not already familiar with git you should download the qMRLab version linked here. It is a compressed zip file; if it doesn’t extract by itself after the download, please do so manually using the appropriate tool for your operating system and then move the qMRLab folder wherever you’d like it stored. You should also rename it to simply “qMRLab”.
Following this step, you need to ensure that a previous version of qMRLab has not been saved in MATLAB.
- Open MATLAB.
- In the Home toolbar tab, navigate to the Environment section and click Set Path.
- Scroll through the list of directories that are in MATLAB’s path (i.e. directories where it can “see” the files for use in your MATLAB session), and select all the ones associated with previous qMRLab installations if there are any.
- Click Remove.
- A new window will appear asking if you want to save this as default. This choice is up to you, we recommend that you click Yes but this may not be appropriate for everyone.
- Now, open the qMRLab directory where you’ve stored it after downloading the correct version and extracting it.
- In the Command Window, type startup and press enter/return.
- qMRLab is now in your path, however the next time you open MATLAB, it won’t be. You can choose to do this each time you use qMRLab (open the directory and run startup), or you can add it to your default path. To do so, navigate to Set Path in the Environment section of the Home tab, and click Save.
- If you did the last step, now anytime you want to use qMRLab you’ll be able to immediately after opening MATLAB.
- To start qMRLab, type qMRLab in the Command Window and wait for the graphical user interface (GUI) to load.
- Karakuzu A, Boudreau M, Duval T, Boshkovski T, Leppert I, Cabana J-F, et al. qMRLab: Quantitative MRI analysis, under one umbrella. J Open Source Softw. 2020;5: 2343.
- Cabana J-F, Gu Y, Boudreau M, Levesque IR, Atchia Y, Sled JG, et al. Quantitative magnetization transfer imagingmadeeasy with qMTLab: Software for data simulation, analysis, and visualization. Concepts Magn Reson Part A Bridg Educ Res. 2015;44A: 263–277.
Except where otherwise noted, the content on this blog is licensed under a Creative Commons Attribution 4.0 International license.
|