vivarium
latest
  • Installing Vivarium
  • Tutorials
  • Concepts
  • 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
        • The Population Management System
        • Population Management Exceptions
        • PopulationError
        • The Population Manager
        • SimulantData
        • InitializerComponentSet
        • PopulationManager
        • PopulationInterface
        • The Population View
        • PopulationView
      • Random Number Generation
    • Interface
  • Glossary
vivarium
  • API Reference
  • The Vivarium Framework
  • Population Management
  • Edit on GitHub

Population Management

The Population Management System

This subpackage provides tools for managing the state table in a vivarium simulation, which is the record of all simulants in a simulation and their state. Its main tasks are managing the creation of new simulants and providing the ability for components to view and update simulant state safely during runtime.

  • Population Management Exceptions
  • PopulationError
  • The Population Manager
  • SimulantData
    • SimulantData.index
    • SimulantData.user_data
    • SimulantData.creation_time
    • SimulantData.creation_window
  • InitializerComponentSet
    • InitializerComponentSet.add()
  • PopulationManager
    • PopulationManager.configuration_defaults
    • PopulationManager.name
    • PopulationManager.setup()
    • PopulationManager.on_initialize_simulants()
    • PopulationManager.columns
    • PopulationManager.get_view()
    • PopulationManager.register_simulant_initializer()
    • PopulationManager.get_simulant_creator()
    • PopulationManager.get_population()
  • PopulationInterface
    • PopulationInterface.get_view()
    • PopulationInterface.get_simulant_creator()
    • PopulationInterface.initializes_simulants()
  • The Population View
  • PopulationView
    • PopulationView.name
    • PopulationView.columns
    • PopulationView.query
    • PopulationView.subview()
    • PopulationView.get()
    • PopulationView.update()
Previous Next

© Copyright 2021, The vivarium developers. Revision a78d223a.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
develop
Downloads
On Read the Docs
Project Home
Builds