Results

The vivarium_public_health results package provides components for recording public health measures during a simulation. It builds on vivarium’s results management system — which supplies the observer, observation, and stratification machinery — by adding a standardized base observer, a set of ready-to-use concrete observers, and a common stratification component.

Note

A vivarium simulation will not record results by default. The user must define observers that register observations in order to record results!

The package is organized around two cooperating concerns:

1. Observers — a convenience base class (PublicHealthObserver) that wraps the framework’s Observer with a simplified registration method and a standardized results-formatting pipeline, plus a set of ready-to-use concrete observers for common public health measures: disability (YLDs), disease state person-time and transition counts, mortality (deaths and YLLs), and categorical risk-factor person-time. See Public Health Observer.

2. Results stratifier — a single component that registers the default stratifications (age group, sex, current year, event year) shared across observers. See Results Stratifier.