Metadata-Version: 2.1
Name: epispot
Version: 2.1.0
Summary: A tool for modeling infectious diseases.
Home-page: https://www.github.com/epispot/epispot
Author: quantum9innovation
License: UNKNOWN
Description: # ![epispot](https://i.ibb.co/hXMjrCV/epi-spot.png)
        ![latest-release](https://shields.mitmproxy.org/pypi/v/epispot.svg?color=success)
        ![conda](https://anaconda.org/conda-forge/epispot/badges/installer/conda.svg)
        [![Downloads](https://pepy.tech/badge/epispot)](https://pepy.tech/project/epispot)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/quantum9Innovation/epispot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/quantum9Innovation/epispot/context:python)
        [![Total alerts](https://img.shields.io/lgtm/alerts/g/quantum9Innovation/epispot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/quantum9Innovation/epispot/alerts/)
        ![lines of code](https://img.shields.io/tokei/lines/github/epispot/epispot?color=orange)
        ![open-issues](https://img.shields.io/github/issues-raw/epispot/epispot?color=orange)
        ![build-status](https://github.com/epispot/epispot/workflows/build/badge.svg?branch=master)
        <br><br>
        
        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.
        
        <br>
        
        ![epi-spot social image](https://docs.google.com/drawings/d/e/2PACX-1vT6zazkjjnz8UMZz7mxPFXjnvC1Q1HgBLGcNwt0DEqla5N10kC_LPcdbuWae2VBWgCL7kynE8vCTzru/pub?w=1440&h=1080)
        
        ## DOI Information
        **Use epispot's DOI in your research!** :fireworks: 
        <br>
        [![DOI](https://zenodo.org/badge/280527664.svg)](https://zenodo.org/badge/latestdoi/280527664)
        <br><br>
        **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](https://shields.mitmproxy.org/github/workflow/status/epispot/epispot/build?label=build%203.7%2C%203.8%2C%203.9) |
        | `coverage.yml` | ![GitHub Workflow Status](https://shields.mitmproxy.org/github/workflow/status/epispot/epispot/coverage?label=code%20coverage%20reporting) |
        | `python-publish.yml` | ![latest-release](https://shields.mitmproxy.org/pypi/v/epispot.svg?color=success) |
        | `codeql-analysis.yml` | ![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/epispot/epispot?color=success&label=known%20vulnerabilities&query=VULNERABILITY) |
        
        ## Installation
        
        Epispot can be installed via pip or via Anaconda.
        If using pip, install with:
        ```bash
        pip install epispot
        ```
        For Anaconda, install via conda-forge as:
        ```bash
        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:
        ``` bash
        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](https://www.github.com/epispot/epispot/tree/master/tests/tutorials)). 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](https://www.github.com/epispot/epispot/releases) 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:
         - Head of Software & Development: [@quantum9innovation](https://www.github.com/quantum9innovation)
         - Head of Code Maintenance: [@Quantalabs](https://www.github.com/quantalabs)
        
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.7
Description-Content-Type: text/markdown
