Package modelarium

@PublicApi package modelarium

Provides Modelarium's primary configuration and execution API.

Create an immutable Config with its builder, pass it to a Model, call Model.run(), and then retrieve the completed run through Model.getResults().

Related Packages

Package	Description
modelarium.api	Defines annotations used to identify Modelarium's supported public API.
modelarium.clock	Provides read-only access to simulation time.
modelarium.entities	Defines the agents and environment which make up a Modelarium simulation.
modelarium.exceptions	Defines Modelarium-specific failures for model execution, entity lookup, attribute access, coordination, timeouts, interruption, and missing functional behaviour.
modelarium.multithreading	Implements Modelarium's worker and co-ordinator runtime.
modelarium.scheduler	Provides policies for ordering local agent execution on each tick.
modelarium.utils	Provides small public utility types used by Modelarium extension points.

Class	Description
Config	Record for containing the configuration settings of a model.
Config.ConfigBuilder	Class for assisting in the constructing of a Config record.
Model	Main class for executing an agent-based model using multithreaded execution.