Metadata-Version: 2.4
Name: simnibs-reader
Version: 0.3.0
Summary: Lightweight reader for SimNIBS output directories (segmentation, simulation, optimization)
License-Expression: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nibabel>=5.0
Requires-Dist: nilearn>=0.10
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Requires-Dist: pandas>=2.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Requires-Dist: mkdocs-jupyter; extra == "docs"
Provides-Extra: opti
Requires-Dist: h5py>=3.0; extra == "opti"
Dynamic: license-file

# simnibs-reader

> Python API for structured access to SimNIBS segmentation/simulation/optimization results.
>
> `simnibs-reader` provides a clean Python interface to navigate and query SimNIBS outputs,
> organized across three levels (folders, files, structures)

[![PyPI version](https://badge.fury.io/py/simnibs-reader.svg)](https://pypi.org/project/simnibs-reader/)
[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://ICM-Frontlab-CDPR.github.io/simnibs-reader/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

📖 **Full documentation → [ICM-Frontlab-CDPR.github.io/simnibs-reader](https://ICM-Frontlab-CDPR.github.io/simnibs-reader/)**

---

## Ecosystem

`simnibs-reader` consumes inputs from:

* simnibs
* [simnibs-modular](https://github.com/ICM-Frontlab-CDPR/simnibs-modular) (damaged-brain simnibs preparation)

And `simnibs-reader` outputs are consumed by:

* [simnibs-analyze](https://github.com/ICM-Frontlab-CDPR/simnibs-analyze) (basic statistical analysis - preparation for behavioral/clinical correlation)
* opti-stroke (automated pipeline to optimize tES in clinical usages)

---
