Metadata-Version: 2.4
Name: qmri-viz
Version: 0.1.0
Summary: Visualisation utilities for qmri quantitative MRI analysis
Author-email: Gold Standard Phantoms <tom.hampshire@goldstandardphantoms.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/gold-standard-phantoms/qmri
Project-URL: Documentation, https://qmri.readthedocs.io
Project-URL: Repository, https://github.com/gold-standard-phantoms/qmri
Keywords: mri,qmri,visualisation,plotting,matplotlib
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: qmri>=0.1.0
Requires-Dist: matplotlib>=3.7

# qmri-viz

Visualisation utilities for qmri quantitative MRI analysis.

## Installation

```bash
pip install qmri-viz
```

## Quick Start

```python
from qmri.diffusion import adc
from qmri.viz import fitting, maps

# Fit data
result = adc.fit(signal, b_values)

# Plot fit diagnostics
fitting.plot_fit(signal, b_values, result)

# Display parameter map
maps.show_slice(result.adc, title="ADC Map", cmap="viridis")
```

## Features

- **Fit diagnostics** — Visualise model fits with residuals
- **Parameter maps** — Display quantitative maps with appropriate colormaps
- **Calibration plots** — Phantom calibration visualisation
- **Multi-slice views** — Browse through 3D volumes

## Design

This package provides matplotlib-based visualisation utilities. It's kept separate from the core `qmri` package so users who don't need plotting avoid the matplotlib dependency.

## Documentation

Full documentation: https://gold-standard-phantoms.github.io/qmri

## Licence

MIT
