Metadata-Version: 2.4
Name: simnibs-analyze
Version: 0.1.0
Summary: Modular pipeline for brain stimulation modelling (tDCS/TMS) with SimNIBS
License: MIT License
        
        Copyright (c) 2026 Hippolyte Dreyfus, ICM Frontlab CDPR
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: simnibs-reader>=0.2.0
Requires-Dist: nibabel>=5.0
Requires-Dist: nilearn>=0.10
Requires-Dist: numpy>=1.24
Requires-Dist: pandas>=2.0
Requires-Dist: scipy>=1.10
Requires-Dist: pydantic>=2.0
Requires-Dist: matplotlib>=3.7
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.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: citations
Requires-Dist: duecredit>=0.9; extra == "citations"
Dynamic: license-file

# simnibs-analyze

> Cohort-level analysis and visualisation of SimNIBS e-field simulations, driven by YAML config.
>
> `simnibs-analyze` turns SimNIBS outputs into ROI statistics and publication figures
> across subjects and conditions, for non-invasive brain stimulation studies (TMS/tDCS).

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

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

---

## Install & run

```bash
pip install simnibs-analyze
```

Two config-driven commands:

```bash
simnibs-analyze --config config-analyze.yaml   # features + statistics
simnibs-viz     --config config-viz.yaml       # figures + cohort montages
```

Ready-made configs in [`docs/examples/config/`](docs/examples/config/), full key
reference in the [configuration guide](https://ICM-Frontlab-CDPR.github.io/simnibs-analyze/configuration/).

---

## Ecosystem

`simnibs-analyze` is built on:

* [simnibs-reader](https://github.com/ICM-Frontlab-CDPR/simnibs-reader) (structured access to SimNIBS outputs)

It consumes results produced by:

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

---
