Metadata-Version: 2.1
Name: FastMF
Version: 0.1.0
Summary: FastMF is a python package for microstructural property characterization using deep learning based on diffusion MRI data.
Author: Quentin Dessain
Author-email: quentin.dessain@uclouvain.be
Requires-Python: >=3.8,<3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: cvxpy (<=1.3.1)
Requires-Dist: dipy (>=1.6,<2.0)
Requires-Dist: matplotlib (>=3.5,<4.0)
Requires-Dist: nibabel (<=5.0)
Requires-Dist: numba (<=0.57.0)
Requires-Dist: numpy (>=1.22,<2.0)
Requires-Dist: pathos (<=0.2.8)
Requires-Dist: scikit-learn (<=1.0)
Requires-Dist: scipy (<=1.7.3)
Requires-Dist: torch (<=2.0.0)
Requires-Dist: tqdm (<=4.48)
Description-Content-Type: text/markdown

# FastMF_public [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10643411.svg)](https://doi.org/10.5281/zenodo.10643411) [![PyPI](https://img.shields.io/pypi/v/FastMF?label=pypi%20package)](https://pypi.org/project/FastMF//)

FastMF is a Python library designed to perform dictionary matching on diffusion MRI data to a precomputed dictionary of microstructural features, leveraging deep learning for enhanced accuracy and efficiency.
## Installation
### Prerequisites
FastMF requires [Python](https://www.python.org/) v3.8+.
### Installation Steps
To get started with FastMF, follow these simple steps to clone the repository and set up the necessary environment:

```sh
git clone https://github.com/Hyedryn/FastMF_public.git
cd FastMF_public
python -m pip install .
```
## Usage 
To familiarize yourself with its functionality, we recommend exploring the various examples provided in the \`\`**examples**\`\` folder. 


