API Reference

• The Config Tree
• ConfigurationError
• ConfigurationKeyError
• DuplicatedConfigurationError
  • DuplicatedConfigurationError.layer
  • DuplicatedConfigurationError.source
  • DuplicatedConfigurationError.value
• ConfigNode
  • ConfigNode.name
  • ConfigNode.accessed
  • ConfigNode.metadata
  • ConfigNode.freeze()
  • ConfigNode.get_value()
  • ConfigNode.update()
• ConfigTree
  • ConfigTree.freeze()
  • ConfigTree.items()
  • ConfigTree.keys()
  • ConfigTree.values()
  • ConfigTree.unused_keys()
  • ConfigTree.to_dict()
  • ConfigTree.get_from_layer()
  • ConfigTree.update()
  • ConfigTree.metadata()
• Exceptions
• VivariumError
• Interpolation
• Interpolation
  • Interpolation.data
  • Interpolation.categorical_parameters
  • Interpolation.continuous_parameters
  • Interpolation.order
• validate_parameters()
• validate_call_data()
• check_data_complete()
• Order0Interp
  • Order0Interp.data
  • Order0Interp.parameter_columns
• Vivarium Testing Utilities
• NonCRNTestPopulation
  • NonCRNTestPopulation.configuration_defaults
  • NonCRNTestPopulation.name
  • NonCRNTestPopulation.setup()
  • NonCRNTestPopulation.generate_test_population()
  • NonCRNTestPopulation.age_simulants()
• TestPopulation
  • TestPopulation.name
  • TestPopulation.setup()
  • TestPopulation.generate_test_population()
• 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
  • Vivarium Command Line Tools
  • Vivarium Interactive Tools
  • InteractiveContext
  • Interface Utility Functions
  • run_from_ipython()
  • log_progress()
  • InteractiveError
  • raise_if_not_setup()
  • get_output_model_name_string()
  • get_output_root()