API Reference

Vivarium Engine

The simulation lifecycle, component model, and runtime for the vivarium microsimulation framework.

Top-level re-exports for common API surface:

• Component: base class for simulation components.

• InteractiveContext: programmatic simulation driver.

• Observer: results-collection component base class.

• build_model_specification: load a model spec from yaml + config.

• Component
• NUM_EVENT_PRIORITIES
• DEFAULT_EVENT_PRIORITY
• Component
• Exceptions
• VivariumError
• Manager
• Manager
• Interface
• Vivarium Testing Utilities
• NonCRNTestPopulation
• TestPopulation
• build_table()
• get_randomness()
• metadata()
• The Vivarium Framework
• Interface