citylearn.internal.kpi_equipment module

Equipment KPI calculations and per-evaluation aggregation.

Each accumulator belongs to one evaluate() call. EV counts, BESS capacities and phase samples retain their own denominators; district ratios are never averages of per-member ratios.

class citylearn.internal.kpi_equipment.EquipmentKPIAccumulator(kpi: CityLearnKPIService)[source]

Bases: object

building_records(building, t_start, t_end, *, progress=None)[source]

district_records(kpi_buildings, building_windows, simulated_days)[source]

citylearn.internal.kpi_equipment.compute_bess_metrics(kpi, building, *, t_start: int = 0, t_final: int | None = None) → Dict[str, float][source]

citylearn.internal.kpi_equipment.compute_district_pv_metrics(kpi, buildings: Sequence, building_windows: Mapping[str, Tuple[int, int]], *, final_t: int) → Dict[str, float][source]

citylearn.internal.kpi_equipment.compute_phase_metrics(kpi, building, *, t_start: int = 0, t_final: int | None = None) → Dict[str, object][source]

citylearn.internal.kpi_equipment.compute_pv_metrics(kpi, building, *, t_start: int = 0, t_final: int | None = None) → Dict[str, float][source]