disimpy

disimpy copied to clipboard

Disimpy

Disimpy is a Python package for generating simulated diffusion-weighted MR signals that can be useful in the development and validation of data acquisition and analysis methods. The data is generated by Monte Carlo random walk simulations that run massively parallel on Nvidia CUDA-capable GPUs. If you use Disimpy in work that leads to a scientific publication, please cite [1]_, where the details about signal generation can also be found.

Requirements and installation #############################

Follow the installation instructions <https://disimpy.readthedocs.io/en/latest/installation.html>_.

Usage example #############

Read the tutorial <https://disimpy.readthedocs.io/en/latest/tutorial.html>_ to learn how to use Disimpy.

Validation ##########

Disimpy's functionality has been validated by comparing its results to analytical solutions and to results from other simulators (e.g., Camino <http://camino.cs.ucl.ac.uk/>_ and MISST <http://mig.cs.ucl.ac.uk/index.php?n=Tutorial.MISST>), and by automated testing (:code:disimpy.tests). Examples of simulations used for validation are provided here <https://disimpy.readthedocs.io/en/latest/validation.html>. However, Disimpy is research software and some bugs undoubtedly remain. If you find any of them or encounter unexpected behaviour, please open an issue on GitHub <https://github.com/kerkelae/disimpy/issues>_.

Contribute ##########

If you want to contribute to the development of Disimpy, start by reading the contributing guidelines <https://disimpy.readthedocs.io/en/latest/contributing.html>_.

Support #######

If you have questions or need help, open an issue on Github <https://github.com/kerkelae/disimpy/issues>_.

References ##########

.. [1] Kerkelä et al., (2020). Disimpy: A massively parallel Monte Carlo simulator for generating diffusion-weighted MRI data in Python. Journal of Open Source Software, 5(52), 2527. https://doi.org/10.21105/joss.02527

Sponsors ########

|

.. image:: https://disimpy.readthedocs.io/en/latest/_static/nihr_gosh_brc_logo.png :width: 418 :alt: National Institute of Health Research Great Ormond Street Biomedical Research Centre :align: center :target: https://www.gosh.nhs.uk/our-research/our-research-infrastructure/nihr-great-ormond-street-hospital-brc/

|

.. image:: https://disimpy.readthedocs.io/en/latest/_static/gsoc_logo.png :width: 200 :alt: Google Summer of Code :align: center :target: https://summerofcode.withgoogle.com/

|

.. image:: https://disimpy.readthedocs.io/en/latest/_static/rh_logo.png :width: 300 :alt: ResearchHub :align: center :target: https://www.researchhub.com/