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

Combine ERI output files #714

Merged
merged 3 commits into from
Feb 19, 2024
Merged

Combine ERI output files #714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ab1c09
Combines ERI_Results.csv and ERI_Worksheet.csv into a single ERI_Resu…
shorowit Feb 9, 2024
1c2dd2c
Fix tests.
shorowit Feb 9, 2024
9b31f3e
Latest results.
Feb 9, 2024
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
1 change: 1 addition & 0 deletions Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ __New Features__
- `ERICalculation/Version` and `CO2IndexCalculation/Version` can now be "2022C" or "2022".
- Allows modeling electric battery storage, including shared batteries ("2022C" or newer).
- The `ElectricAuxiliaryEnergy` input for boilers is no longer used.
- **Breaking change**: ERI_Results.csv and ERI_Worksheet.csv combined into a single ERI_Results.csv that better reflects the current ERI calculation components; additional fields (e.g., PEfrac) added and a few renamed/removed.
- **Breaking change**: Each `VentilationFan` must have one (and only one) `UsedFor...` element set to true.
- Ground source heat pump model enhancements.
- Allows `Roof/RadiantBarrier` to be omitted; defaults to false.
Expand Down
2 changes: 2 additions & 0 deletions docs/source/workflow_inputs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ HPXML Software Info

High-level software inputs are entered in ``/HPXML/SoftwareInfo``.

.. _hpxml_calculations:

HPXML Calculations
******************

Expand Down
142 changes: 110 additions & 32 deletions docs/source/workflow_outputs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. |nbsp| unicode:: 0xA0
:trim:

.. _outputs:

Workflow Outputs
Expand All @@ -22,64 +25,139 @@ All CSV output files can be alternatively requested in JSON format; see :ref:`ru
Summary Outputs (CSV)
---------------------

Based on which calculations were requested in the HPXML file, summary output files will be found in the ``results`` directory.
Based on which :ref:`hpxml_calculations` were requested, summary output files will be found in the ``results`` directory.

================ =============================================== =========
Calculation File Notes
================ =============================================== =========
ERI CO2e_Results.csv See :ref:`co2e_results_csv`. Only produced if 301-2019 Addendum D or newer.
ERI CO2e_Results.csv See :ref:`co2e_results_csv`.
ERI ERI_Results.csv See :ref:`eri_results_csv`.
ERI ERI_Worksheet.csv See :ref:`eri_worksheet_csv`.
IECC ERI Pathway IECC_ERI_Results.csv See :ref:`eri_results_csv` (same format).
IECC ERI Pathway IECC_ERI_Worksheet.csv See :ref:`eri_worksheet_csv` (same format).
IECC ERI Pathway IECC_ERI_Results.csv See :ref:`eri_results_csv`.
ENERGY STAR ES_Results.csv See :ref:`es_results_csv`.
ZERH ZERH_Results.csv See :ref:`zerh_results_csv`.
================ =============================================== =========

.. _co2e_results_csv:

CO2e_Results.csv
~~~~~~~~~~~~~~~~

A ``CO2e_Results.csv`` file will be produced when using ANSI/RESNET/ICC 301-2019 Addendum D or newer.
The file includes all of the outputs that are used in the CO2e Index calculation.
A ``CO2e_Results.csv`` file will be produced when requesting the CO2IndexCalculation; see :ref:`hpxml_calculations`.
Refer to the ANSI 301 Standard for details on how the CO2e Rating Index is calculated.

===================== ===============================================
Output Notes
===================== ===============================================
CO2e Rating Index CO2e Rating Index
ACO2 (lb CO2e) Annual hourly CO2e emissions for Rated Home
ARCO2 (lb CO2e) Annual hourly CO2e emissions for Reference Home
IAF RH Combined Index Adjustment Factor for Rated Home
===================== ===============================================

.. _eri_results_csv:

ERI_Results.csv
~~~~~~~~~~~~~~~

The ``ERI_Results.csv`` file includes the ERI result as well as the high-level components (e.g., REUL, EC_r, EC_x, IAD_Save) that comprise the ERI calculation.
The file reflects the format of the Results tab of the HERS Method Test spreadsheet.

Note that multiple comma-separated values will be reported for many of these outputs if there are multiple heating, cooling, or hot water systems.

.. _eri_worksheet_csv:

ERI_Worksheet.csv
~~~~~~~~~~~~~~~~~

The ``ERI_Worksheet.csv`` file includes more detailed components that feed into the ERI_Results.csv values.
The file reflects the format of the Worksheet tab of the HERS Method Test spreadsheet.

Note that multiple comma-separated values will be reported for many of these outputs if there are multiple heating, cooling, or hot water systems.
A ``ERI_Results.csv`` (and/or ``IECC_ERI_Results.csv``) file will be produced when requesting the ERICalculation (and/or IECCERICalculation); see :ref:`hpxml_calculations`.
Refer to the ANSI 301 Standard for details on how the Energy Rating Index is calculated.

===================== ===============================================
Output Notes
===================== ===============================================
ERI Energy Rating Index
Total Loads TRL Total Reference Loads
Total Loads TnML Total normalized Modified Loads for Rated Home
Total Loads TRL*IAF Total Reference Loads x Index Adjustment Factor for Rated Home
IAD_Save (%) Index Adjustment Design savings
IAF CFA Conditioned Floor Area factor for Index Adjustment Factor
IAF NBR Number of Bedrooms factor for Index Adjustment Factor
IAF NS Number of Stories factor for Index Adjustment Factor
IAF RH Combined Index Adjustment Factor for Rated Home
PEfrac Purchased Energy fraction for Rated Home
TEU (MBtu) Total Energy Use for Rated Home
OPP (MBtu) On-Site Power Production for Rated Home
BSL (MBtu) Battery Storage Losses for Rated Home
|nbsp|
REUL Heating (MBtu) Reference Home End Use Load for Heating [#]_
REUL Cooling (MBtu) Reference Home End Use Load for Cooling
REUL Hot Water (MBtu) Reference Home End Use Load for Hot Water
EC_r Heating (MBtu) Reference Home estimated Energy Consumption for Heating
EC_r Cooling (MBtu) Reference Home estimated Energy Consumption for Cooling
EC_r Hot Water (MBtu) Reference Home estimated Energy Consumption for Hot Water
EC_r L&A (MBtu) Reference Home estimated Energy Consumption for Lights & Appliances
EC_r Vent (MBtu) Reference Home estimated Energy Consumption for Mechanical Ventilation
EC_r Dehumid (MBtu) Reference Home estimated Energy Consumption for Dehumidification
DSE_r Heating Reference Home Distribution System Efficiency for Heating
DSE_r Cooling Reference Home Distribution System Efficiency for Cooling
DSE_r Hot Water Reference Home Distribution System Efficiency for Hot Water
EEC_r Heating Reference Home Equipment Efficiency Coefficient for Heating
EEC_r Cooling Reference Home Equipment Efficiency Coefficient for Cooling
EEC_r Hot Water Reference Home Equipment Efficiency Coefficient for Hot Water
|nbsp|
nMEUL Heating Rated Home normalized Modified End Use Load for Heating
nMEUL Cooling Rated Home normalized Modified End Use Load for Cooling
nMEUL Hot Water Rated Home normalized Modified End Use Load for Hot Water
nMEUL Vent Preheat Rated Home normalized Modified End Use Load for Mechanical Ventilation Preheating
nMEUL Vent Precool Rated Home normalized Modified End Use Load for Mechanical Ventilation Precooling
nEC_x Heating Rated Home normalized Energy Consumption for Heating
nEC_x Cooling Rated Home normalized Energy Consumption for Cooling
nEC_x Hot Water Rated Home normalized Energy Consumption for Hot Water
EC_x Heating (MBtu) Rated Home estimated Energy Consumption for Heating
EC_x Cooling (MBtu) Rated Home estimated Energy Consumption for Cooling
EC_x Hot Water (MBtu) Rated Home estimated Energy Consumption for Hot Water
EC_x L&A (MBtu) Rated Home estimated Energy Consumption for Lights & Appliances
EC_x Vent (MBtu) Rated Home estimated Energy Consumption for Mechanical Ventilation
EC_x Dehumid (MBtu) Rated Home estimated Energy Consumption for Dehumidification
EEC_x Heating Rated Home Equipment Efficiency Coefficient for Heating
EEC_x Cooling Rated Home Equipment Efficiency Coefficient for Cooling
EEC_x Hot Water Rated Home Equipment Efficiency Coefficient for Hot Water
|nbsp|
Coeff Heating a Heating coefficient a for EEC_r
Coeff Heating b Heating coefficient b for EEC_r
Coeff Cooling a Cooling coefficient a for EEC_r
Coeff Cooling b Cooling coefficient b for EEC_r
Coeff Hot Water a Hot Water coefficient a for EEC_r
Coeff Hot Water b Hot Water coefficient a for EEC_r
===================== ===============================================

.. [#] Multiple comma-separated values will be reported for some outputs if there are multiple heating, cooling, or hot water systems.

.. _es_results_csv:

ES_Results.csv
~~~~~~~~~~~~~~

The ``ES_Results.csv`` file includes the following:
A ``ES_Results.csv`` file will be produced when requesting the EnergyStarCalculation; see :ref:`hpxml_calculations`.

=================================== =====
Output Notes
=================================== =====
Reference Home ERI ERI of the ES Reference Home
SAF (Size Adjustment Factor) Can only be less than 1 for some ES programs/versions
SAF Adjusted ERI Target Reference Home ERI multiplied by SAF
Rated Home ERI ERI of the Rated Home including OPP as allowed by the ES program/version
Rated Home ERI w/o OPP ERI of the Rated Home excluding any on-site power production (OPP)
ENERGY STAR Certification PASS or FAIL
=================================== =====
==================================== =====
Output Notes
==================================== =====
Reference Home ERI ERI of the ES Reference Home
SAF (Size Adjustment Factor) Can only be less than 1 for some programs/versions
SAF Adjusted ERI Target Reference Home ERI multiplied by SAF
Rated Home ERI ERI of the Rated Home including OPP as allowed by the program/version
Rated Home ERI w/o OPP ERI of the Rated Home excluding any on-site power production (OPP)
ENERGY STAR Certification PASS or FAIL
==================================== =====

.. _zerh_results_csv:

ZERH_Results.csv
~~~~~~~~~~~~~~~~

A ``ZERH_Results.csv`` file will be produced when requesting the ZERHCalculation; see :ref:`hpxml_calculations`.

==================================== =====
Output Notes
==================================== =====
Reference Home ERI ERI of the ZERH Reference Home
SAF (Size Adjustment Factor) Can only be less than 1 for some programs/versions
SAF Adjusted ERI Target Reference Home ERI multiplied by SAF
Rated Home ERI ERI of the Rated Home including OPP as allowed by the program/version
Rated Home ERI w/o OPP ERI of the Rated Home excluding any on-site power production (OPP)
Zero Energy Ready Home Certification PASS or FAIL
==================================== =====

.. _home_annual_outputs_csv:

Expand Down
Loading