Metadata-Version: 2.1
Name: riid
Version: 1.0.1
Summary: Machine learning-based models and utilities for radioisotope identification
Home-page: https://github.com/sandialabs/PyRIID
Author: Tyler Morrow,Nathan Price
Author-email: tmorro@sandia.gov,njprice@sandia.gov
License: BSD-3
Keywords: pyriid riid machine learning
Platform: UNKNOWN
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.7
Requires-Python: >=3.7, <3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md

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

This repository contains core functions and classes used by the BALDR project (Base Algorithms for Learned Detection of Radioisotopes) for its research in machine learning-based radioisotope identification (ML-RIID).

## Prerequisites

- Python 3.7

## Installation

```
pip install riid
```

### Data Directory (optional)

Some *convenience* functions are usable only if you set the `PYRIID_DATA_DIR` environment variable to a path to some directory on your computer.

## Examples

Check out the `./examples` folder for numerous examples on how to use this package.

## Tests

Run all unit tests with the following command:

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

Or you run the `run_tests.sh` script.

## 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](./CODE_OF_CONDUCT.md).

## Authors

Current:

- **Tyler Morrow** - tmorro@sandia.gov
- **Nathan Price** - njprice@sandia.gov

Past:

- [Travis McGuire](https://github.com/traviemcg)
    - Original creator of the `PoissonBayes` model.

For other contributors, see [here](./CONTRIBUTORS.md).

## Copyright

Copyright 2021 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.

This source code is licensed under the BSD-style license found [here](./LICENSE.md).


