Manager

A base Manager class to be used to create manager for use in vivarium simulations.

class vivarium.engine.manager.Manager

CONFIGURATION_DEFAULTS: dict[str, Any] = {}

A dictionary containing the defaults for any configurations managed by this manager. An empty dictionary indicates no managed configurations.

abstract property name: str

property configuration_defaults: dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this manager.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

setup_manager(builder)

Sets up the manager for a Vivarium simulation.

This method is run by Vivarium during the setup phase. It performs a series of operations to prepare the manager for the simulation.

It sets up the manager, sets the population view, and registers various listeners including post_setup, simulant_initializer, time_step__prepare, time_step, time_step__cleanup, collect_metrics, and simulation_end listeners.

Return type:

None

Parameters:

builder (Builder) – The builder object used to set up the manager.

setup(builder)

Defines custom actions this manager needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the manager. By default, it does nothing.

Return type:

None

Parameters:

builder (Builder) – The builder object used to set up the manager.

class vivarium.engine.manager.Interface

An interface class to be used to manage different systems for a simulation in vivarium