Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update user guide with new API endpoint. #650

Open
wants to merge 1 commit into
base: gh-pages-custom
Choose a base branch
from
Open

Update user guide with new API endpoint. #650

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/user_guide/source/api.rst
View file
Open in desktop
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