Vivarium Public Health Documentation

NOTE: This repository has been archived.

The vivarium_public_health package has been renamed and migrated into the vivarium-suite monorepo.

What changed

• Import path: vivarium_public_health -> vivarium.public_health

• Source: ihmeuw/vivarium_public_health (archived) -> ihmeuw/vivarium-suite (under libs/public-health/)

To migrate fully to the new package

Install:

pip install vivarium-public-health  # no change here

Import:

import vivarium.public_health  # was: import vivarium_public_health

Original package overview

This library contains several components for for modelling diseases and their interventions.

You can install vivarium_public_health from PyPI with pip:

> pip install vivarium_public_health

or build it from source with

> git clone https://github.com/ihmeuw/vivarium_public_health.git

> cd vivarium_public_health

> python setup.py install

Check out the docs!

Contents:

• Tutorials
  • Disease Models and State Machines
  • Non-standard Risk Exposure and Effect Models
  • Observers
  • Population Structures and Fertility
  • Risk Exposure
  • Risk Effects
  • Treatment
• Concepts
  • Disease
  • Population
  • Results
  • Risk
  • Treatment
• API Reference
  • Utilities
  • EntityString
  • TargetString
  • to_snake_case()
  • to_time_delta()
  • to_years()
  • is_non_zero()
  • Causal Factor Framework
  • Disease Modeling Tools
  • Manager Plugins
  • Population
  • Simulation Observers and Results
  • Risk Modeling Tools
  • Treatment Modeling Tools
• Glossary