Metadata-Version: 2.1
Name: saat
Version: 0.1.0
Summary: Simulated annealing group allocation
Author: Samuel Weller
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: numpy (>=1.24.2,<2.0.0)
Requires-Dist: pandas (>=1.5.3,<2.0.0)
Requires-Dist: pytest (>=7.2.2,<8.0.0)
Requires-Dist: simanneal (>=0.5.0,<0.6.0)
Description-Content-Type: text/markdown

# Simulated Annealing Allocation Tool (SAAT)

## Install

**Git**
```
git clone https://github.com/samuelweller21/SAAT.git
cd SAAT
```

**Install dependencies**

```
# Intall [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
poetry shell
poetry install

# Jupyter
python3 -m ipykernel install --user --name="SAAT" --display-name="SAAT"
```

**Run tests**
```
pytest
```

See [Demo.ipynb](https://github.com/samuelweller21/SAAT/blob/main/Demo.ipynb) for example of use

