witzit/README.md

# witzit - What In The Zap Is That?
`witzit` --- What In The Zap Is That?
AI categorization of spectra from SciAps analyzers.


# Install
## Install Dependencies
Get system dependency and upgrade Python pip.
Perhaps do something like this, or
set up a Python virtual environment.

```
sudo apt update
sudo apt install git python3-pip
pip install --user --upgrade pip
```


## Clone Git Repo
Get source code with `git`.

```
git clone https://spacecruft.org/spacecruft/witzit
cd witzit/
pip install --user --upgrade -r requirements.txt
```


# Usage
HOWTO USE.


# Status
Alpha software under development.


# Hardware

* SciAps LIBS Analyzer

* SciAps XRF Analyzer


# Deep Learning Algorithm
Can use lots from `wut`.

* https://spacecruft.org/spacecruft/satnogs-wut/src/branch/master/wut-worker-mas.py#L67-L79

Amazingly (to me), the paper
*Classification of radioxenon spectra with deep learning algorithm*
(2021) by Azimi, et al. uses nearly the identical CNN `Sequence()` as
`wut` uses, indicating it may be a very good base to start from.

Paper is non-gratis science:

* https://www.sciencedirect.com/science/article/abs/pii/S0265931X21001909


The `Sequence()` diagram is pulled from the Azimi paper, but is the
same as in `wut`, so makes a good reference.


![Deep Learning Sequence](img/ml-sequence.png)


Will likely work best with binary categorizations. E.g. like this:
Is it element A or not element A?
Is it element B or not element B?
Is it element C or not element C?
Not "is it element A, B, or C?" 


# Unofficial
Unofficial, unaffiliated with SciAps.


# License
License: GPLv3 or any later version. 

Copyright (C) 2022, Jeff Moe