Metadata-Version: 2.1
Name: epispot
Version: 0.0.2
Summary: A tool for modelling infectious diseases.
Home-page: https://quantum9innovation.github.io/epispot
Author: quantum9innovation
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown

# ![epi-spot](https://i.ibb.co/hXMjrCV/epi-spot.png)

A tool for creating and testing epidemiological models faster than ever for the mathematical modelling of infectious 
diseases. An idea from https://github.com/henrifroese/infectious_disease_modelling.

## Installation

Install via `pip install epispot` <br>
As a shorthand, use as `import epispot as epi`

## Screenshots

![epidemic-graph](https://i.ibb.co/K9wrhhs/temp.png)

## Features

 - SIR-based models
    - Susceptible
    - Infected
    - Recovered
    - Exposed
    - Dead
    - Critical
    - Hospitalized

 - Custom-defined compartmental models
    - Create custom models using the `Model` class

 - Graphing Capabilities
    - Plot real data from a `.csv` file
    - Plot model predictions interactively
    - Compare different model predictions

## Compile your model at the speed of light
### and get insights that match
Documentation can easily be accessed from function, class, and file docstrings.
Doc strings provide additional documentation on a certain function.
They can be accessed by the built-in Python `help()` command.
These strings are formatted in Github-flavored markdown.
Additionally, all files will have a 'STRUCTURE' label.


