Metadata-Version: 2.4
Name: mritk
Version: 0.1.0
Summary: MRI processing toolkit.
Author-email: Jørgen Riseth <jnriseth@gmail.com>, Henrik Finsberg <henriknf@simula.no>, Cécile Daversin Catty <cecile@simula.no>
License-Expression: MIT
Project-URL: Homepage, https://github.com/scientificcomputing/mri-toolkit.git
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tqdm
Requires-Dist: numpy
Requires-Dist: rich-argparse
Requires-Dist: nibabel
Requires-Dist: pandas
Provides-Extra: show
Requires-Dist: textual-image; extra == "show"
Requires-Dist: pillow; extra == "show"
Requires-Dist: matplotlib; extra == "show"
Provides-Extra: napari
Requires-Dist: napari[all]; extra == "napari"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: pypi
Requires-Dist: build; extra == "pypi"
Provides-Extra: docs
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-codeautolink; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: jupytext; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinx-comments; extra == "docs"
Requires-Dist: sphinx-external-toc; extra == "docs"
Requires-Dist: linkify-it-py; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx-multitoc-numbering; extra == "docs"
Provides-Extra: all
Requires-Dist: mritk[extra,napari,pypi,show,test]; extra == "all"
Dynamic: license-file

# MRI-Toolkit

`MRI-toolkit` provides a set of features dedicated to human MRI data post-processing and analysis. The implementation is based on [gMRI2FEM](https://github.com/jorgenriseth/gMRI2FEM).

## Installation

```bash
pip install mritk
```

## Documentation
    
The documentation is available at [https://scientificcomputing.github.io/mri-toolkit/](https://scientificcomputing.github.io/mri-toolkit/). It includes detailed usage instructions, API references, and examples.


## Quick Start

To get started with `mri-toolkit`, you can use the command-line interface (CLI) to inspect and analyze your MRI data.

![readme](https://github.com/user-attachments/assets/404bc4be-7267-4d1c-9126-0bee7c4a316c)


## Features

* **File Inspection**: detailed NIfTI header analysis (affine, voxel size, shape).
* **Statistics**: Compute comprehensive statistics (volume, mean, median, std, percentiles) for MRI regions based on segmentation maps.
* **Visualization**:
    * **Terminal**: View orthogonal slices (Sagittal, Coronal, Axial) directly in your console.
    * **Napari**: Launch the Napari viewer for interactive 3D inspection.
* **Data Management**: Utilities to download test datasets.
