Metadata-Version: 2.4
Name: neuromaps-prime
Version: 0.1.0
Summary: A toolbox for projecting, resampling, and comparing NHP brain maps
Author-email: CMI DAIR <dair@childmind.org>
License: MIT License
        
        Copyright (c) 2026 Child Mind Institute
        
        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.
License-File: LICENSE
Keywords: connectomics,network neuroscience
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.11
Requires-Dist: matplotlib>=3.10.7
Requires-Dist: networkx>=3.6.1
Requires-Dist: nibabel>=5.2.1
Requires-Dist: niwrap>=0.9.2
Requires-Dist: numpy>=2.4.6
Requires-Dist: platformdirs>=4.10.0
Requires-Dist: pydantic>=2.12.3
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: requests>=2.34.2
Requires-Dist: scipy>=1.17.0
Requires-Dist: styxpodman
Description-Content-Type: text/markdown

# Neuromaps-PRIME <img src=".github/neuromaps_prime.svg" align="right" width="15%"/>

[![Build](https://github.com/childmindresearch/neuromaps-prime/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/childmindresearch/neuromaps-prime/actions/workflows/test.yaml?query=branch%3Amain)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/neuromaps-prime/blob/main/LICENSE)
[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/neuromaps-prime)

> [!Important]
> This project is currently in active development. The API is subject to breaking
> changes without notice.

The `neuromaps-prime` toolbox integrates multiscale, multimodal annotations across NHP
brains, enabling comprehensive comparative analyses of brain organization. This package
extends the neuromaps ecosystem to provide unified access to diverse NHP brain datasets
and specialized tools for NHP-specific analyses.

## Features

- Robust transformation between NHP spaces (Yerkes19, NMT2, CIVETNMT, D99, MEBRAINS)
- Cross-species transformation between NHP and human (Yerkes19, fsLR)

## Installation

To install the latest stable release version from PyPI, run:

```sh
pip install neuromaps-prime
```

Alternatively, if you want to use the newest development version, you can install it
directly from the repository via:


```sh
pip install git+https://github.com/childmindresearch/neuromaps-prime
```

## Examples

See the [`examples/`](examples/) directory for sample scripts:

- [`example_graph_init.py`](examples/example_graph_init.py) — graph inspection and plotting
- [`example_surface_transform.py`](examples/example_surface_transform.py) — surface-to-surface resampling and surface-to-volume projection
- [`example_volume_transform.py`](examples/example_volume_transform.py) — volume-to-volume warping and volume-to-surface projection
- [`example_plot_interactive_graph.py`](examples/example_plot_interactive_graph.py) - generating an interactive HTML plot of the graph
