MunchDev / EpidemicVisualiser

MIT License
1 stars 0 forks source link

Epidemic Visualiser

This repository contains a visualiser and prediction model for the COVID-19 situation.

Note: This is a school project, feel free to send me a PR!

Status: I'm too busy with school work to continue this project! However, if you stumble upon this, these are things you can update to make it work again:

Go to LiveNotes

Branch Notebook on Binder
master (Production ready) Binder
develop (Experimental) Binder

Build status

Branch Notebook on Binder
master (Production ready) Build Status
develop (Experimental) Build Status

Usage

Live notebooks

Click on any LiveNote above to explore our notebooks without the hassle of downloading or installing anything! Explore as far as you want, and if you break it? Go and create another notebook!

Local machine

If you want to host the notebook on your own computer, follow the instructions:

Installation

You need:

and run the following:

git clone https://github.com/MunchDev/EpidemicSimulator
cd EpidemicSimulator
pip install -r "requirements.txt"

NOTE: It does not install JupyterLab for Jupyter Notebook, if you want to use it, please install it on their website.

Import

Please DO AND ONLY DO the following:

from data_miner import plot_tally
plot_tally(....)

Input validation is only applied in this front-end function. Other functions are hidden by default. If you want to expose it, DO AT YOUR OWN RISK.

Documentation

This documentation is only available to front-end functions. Other functions used by those functions are strictly internal and optimised.

data_miner.plot_tally

Draw the COVID-19 statistics plots of different countries in a period of time, using different scales and types.\ Return value: Returns 0 if no errors occured and -1 if at least one error occurs.

Positional arguments

Keyword arguments

Help

For list of supported countries

Click HERE