vivarium.engine Documentation

vivarium-engine is the simulation lifecycle, component model, and runtime for the vivarium microsimulation framework. It is the core of the vivarium-suite monorepo, alongside sibling libs such as vivarium-public-health and vivarium-cluster-tools.

Vivarium itself is a framework for building complex simulations using standard scientific Python tools.

• Installing vivarium-engine
  • Overview
  • Installation from PyPI
  • Installation from source
• Tutorials
  • Boids
  • Disease Model
  • Exploring a Simulation in an Interactive Setting
  • Getting Started
  • Running a Simulation
• Concepts
  • The Builder
  • What is a Component?
  • The Configuration System
  • Common Random Numbers
  • Data in the Simulation
  • Simulation Entry Points
  • The Event System
  • Interpolating Data
  • The Simulation Lifecycle
  • Framework Logging
  • Lookup Tables
  • Population Management
  • Resource Management
  • Results Management
  • Thinking about Time in the Simulation
  • The Values System
  • The Model Specification
• API Reference
  • Component
  • DEFAULT_EVENT_PRIORITY
  • Component
  • Exceptions
  • VivariumError
  • Manager
  • Manager
  • Interface
  • Vivarium Testing Utilities
  • NonCRNTestPopulation
  • TestPopulation
  • build_table()
  • get_randomness()
  • metadata()
  • The Vivarium Framework
  • Interface
• Glossary