Skip to content

Commit

Permalink
Update user guide with new API endpoint.
Browse files Browse the repository at this point in the history
  • Loading branch information
javiarrobas committed Jun 7, 2024
1 parent 3749d5f commit 83bd54d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/user_guide/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,30 @@ GET /kpi
"time_rat":<value> // 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":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to HVAC energy cost in $ or Euro
"emis":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to HVAC energy emissions in kgCO2e
"ener":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to HVAC energy total usage in kWh
"pele":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to HVAC at the overall peak electrical demand in kW
"pgas":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to HVAC at the overall peak gas demand in kW
"pdih":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to HVAC at the overall peak district heating demand in kW
"idis":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to indoor air quality discomfort in ppmh
"tdis":<kpi_ele_name>:<kpi_ele_value>, // dict, Contribution of each element to thermal discomfort in Kh
}

GET /submit
-----------

Expand Down

0 comments on commit 83bd54d

Please sign in to comment.