Metadata-Version: 2.4
Name: aind-mri-targeting
Version: 0.2.0
Summary: Tools to plan and execute MRI-guided targeting experiments
Project-URL: Repository, https://github.com/AllenNeuralDynamics/aind-mri-targeting/
Project-URL: Issues, https://github.com/AllenNeuralDynamics/aind-mri-targeting/issues
Project-URL: Changelog, https://github.com/AllenNeuralDynamics/aind-mri-targeting/blob/main/CHANGELOG.md
Author: Allen Institute for Neural Dynamics
Author-email: Galen Lynch <galen@galenlynch.com>, Yoni Browning <yoni.browning@alleninstitute.org>
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: aind-anatomical-utils>=0.1
Requires-Dist: aind-mri-utils>=0.13
Requires-Dist: numpy>=1.20
Requires-Dist: pandas>=2
Requires-Dist: pynrrd>=1
Requires-Dist: simpleitk>=2
Requires-Dist: trimesh[recommend]>=4
Description-Content-Type: text/markdown

# AIND MRI Targeting

![CI](https://github.com/AllenNeuralDynamics/aind-mri-targeting/actions/workflows/ci-call.yml/badge.svg)
[![PyPI - Version](https://img.shields.io/pypi/v/aind-mri-targeting)](https://pypi.org/project/aind-mri-targeting/)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
[![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)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border.json)](https://github.com/copier-org/copier)

Tools to plan and execute MRI-guided targeting experiments

## Installation

If you choose to clone the repository, you can install the package by running the following command from the root directory of the repository:

```bash
pip install .
```

Otherwise, you can use pip:

```bash
pip install aind-mri-targeting
```


To install notebooks, run:
```bash
install_notebooks [path]
```


To develop the code, run:
```bash
uv sync
```

## Development

Please test your changes using the full linting and testing suite:

```bash
./scripts/run_linters_and_checks.sh -c
```

Or run individual commands:
```bash
uv run --frozen ruff format          # Code formatting
uv run --frozen ruff check           # Linting

uv run --frozen interrogate -v src   # Documentation coverage
uv run --frozen codespell --check-filenames  # Spell checking
uv run --frozen pytest --cov aind_mri_targeting # Tests with coverage
```



## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
