Metadata-Version: 2.1
Name: riid
Version: 2.0.0.post1
Summary: Machine learning-based models and utilities for radioisotope identification
Author: Tyler Morrow, Nathan Price, Travis McGuire, Tyler Ganter, Aislinn Handley, Paul Thelen, Alan Van Omen, Leon Ross, Alyshia Bustos
Maintainer-email: Tyler Morrow <tmorro@sandia.gov>
License: # BSD 3-Clause License
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
        IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: repository, https://github.com/sandialabs/PyRIID
Keywords: pyriid,riid,machine learning,radioisotope identification,gamma spectrum
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: <3.11,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: NOTICE.md
Requires-Dist: jsonschema==4.17.*
Requires-Dist: matplotlib==3.7.*
Requires-Dist: pyyaml==6.0.*
Requires-Dist: seaborn==0.12.*
Requires-Dist: tf2onnx==1.14.*
Requires-Dist: tqdm==4.65.*
Requires-Dist: numpy==1.23.*
Requires-Dist: onnxruntime==1.15.*
Requires-Dist: pandas==2.0.*
Requires-Dist: pythonnet==3.0.*; platform_system == "Windows"
Requires-Dist: tables==3.8.*
Requires-Dist: tensorflow==2.12.*
Requires-Dist: tensorflow-io==0.27.*
Requires-Dist: tensorflow-model-optimization==0.7.*
Requires-Dist: tensorflow-probability==0.20.*
Requires-Dist: typeguard==2.7.*
Requires-Dist: scikit-learn==1.2.*
Provides-Extra: dev
Requires-Dist: flake8; extra == "dev"
Requires-Dist: flake8-quotes; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: tabulate; extra == "dev"

<p align="center">
  <img src="https://user-images.githubusercontent.com/1079118/124811147-623bd280-df1f-11eb-9f3a-a4a5e6ec5f94.png" alt="PyRIID">
</p>

[![Python](https://img.shields.io/pypi/pyversions/riid)](https://badge.fury.io/py/riid)
[![PyPI](https://badge.fury.io/py/riid.svg)](https://badge.fury.io/py/riid)

This repository contains the PyRIID package (as well as tests and examples) which provides utilities that support machine learning-based research and solutions to radioisotope identification.

## Installation

These instructions assume you meet the following requirements:

- Python version: 3.8 to 3.10
- Operating systems: Windows, Mac, or Ubuntu

A virtual environment is recommended.

Tests and examples are ran via Actions on many combinations of Python version and operating system.
You can verify support for your platform by checking the workflow files.

### For Use

To use the latest version on PyPI (note: changes are currently slower to appear here), run:

```
pip install riid
```

**For the latest features, run:**

```
pip install git+https://github.com/sandialabs/pyriid.git@main
```

### For Development

If you are developing PyRIID, clone this repository and run:

```
pip install -e ".[dev]"
```

**If you have trouble with Pylance resolving imports for an editable install, try this:**

```
pip install -e ".[dev]" --config-settings editable_mode=compat
```

## Examples

Examples for how to use this package can be found [here](https://github.com/sandialabs/PyRIID/blob/main/examples).

## Tests

Unit tests for this package can be found [here](https://github.com/sandialabs/PyRIID/blob/main/tests).

Run all unit tests with the following command:

```sh
python -m unittest tests/*.py -v
```

You can also run one of the `run_tests.*` scripts, whichever is appropriate for your platform.

## Contributing

Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate and adhere to our [code of conduct](https://github.com/sandialabs/PyRIID/blob/main/CODE_OF_CONDUCT.md).

## Contacts

Maintainers and authors can be found [here](https://github.com/sandialabs/PyRIID/blob/main/pyproject.toml).

## Copyright

Full copyright details are outlined [here](https://github.com/sandialabs/PyRIID/blob/main/NOTICE.md)

## Acknowlegements

**Thank you** to the U.S. Department of Energy, National Nuclear Security Administration,
Office of Defense Nuclear Nonproliferation Research and Development (DNN R&D) for funding that has led to version `2.x`.

Additionally, **thank you** to the following individuals who have provided invaluable subject-matter expertise:

- Ben Maestas
- Greg Thoreson
- Michael Enghauser
