Microgrid.get_log

Microgrid.get_log(as_frame=True, drop_singleton_key=False, drop_forecasts=False)

Collect a log of controls and responses of the microgrid.

Parameters

as_framebool, default True

Whether to return the log as a pd.DataFrame. If False, returns a nested dict.

drop_singleton_keybool, default False

Whether to drop index level enumerating the modules by name if each module name has only one module. Ignored otherwise.

drop_forecastsbool, default False

Whether to drop columns that are of time series forecasts.

Returns

pd.DataFrame or dict