Metadata-Version: 2.1
Name: quickest
Version: 0.1.1
Summary: Tools for studying change detection problems. The justification for this package is that there are libraries for studying Markov chains, and there are libraries for numeric optimisation, but there is no standalone library for optimising the parameters of a Markov decision process.
License: Proprietary
Author: Jenna Riseley
Author-email: j2.riseley@qut.edu.au
Requires-Python: >=3.7,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: matplotlib (>=3.2.1,<4.0.0)
Requires-Dist: numpy (>=1.16.4,<2.0.0)
Requires-Dist: pandas (>=1.0.5,<2.0.0)
Requires-Dist: pyyaml (>=5.3.1,<6.0.0)
Requires-Dist: scipy (>=1.4.1,<2.0.0)
Description-Content-Type: text/markdown


# Install


Set up the workspace:


    . .env
    chmod +x scripts/*

## Option 1. Install from source


Install ``poetry``, ``pyenv``, ``pylint``, ``sphinx`` and ``pytest``.

Build and install the library into the local ``pyenv`` environment:


    make install


## Option 2. Install from PyPI


This is not guaranteed to be the same version as the source in this repository. Check [PyPI](https://pypi.org/project/quickest/) for the latest release date.

    pip install quickest


# Test 

    pytest


# Use

## Train a threshold

    ./scripts/train.sh

## View the last experiment

    ./scripts/simulate.sh

## Profile one training step

    ./scripts/profile.sh


Pass a `-h` flag to a bash script to see more instructions.

# Documentation

Generate documentation:

    make doc
