API Reference
- The Config Tree
ConfigurationError
ConfigurationKeyError
DuplicatedConfigurationError
ConfigNode
ConfigTree
- Exceptions
VivariumError
- Interpolation
Interpolation
validate_parameters()
validate_call_data()
check_data_complete()
Order0Interp
- Vivarium Testing Utilities
NonCRNTestPopulation
TestPopulation
build_table()
make_dummy_column()
get_randomness()
reset_mocks()
metadata()
- The Vivarium Framework
- Configuration Utilities
build_model_specification()
validate_model_specification_file()
build_simulation_configuration()
- The Vivarium Engine
SimulationContext
Builder
run_simulation()
- The Vivarium Event Framework
Event
EventChannel
EventManager
EventInterface
- Life Cycle Management
LifeCycleError
InvalidTransitionError
ConstraintError
LifeCycleState
LifeCyclePhase
LifeCycle
ConstraintMaker
LifeCycleManager
LifeCycleInterface
- Lookup Tables
InterpolatedTable
ScalarTable
LookupTable
validate_parameters()
LookupTableManager
LookupTableInterface
- Output Metrics
Metrics
- The Plugin Management System
PluginConfigurationError
PluginManager
- Resource Management
ResourceError
ResourceGroup
ResourceManager
ResourceInterface
- State Machine
Trigger
Transition
State
Transient
TransientState
TransitionSet
Machine
- The Simulation Clock
SimulationClock
SimpleClock
get_time_stamp()
DateTimeClock
TimeInterface
- Framework Utility Functions
from_yearly()
to_yearly()
rate_to_probability()
probability_to_rate()
collapse_nested_dict()
import_by_path()
handle_exceptions()
- The Value Pipeline System
DynamicValueError
replace_combiner()
list_combiner()
rescale_post_processor()
union_post_processor()
Pipeline
ValuesManager
ValuesInterface
- Data Artifact Management
- Component Management
- Logging
- The Logging Subsystem
LoggingManager
LoggingInterface
- Logging Utilities
configure_logging_to_terminal()
configure_logging_to_file()
list_loggers()
- Population Management
- Random Number Generation
- Interface