Skip to main content

A tool for modeling infectious diseases.

Project description

epispot

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

A tool for creating and testing compartmental 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

DOI Information

Use epispot's DOI in your research! :fireworks:
DOI

Citation:

q9i, & QLabs. (2021, April 2). epispot/epispot: (Version 2.1.0). Zenodo. http://doi.org/10.5281/zenodo.4624423

Current Build Statuses

Workflow Status
build.yml GitHub Workflow Status
coverage.yml GitHub Workflow Status
python-publish.yml latest-release
codeql-analysis.yml GitHub issue custom search in repo

Installation

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

pip install epispot

For Anaconda, install via conda-forge as:

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

Start with the tutorials in tests/tutorials (see GitHub repo). Next, check out the documentation at https://epispot.github.io/epispot. You may also find it helpful to see the examples in the tests/examples folder.

Release Notes

See GitHub repo for more info.

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

A Note on Documentation

Documentation can easily be accessed from function, class, and file docstrings. Docstrings 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.


Credits

The epispot package is supported by the following contributors:

Project details


Download files

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

Files for epispot, version 2.1.0
Filename, size File type Python version Upload date Hashes
Filename, size epispot-2.1.0.tar.gz (17.2 kB) File type Source Python version None Upload date Hashes View
Filename, size epispot-2.1.0-py3-none-any.whl (28.9 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page