Types

vivarium.core.types.CompositeDict

A dictionary that specifies the processes and topology of a composite.

alias of Dict[str, Any]

vivarium.core.types.Flow

Mapping from step names to sequences of HierarchyPaths that specify the step’s dependencies.

alias of Dict[str, Sequence[Tuple[str, …]]]

vivarium.core.types.HierarchyPath

Relative path between nodes in the hierarchy. Like Unix file paths, “..” refers to the parent directory.

alias of Tuple[str, …]

vivarium.core.types.OutputDict

A dictionary that contains the retrieved output of an experiment

alias of Dict[Union[Tuple, str], Any]

vivarium.core.types.Processes

Mapping from processes names to Processes, which can be embedded in a hierarchy.

alias of Dict[str, Any]

vivarium.core.types.Schema

A dictionary that specifies a schema.

alias of Dict[str, Any]

vivarium.core.types.State

A dictionary that has the form of a schema, except instead of specifying the properties of each variable, it specifies each variable’s value.

alias of Dict[str, Any]

vivarium.core.types.Steps

Mapping from step names to Steps, which can be embedded in a hierarchy.

alias of Dict[str, Any]

vivarium.core.types.Topology

Mapping from ports to paths that specify which node in the hierarchy should be wired to each port.

alias of Dict[str, Union[Tuple[str, …], dict, object]]

vivarium.core.types.Update

A dictionary defining an update.

alias of Dict[str, Any]