Welcome to the developers page for qMRLab
Thank you for considering to contribute to the standardization of quantitative Magnetic Resonance Imaging!
A brief look at the qMRLab
qMRlab is a powerful, open source, scalable, easy to use and intuitive tool for qMR data simulation, fitting and analysis. The program consists of two major components:
- qMR data simulators
- qMR data fitting & visualization interfaces.
Data simulators allow end users to easily simulate qMR data for assessing how well qMR models perform under known parameters input. This opens up the way for defining appropriate acquisition protocols and evaluating the impact of fitting constraints on the results.
We opted to design an intuitive graphical user interface (GUI) to import real-world qMR data, fit them using the selected fitting procedure, and visualize the resulting parameters maps. Moreover, qMRLab comes along with a useful command line interface (CLI) for users who would like to look under the hood and use its sub-components in their analysis pipeline.
qMRLab's motto is Quantitative MRI, under one umbrella. The following sections will provide useful documentation for you to help make this umbrella withstand strong irreproducibility winds.
Rules for the developer
We have a set of easy to follow rules for sustaining a systematic development environment. You are kindly asked to take a look at them:
Before getting your hands dirty with qMRLab as a developer, please download qMRLab to your local machine as described in here.
After each change made in the code, qMRLab evokes a testing procedure to ensure that independently developed software pieces still can work together:
Some reading material that we believe can be useful from a developer perspective: