contagion

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

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

• Table of Contents
• Getting Started
• Documentation
• Example Usage
• Contributing to contagion
• Contact
• Citing contagion
• Requirements
• License

Getting Started

Install contagion with pip:

pip install contagion

Documentation

Official documentation - including a tutorial, API reference, and a few worked examples - is available on Read the Docs.

Requirements

This project was created with:

• matplotlib==3.3.3
• numpy==1.19.3
• networkx==2.5
• scipy>=1.5.0
• seaborn==0.11.1

Contributing to contagion

We'd love your help! If you'd like to make an addition or improvement, please submit a pull request consisting of an atomic commit and a brief message describing your contribution. If you find something wrong, please submit a bug report to the issue tracker. For other questions or comments, feel free to contact me directly.

Contact

• Lucas Hurley McCabe (email)

Citing contagion

If you find contagion useful in your work, please use the Zenodo software citation:

@software{lucas_mccabe_2021_4456181,
  author       = {Lucas McCabe},
  title        = {lucasmccabe/contagion: v1.3.3},
  month        = jan,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {v1.3.3},
  doi          = {10.5281/zenodo.4456181},
  url          = {https://doi.org/10.5281/zenodo.4456181}
}

License

MIT