Skip to content

Commit

Permalink
cleanup Readme and add codespell fix
Browse files Browse the repository at this point in the history
  • Loading branch information
stebo85 authored Aug 28, 2024
1 parent 719f661 commit 3b999aa
Showing 1 changed file with 9 additions and 16 deletions.
25 changes: 9 additions & 16 deletions recipes/qmrlab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,26 @@
----------------------------------
## qmrlab/toolVersion##

<b><h2 align="center">
qMRLab is an open-source software for quantitative MR image analysis.</h2></b>
qMRLab is an open-source software for quantitative MR image analysis.

<p align="center">Our main goal is to provide the community with an intuitive tool for <b>data fitting</b>, <b>plotting</b>, <b>simulation</b> and <b>protocol optimization</b> for a myriad of different quantitative models.
The modularity of the qMRLab framework makes it easy to add any additional modules and we encourage everyone to contribute their favorite recipe for qMR!</p>
Our main goal is to provide the community with an intuitive tool for data fitting, plotting, simulation and protocol optimization for a myriad of different quantitative models.
The modularity of the qMRLab framework makes it easy to add any additional modules and we encourage everyone to contribute their favorite recipe for qMR!

<p align="center">
For <b>documentation 📖</b>, visit the <a href="http://qmrlab.readthedocs.io/">Documentation website</a>.</p>
For documentation, visit http://qmrlab.readthedocs.io/

<p align="center">
If you are a <b>developer 🛠</b>, please visit the <a href="https://github.com/neuropoly/qMRLab/wiki">Wiki page<a>.</p>
If you are a developer please visit https://github.com/neuropoly/qMRLab/wiki

<p align="center">
Please report any <b>bug 🐛</b> or <b>suggestions 💭</b> in <a href="https://github.com/neuropoly/qMRLab/issues">GitHub</a>.</p>
Please report any bug or suggestions in https://github.com/neuropoly/qMRLab/issues

<p align="center">
For <b>interactive tutorials 🎚</b>, <b>blog posts 🖋</b> and more, you can visit <a href="https://qmrlab.org">qMRLab portal</a>.</p>
For interactive tutorials blog posts and more, you can visit https://qmrlab.org

<p align="center">
qMRLab is a fork from the initial project <a href="https://github.com/neuropoly/qMTLab">qMTLab</a>.</p>
qMRLab is a fork from the initial project https://github.com/neuropoly/qMTLab

Citation:

* [Karakuzu et al. *qMRLab: Quantitative MRI analysis, under one umbrella.* Journal of Open Source Software (JOSS) 2020](https://joss.theoj.org/papers/10.21105/joss.02343)
* [Karakuzu et al. *The qMRLab workflow: From acquisition to publication.* ISMRM 2019](https://www.ismrm.org/19/program_files/DP23.htm#005)
* [Duval et al. *Quantitative MRI made easy with qMRLab.* ISMRM 2018](http://archive.ismrm.org/2018/2288.html)
* [Cabana et al. *Quantitative magnetization transfer imaging made easy with qMTLab: Software for data simulation, analysis, and visualization.* Concepts in Magn Reson 2015](https://onlinelibrary.wiley.com/doi/abs/10.1002/cmr.a.21357)
* [Cabana et al. *Quantitative magnetization transfer imaging made easy with qMTLab: Software for data simulation, analysis, and visualization.* Concepts in Magn Reson 2015](https://onlinelibrary.wiley.com/doi/abs/10.1002/cmr.a.21357) # codespell:ignore Reson

Check failure on line 24 in recipes/qmrlab/README.md

View workflow job for this annotation

GitHub Actions / Check for spelling errors

Reson ==> Reason

Check failure on line 24 in recipes/qmrlab/README.md

View workflow job for this annotation

GitHub Actions / Check for spelling errors

Reson ==> Reason

License: MIT License

Expand Down

0 comments on commit 3b999aa

Please sign in to comment.