Skip to content

Commit

Permalink
Update docs and more TODOs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@joseph-robertson
joseph-robertson committed Nov 8, 2024
1 parent 749052f commit a6a733e
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 31 deletions.
10 changes: 5 additions & 5 deletions HPXMLtoOpenStudio/measure.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>hpxm_lto_openstudio</name>
<uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
<version_id>c962d08b-5f5f-428a-a0b3-a3e83db83567</version_id>
<version_modified>2024-11-08T20:35:35Z</version_modified>
<version_id>407c4252-0b8c-449f-8133-fc60cd57b161</version_id>
<version_modified>2024-11-08T21:18:51Z</version_modified>
<xml_checksum>D8922A73</xml_checksum>
<class_name>HPXMLtoOpenStudio</class_name>
<display_name>HPXML to OpenStudio Translator</display_name>
Expand Down Expand Up @@ -363,7 +363,7 @@
<filename>hpxml.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>95FE0EF9</checksum>
<checksum>E1193114</checksum>
</file>
<file>
<filename>hpxml_schema/HPXML.xsd</filename>
Expand Down Expand Up @@ -459,7 +459,7 @@
<filename>output.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>77E045BC</checksum>
<checksum>B41E220C</checksum>
</file>
<file>
<filename>psychrometrics.rb</filename>
Expand Down Expand Up @@ -645,7 +645,7 @@
<filename>xmlhelper.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>C3112FAC</checksum>
<checksum>DA4456A1</checksum>
</file>
<file>
<filename>xmlvalidator.rb</filename>
Expand Down
3 changes: 2 additions & 1 deletion HPXMLtoOpenStudio/resources/hpxml.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9598,7 +9598,8 @@ def to_doc(electric_panel)
if (not @system_idrefs.nil?) && (not @system_idrefs.empty?)
@system_idrefs.each do |system_idref|
system = XMLHelper.add_element(panel_load, 'AttachedToSystem')
XMLHelper.add_attribute(system, 'idref', system_idref, @system_idrefs_isdefaulted)
XMLHelper.add_attribute(system, 'idref', system_idref)
XMLHelper.add_attribute(system, 'dataSource', 'software') if @system_idrefs_isdefaulted
end
end
end
Expand Down
5 changes: 4 additions & 1 deletion HPXMLtoOpenStudio/resources/output.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -993,7 +993,10 @@ def self.get_total_hvac_capacities(hpxml_bldg)
return htg_cap, clg_cap, hp_backup_cap
end

# TODO
# Calculates total panel loads (across all panel loads for a given panel load type) for a given HPXML Building.
#
# @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
# @return [Array<Double * 15>] Total panel load for each panel load type (W)
def self.get_total_panel_loads(hpxml_bldg)
htg, clg, hw, cd, dw, ov, vf, sh, sp, ph, pp, wp, ev, ltg, oth = 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0
unit_multiplier = hpxml_bldg.building_construction.number_of_units
Expand Down
5 changes: 1 addition & 4 deletions HPXMLtoOpenStudio/resources/xmlhelper.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,8 @@ def self.has_element(parent, element_name)
# @param attr_name [String] Name of the attribute
# @param attr_val [*] Value for the attribute
# @return [nil]
def self.add_attribute(element, attr_name, attr_val, defaulted = false)
def self.add_attribute(element, attr_name, attr_val)
element.set(attr_name, attr_val)
if defaulted
XMLHelper.add_attribute(element, 'dataSource', 'software')
end
end

# Gets the value of the specified attribute for the given element.
Expand Down
2 changes: 2 additions & 0 deletions docs/source/workflow_inputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4584,6 +4584,8 @@ A single electric panel can be entered as a ``/HPXML/Building/BuildingDetails/Sy
.. [#] If neither extension/HeadroomBreakerSpaces nor extension/TotalBreakerSpaces provided, the following default value representing a fully occupied electric panel will be used: extension/HeadroomBreakerSpaces = 0.
.. [#] See :ref:`panel_loads`.

See :ref:`annual_outputs` for descriptions of how the calculated capacities and breaker spaces appear in the output files.

.. _panel_loads:

Panel Loads
Expand Down
43 changes: 23 additions & 20 deletions docs/source/workflow_outputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -433,32 +433,35 @@ Panel loads, load-based capacities, and breaker spaces can also be found in the
==================================================== ====================
Type Notes
==================================================== ====================
Electric Panel Load: Heating (W)
Electric Panel Load: Cooling (W)
Electric Panel Load: Hot Water (W)
Electric Panel Load: Clothes Dryer (W)
Electric Panel Load: Dishwasher (W)
Electric Panel Load: Range/Oven (W)
Electric Panel Load: Mech Vent (W)
Electric Panel Load: Permanent Spa Heater (W)
Electric Panel Load: Permanent Spa Pump (W)
Electric Panel Load: Pool Heater (W)
Electric Panel Load: Pool Pump (W)
Electric Panel Load: Well Pump (W)
Electric Panel Load: Electric Vehicle Charging (W)
Electric Panel Load: Lighting (W)
Electric Panel Load: Other (W)
Electric Panel Capacity: Load-Based Total (W) Calculated per 220.83
Electric Panel Load: Heating (W) Sum of heating system and heat pump heating panel loads
Electric Panel Load: Cooling (W) Sum of cooling system and heat pump cooling panel loads
Electric Panel Load: Hot Water (W) Sum of water heating system panel loads
Electric Panel Load: Clothes Dryer (W) Sum of clothes dryer panel loads
Electric Panel Load: Dishwasher (W) Sum of dishwasher panel loads
Electric Panel Load: Range/Oven (W) Sum of range/oven panel loads
Electric Panel Load: Mech Vent (W) Sum of mechanical ventilation panel loads
Electric Panel Load: Permanent Spa Heater (W) Sum of permanent spa heater panel loads
Electric Panel Load: Permanent Spa Pump (W) Sum of permanent spa pump panel loads
Electric Panel Load: Pool Heater (W) Sum of pool heater panel loads
Electric Panel Load: Pool Pump (W) Sum of pool pump panel loads
Electric Panel Load: Well Pump (W) Sum of well pump panel loads
Electric Panel Load: Electric Vehicle Charging (W) Sum of electric vehicle charging panel loads
Electric Panel Load: Lighting (W) Sum of lighting panel loads
Electric Panel Load: Other (W) Sum of other panel loads
Electric Panel Capacity: Load-Based Total (W) Load calculation per NEC 220.83 [#]_
Electric Panel Capacity: Load-Based Total (A) Load-Based Total (W) divided by panel voltage
Electric Panel Capacity: Load-Based Headroom (A) Panel max current rating minus Load-Based Total (A)
Electric Panel Capacity: Meter-Based Total (W) Calculated per 220.87
Electric Panel Capacity: Load-Based Headroom (A) Panel max current rating (A) minus Load-Based Total (A)
Electric Panel Capacity: Meter-Based Total (W) Load calculation per NEC 220.87 [#]_
Electric Panel Capacity: Meter-Based Total (A) Meter-Based Total (W) divided by panel voltage
Electric Panel Capacity: Meter-Based Headroom (A) Panel max current rating minus Meter-Based Total (A)
Electric Panel Capacity: Meter-Based Headroom (A) Panel max current rating (A) minus Meter-Based Total (A)
Electric Panel Breaker Spaces: Total Count (#) Total number of breaker spaces on the panel
Electric Panel Breaker Spaces: Occupied Count (#) Number of occupied breaker spaces on the panel
Electric Panel Breaker Spaces: Headroom Count (#) Number of available breaker spaces on the panel
Electric Panel Breaker Spaces: Headroom Count (#) Total breaker spaces minus occupied breaker spaces
==================================================== ====================

.. [#] Using a load summing method based on Section 220.83 of the 2023 National Electrical Code.
.. [#] Using a maximum demand method based on Section 220.87 of the 2023 National Electrical Code.
.. note::

Headroom is calculated as the panel's maximum current rating (or total breaker spaces) minus calculated capacity (or occupied breaker spaces).
Expand Down

0 comments on commit a6a733e

Please sign in to comment.