.. contagion documentation master file, created by
   sphinx-quickstart on Sun Aug 23 20:21:28 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Documentation for contagion
===========================

.. image:: https://readthedocs.org/projects/contagion/badge/?version=latest
    :target: https://contagion.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

contagion is a Python package supporting node immunization and network contagion simulation.


The code can be found on GitHub_.



General Info
============

contagion is designed to be easy-to-use and full-featured, supporting computer scientists, public health researchers, network theorists, and more. Here are a few things we love about contagion:

- accessible interface for incorporating node immunization into contagion simulations
- supports immunization with delayed effect and variable immunity durations
- handles partial immunity and time-varying transmission rates
- can track symptom onset
- implements node testing policies (random, contact tracing)



Table of Contents
=================

.. toctree::
   :maxdepth: 1

   installation
   tutorial
   apiref
   examples
   cite



.. _GitHub: https://github.com/lucasmccabe/contagion