Skip to main content

a Python package for node immunization and network contagion simulation

Project description

DOI PyPI version Documentation Status Build Status MIT license

contagion

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

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

Getting Started

Install contagion with pip:

pip install contagion

Once contagion is installed, import NetworkX and contagion:

import networkx
from contagion import contagion

Documentation

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

Citing contagion

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

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.

Thanks for helping make contagion better!

Contact

License

MIT

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

contagion-1.3.3.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

contagion-1.3.3-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file contagion-1.3.3.tar.gz.

File metadata

  • Download URL: contagion-1.3.3.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.3

File hashes

Hashes for contagion-1.3.3.tar.gz
Algorithm Hash digest
SHA256 2e0b496a5be926f8298832dab2d9e695f1b8640fc50f70f83ebdeb871ee771ed
MD5 10daacc6036782ff3b2be357f0e17c0c
BLAKE2b-256 20dd629bf98824869fdfd226a8ade86c7761daf87d1c93afc828420833b6efe7

See more details on using hashes here.

File details

Details for the file contagion-1.3.3-py3-none-any.whl.

File metadata

  • Download URL: contagion-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.3

File hashes

Hashes for contagion-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8b0ba3aa85a4e46e4f1d74aa367da632ea0efe5228ace0796e09a09f6ea57f93
MD5 a6c7c6abe196477d3b480e9a9857d2bd
BLAKE2b-256 1cf642e5d9f1dd10c28daea4adfb3b13c2f7351eaf069162aa3dcfecee2f5dd7

See more details on using hashes here.

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