register_daily_callback

passengersim.callbacks.register_daily_callback(callback: collections.abc.Callable[[CallbackMixin, int], dict | None] | GenericTracer | RmSys)

Register a function to be triggered each day during a sample.

The callback function will be triggered after all RM steps when the day coincides with a DCP.

Parameters:
callback : Callable[[Simulation, int], dict | None]

The callback function to register. It should accept two arguments, which will be the Simulation object and the days_prior, and return None.