Skip to main content

A tool for modelling infectious diseases.

Project description

epi-spot

latest-release conda Downloads Language grade: Python Total alerts lines of code open-issues build-status

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


epi-spot social image

Installation

Epispot can be installed via pip or via Anaconda. If using pip, install with:

pip install epispot

For Anaconda, use:

conda config --add channels conda-forge
conda install -c conda-forge epispot

As a shorthand, use import epispot as epi.

You can also install the epispot-nightly package from pip:

pip install epispot-nightly

You can import it the same as import epispot as epi. Both packages cannot be used at the same time.

Getting Started

Check the guides and tutorials found in the tests/tutorials folder. All tutorials will have a .md file followed by a corresponding code file. If you get stuck, don't understand something, or just need to reference the documentation, per-class documentation can be found at https://epispot.github.io/epispot. You may also find it helpful to see the examples in the tests/examples folder.

Screenshots

sf-case-study line-graph

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

Stats

GitHub Tests: build-status
PyPi: Downloads
Anaconda: Anaconda Donwloads

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

epispot-2.0.2.tar.gz (16.4 kB view hashes)

Uploaded source

Built Distribution

epispot-2.0.2-py3-none-any.whl (28.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page