Metadata-Version: 2.1
Name: gammaspotter
Version: 0.2.4
Summary: GUI for detecting and identifying gamma sources.
Home-page: https://github.com/tijnsc/gammaspotter/
License: GPL-3.0-or-later
Author: Tijn Schuitevoerder
Author-email: tijnschuitevoerder@gmail.com
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: numpy (>=1.26.2,<2.0.0)
Requires-Dist: pandas (>=2.1.3,<3.0.0)
Requires-Dist: pathlib (>=1.0.1,<2.0.0)
Requires-Dist: pyqtgraph (>=0.13.3,<0.14.0)
Requires-Dist: pyside6 (>=6.6.1,<7.0.0)
Requires-Dist: scipy (>=1.11.4,<2.0.0)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Project-URL: Documentation, https://tijnsc.github.io/gammaspotter/
Project-URL: Repository, https://github.com/tijnsc/gammaspotter/
Description-Content-Type: text/markdown

# gammaspotter
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://tijnsc.github.io/gammaspotter/)
[![pypi version](https://img.shields.io/pypi/v/gammaspotter.svg)](https://pypi.org/project/gammaspotter/)

The [gammaspotter](https://github.com/tijnsc/gammaspotter/) application is designed to identify radioactive sources in gamma spectra.

---

**[Features](#features)** - **[Installation](#installation)**

![gammaspotter_window](https://raw.githubusercontent.com/tijnsc/gammaspotter/main/.github/images/gammaspotter_window.png)

## Features

- **Measurement Calibration** The calibrate tab lets the user calibrate a gamma spectrum by comparing known energies to peak energies.

- **Data Visualization:** The analyze tab offers an interactive visualization to help you gain insights into your data.

- **Statistical Analysis:** You can perform statistical analysis on your calibrated data using built-in functions and algorithms. This includes peak detection, peak fitting and isotope match detection.

- **Report Generation:** Once you have completed your analysis, the analyze tab enables you to generate reports summarizing your findings. You can access visualizations and statistical results.

## Installation

You can easily install `gammaspotter` using `pip`. First, ensure you have Python and pip installed. Then, open a terminal or command prompt and execute the following command:

```bash
pip install gammaspotter
```

This command will download and install the latest version of gammaspotter from [PyPI](https://pypi.org/).

You can now start the application by running the `gammaspotter` command in a terminal.
