Machine learning-based models and utilities for radioisotope identification
Project description
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:
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.
Authors
Current:
- Tyler Morrow - tmorro@sandia.gov
- Nathan Price - njprice@sandia.gov
Past:
- Travis McGuire
- Original creator of the
PoissonBayes
model.
- Original creator of the
For other contributors, see here.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.