Output Metrics

Currently, vivarium uses the values pipeline system to produce the results, or output metrics, from a simulation. The metrics The component here is a normal vivarium component whose only purpose is to provide an empty dict as the source of the “Metrics” pipeline. It is included by default in all simulations.

class vivarium.framework.metrics.Metrics

This class declares a value pipeline that allows other components to store summary metrics.

setup(builder)

Defines custom actions this component 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 component. By default, it does nothing.

Parameters:

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

Return type:

None