get_event

bamengine.core.registry.get_event(name)

Retrieve an event class from the registry by name.

Parameters:

name (str) – Name of the event to retrieve (snake_case, case-sensitive).

Returns:

The registered event class.

Return type:

type[Event]

Raises:

KeyError – If the event name is not found in the registry. Error message includes list of all available events.

Examples

Retrieve and execute an event:

>>> from bamengine.core.registry import get_event
>>> import bamengine as bam
>>> sim = bam.Simulation.init(n_firms=100, seed=42)
>>> FirmsAdjustPrice = get_event("firms_adjust_price")
>>> event_instance = FirmsAdjustPrice()
>>> event_instance.execute(sim)

Check event availability:

>>> from bamengine.core.registry import list_events
>>> "firms_adjust_price" in list_events()
True

See also

list_events()

Get list of all registered event names

get_role()

Retrieve role class from registry