pearl.engine

Core Engine for the PEARL model. Defines the base structure for the model and the main run function.

Classes

Event(parameters)	Abstract class for the core function of the PEARL model.
EventGrouping([iterable])
Pearl(parameters, population_generator, events)	Base Structure for all PEARL models.

class pearl.engine.Event(parameters: Parameters)

Bases: ABC

Abstract class for the core function of the PEARL model.

class pearl.engine.EventGrouping(iterable=(), /)

Bases: list

class pearl.engine.Pearl(parameters: Parameters, population_generator: Event | EventGrouping | Callable[[pandas.DataFrame], pandas.DataFrame], events: Event | EventGrouping | Callable[[pandas.DataFrame], pandas.DataFrame], before_run_events: Event | EventGrouping | Callable[[pandas.DataFrame], pandas.DataFrame] | None = None, after_run_events: Event | EventGrouping | Callable[[pandas.DataFrame], pandas.DataFrame] | None = None)

Bases: object

Base Structure for all PEARL models.

run() → None

Run the pearl model for the number of years defined by the start and final year parameters.