Metadata-Version: 2.5
Name: pytheranostics
Version: 0.3.0
Summary: A library of tools to process nuclear medicine scans and take them through the dosimetry workflow to calculate the absorbed dose in target organs.
Project-URL: Homepage, https://github.com/qurit/PyTheranostics
Project-URL: Bug Tracker, https://github.com/qurit/PyTheranostics/issues
Author: Pedro Esquinas, PhD, Sara Kurkowska, MD, PhD
Author-email: "Carlos Uribe, PhD, MCCPM" <curibe@bccrc.ca>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: pydicom
Requires-Dist: pynetdicom
Requires-Dist: rt-utils
Requires-Dist: scikit-image
Requires-Dist: simpleitk
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == 'dev'
Requires-Dist: flake8-docstrings>=1.7; extra == 'dev'
Requires-Dist: flake8>=6.0; extra == 'dev'
Requires-Dist: furo>=2024.1.29; extra == 'dev'
Requires-Dist: ipython>=8.0; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: myst-parser>=2.0; extra == 'dev'
Requires-Dist: nbconvert>=7.0; extra == 'dev'
Requires-Dist: nbsphinx>=0.9; extra == 'dev'
Requires-Dist: pandas-stubs>=2.0.0; extra == 'dev'
Requires-Dist: pandoc>=2.4; extra == 'dev'
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
Requires-Dist: pydocstyle>=6.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: scipy-stubs; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints>=2.0; extra == 'dev'
Requires-Dist: sphinx-contributors>=0.1; extra == 'dev'
Requires-Dist: sphinx-copybutton>=0.5; extra == 'dev'
Requires-Dist: sphinx-design>=0.5.0; extra == 'dev'
Requires-Dist: sphinx>=7.0; extra == 'dev'
Requires-Dist: torch; extra == 'dev'
Requires-Dist: torchvision; extra == 'dev'
Requires-Dist: totalsegmentator; extra == 'dev'
Requires-Dist: types-requests; extra == 'dev'
Provides-Extra: docs
Requires-Dist: furo>=2024.1.29; extra == 'docs'
Requires-Dist: ipython>=8.0; extra == 'docs'
Requires-Dist: myst-parser>=2.0; extra == 'docs'
Requires-Dist: nbconvert>=7.0; extra == 'docs'
Requires-Dist: nbsphinx>=0.9; extra == 'docs'
Requires-Dist: pandoc>=2.4; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints>=2.0; extra == 'docs'
Requires-Dist: sphinx-contributors>=0.1; extra == 'docs'
Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
Requires-Dist: sphinx-design>=0.5.0; extra == 'docs'
Requires-Dist: sphinx>=7.0; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Provides-Extra: totalsegmentator
Requires-Dist: nibabel; extra == 'totalsegmentator'
Requires-Dist: torch; extra == 'totalsegmentator'
Requires-Dist: torchvision; extra == 'totalsegmentator'
Requires-Dist: totalsegmentator; extra == 'totalsegmentator'
Description-Content-Type: text/markdown

[![Documentation Status](https://readthedocs.org/projects/pytheranostics/badge/?version=latest)](https://docs.pytheranostics.qurit.ca/en/latest/?badge=latest)

# PyTheranostics

A comprehensive Python library for nuclear medicine image processing and dosimetry calculations.

## Overview

PyTheranostics is a powerful toolkit designed for processing nuclear medicine scans and performing dosimetry calculations. It provides a complete workflow from image processing to absorbed dose calculations in target organs.

## Features

- Image processing and analysis
- Dosimetry calculations
- DICOM handling and manipulation
- Calibration tools
- Quality control utilities
- Registration and segmentation tools
- Visualization and plotting capabilities

## Installation

### Basic Installation

```bash
pip install pytheranostics
```

### Installation with Segmentation Support

If you plan to use the automatic segmentation tools with TotalSegmentator:

```bash
pip install pytheranostics[totalsegmentator]
```

This installs additional dependencies required for segmentation (torch, torchvision, and TotalSegmentator).

## Quick Start

```python
import pytheranostics as tx

# Load and process images
image = tx.ImagingDS.load_dicom("path/to/dicom")

# Perform dosimetry calculations
dose = tx.dosimetry.calculate_absorbed_dose(image)

# Visualize results
tx.plots.plot_dose_distribution(dose)
```

## Documentation

For detailed documentation, visit our [documentation page](https://pytheranostics.readthedocs.io/).

## Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

## License

This project is licensed under the terms of the LICENSE file included in the repository.

## Citation

If you use PyTheranostics in your research, please cite:

```
@software{pytheranostics2024,
  author = {Sara Kurkowska, Pedro Esquinas,Carlos Uribe},
  title = {PyTheranostics: A Python Library for Nuclear Medicine Processing and Dosimetry},
  year = {2024},
  url = {https://github.com/qurit/PyTheranostics}
}
```
