diff --git a/docs/user_guide/source/api.rst b/docs/user_guide/source/api.rst index 7c82ab131..aef2ec744 100644 --- a/docs/user_guide/source/api.rst +++ b/docs/user_guide/source/api.rst @@ -291,6 +291,30 @@ GET /kpi "time_rat": // float, Computational time ratio in s/ss } +GET /kpi_disaggregated +---------------------- + +- **Description:** Receive KPI values disaggregated into contributing components (e.g. each equipment or zone). + The returned results are in absolute values, that is, they are not normalized by floor area or by number of zones. + Calculated from start time and do not include warmup periods. + +- **Arguments:** None. + +- **Returns:** + + :: + + { + "cost"::, // dict, Contribution of each element to HVAC energy cost in $ or Euro + "emis"::, // dict, Contribution of each element to HVAC energy emissions in kgCO2e + "ener"::, // dict, Contribution of each element to HVAC energy total usage in kWh + "pele"::, // dict, Contribution of each element to HVAC at the overall peak electrical demand in kW + "pgas"::, // dict, Contribution of each element to HVAC at the overall peak gas demand in kW + "pdih"::, // dict, Contribution of each element to HVAC at the overall peak district heating demand in kW + "idis"::, // dict, Contribution of each element to indoor air quality discomfort in ppmh + "tdis"::, // dict, Contribution of each element to thermal discomfort in Kh + } + GET /submit -----------