Skip to content

Commit 8a67878

Browse files
joseph-robertsonjoseph-robertson
committed
Merge branch 'ruby-docs' of github.com:NREL/OpenStudio-HPXML into ruby-docs
2 parents 9a3cfe0 + 7415ef0 commit 8a67878

20 files changed

Lines changed: 1219 additions & 1179 deletions

‎Changelog.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ __New Features__
99
- Maximum power ratio detailed schedule for variable-speed HVAC systems can now be used with `NumberofUnits` dwelling unit multiplier.
1010

1111
__Bugfixes__
12-
- Allows additional flexibility for multiple `Attic`/`Foundation` elements.
12+
- Prevents possible error when using multiple `Attic`/`Foundation` elements for the same attic/foundation type.
13+
- Adds error-checking for `NumberofConditionedFloorsAboveGrade`=0, which is not allowed per the documentation.
1314

1415
## OpenStudio-HPXML v1.8.1
1516

‎HPXMLtoOpenStudio/measure.rb‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ def make_variable_name(obj_name, unit_number)
477477
# @param schedules_file [TODO] TODO
478478
# @param eri_version [TODO] TODO
479479
# @param unit_num [TODO] TODO
480-
# @return nil
480+
# @return [void]
481481
def create_unit_model(hpxml, hpxml_bldg, runner, model, epw_path, epw_file, weather, debug, schedules_file, eri_version, unit_num)
482482
@hpxml_header = hpxml.header
483483
@hpxml_bldg = hpxml_bldg
@@ -690,7 +690,7 @@ def create_or_get_space(model, spaces, location)
690690
# @param runner [OpenStudio::Measure::OSRunner] OpenStudio Runner object
691691
# @param model [OpenStudio::Model::Model] OpenStudio Model object
692692
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
693-
# @return nil
693+
# @return [void]
694694
def add_roofs(runner, model, spaces)
695695
@hpxml_bldg.roofs.each do |roof|
696696
next if roof.net_area < 1.0 # skip modeling net surface area for surfaces comprised entirely of subsurface area
@@ -808,7 +808,7 @@ def add_roofs(runner, model, spaces)
808808
# @param runner [OpenStudio::Measure::OSRunner] OpenStudio Runner object
809809
# @param model [OpenStudio::Model::Model] OpenStudio Model object
810810
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
811-
# @return nil
811+
# @return [void]
812812
def add_walls(runner, model, spaces)
813813
@hpxml_bldg.walls.each do |wall|
814814
next if wall.net_area < 1.0 # skip modeling net surface area for surfaces comprised entirely of subsurface area
@@ -886,7 +886,7 @@ def add_walls(runner, model, spaces)
886886
# @param runner [OpenStudio::Measure::OSRunner] OpenStudio Runner object
887887
# @param model [OpenStudio::Model::Model] OpenStudio Model object
888888
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
889-
# @return nil
889+
# @return [void]
890890
def add_rim_joists(runner, model, spaces)
891891
@hpxml_bldg.rim_joists.each do |rim_joist|
892892
if rim_joist.azimuth.nil?
@@ -964,7 +964,7 @@ def add_rim_joists(runner, model, spaces)
964964
# @param runner [OpenStudio::Measure::OSRunner] OpenStudio Runner object
965965
# @param model [OpenStudio::Model::Model] OpenStudio Model object
966966
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
967-
# @return nil
967+
# @return [void]
968968
def add_floors(runner, model, spaces)
969969
@hpxml_bldg.floors.each do |floor|
970970
next if floor.net_area < 1.0 # skip modeling net surface area for surfaces comprised entirely of subsurface area
@@ -1446,7 +1446,7 @@ def add_thermal_mass(model, spaces)
14461446
#
14471447
# @param model [OpenStudio::Model::Model] OpenStudio Model object
14481448
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
1449-
# @return nil
1449+
# @return [void]
14501450
def add_windows(model, spaces)
14511451
# We already stored @fraction_of_windows_operable, so lets remove the
14521452
# fraction_operable properties from windows and re-collapse the enclosure
@@ -1549,7 +1549,7 @@ def add_windows(model, spaces)
15491549
#
15501550
# @param model [OpenStudio::Model::Model] OpenStudio Model object
15511551
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
1552-
# @return nil
1552+
# @return [void]
15531553
def add_skylights(model, spaces)
15541554
surfaces = []
15551555
shading_schedules = {}
@@ -1652,7 +1652,7 @@ def add_skylights(model, spaces)
16521652
#
16531653
# @param model [OpenStudio::Model::Model] OpenStudio Model object
16541654
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
1655-
# @return nil
1655+
# @return [void]
16561656
def add_doors(model, spaces)
16571657
surfaces = []
16581658
@hpxml_bldg.doors.each do |door|

‎HPXMLtoOpenStudio/measure.xml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<schema_version>3.1</schema_version>
44
<name>hpxm_lto_openstudio</name>
55
<uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
6-
<version_id>002799b9-302c-4728-bdf1-b78246132f8d</version_id>
7-
<version_modified>2024-06-20T23:43:31Z</version_modified>
6+
<version_id>25e34fab-7635-4389-9100-1ab76dc7ad1d</version_id>
7+
<version_modified>2024-06-20T23:44:37Z</version_modified>
88
<xml_checksum>D8922A73</xml_checksum>
99
<class_name>HPXMLtoOpenStudio</class_name>
1010
<display_name>HPXML to OpenStudio Translator</display_name>
@@ -183,7 +183,7 @@
183183
<filename>measure.rb</filename>
184184
<filetype>rb</filetype>
185185
<usage_type>script</usage_type>
186-
<checksum>5D3303BF</checksum>
186+
<checksum>4BE710AB</checksum>
187187
</file>
188188
<file>
189189
<filename>airflow.rb</filename>
@@ -333,7 +333,7 @@
333333
<filename>geometry.rb</filename>
334334
<filetype>rb</filetype>
335335
<usage_type>resource</usage_type>
336-
<checksum>39101C7C</checksum>
336+
<checksum>CDF82DF7</checksum>
337337
</file>
338338
<file>
339339
<filename>hotwater_appliances.rb</filename>
@@ -351,7 +351,7 @@
351351
<filename>hpxml_defaults.rb</filename>
352352
<filetype>rb</filetype>
353353
<usage_type>resource</usage_type>
354-
<checksum>7B573ECF</checksum>
354+
<checksum>FA727ECC</checksum>
355355
</file>
356356
<file>
357357
<filename>hpxml_schema/HPXML.xsd</filename>
@@ -369,7 +369,7 @@
369369
<filename>hpxml_schematron/EPvalidator.xml</filename>
370370
<filetype>xml</filetype>
371371
<usage_type>resource</usage_type>
372-
<checksum>E9004049</checksum>
372+
<checksum>AE34574D</checksum>
373373
</file>
374374
<file>
375375
<filename>hpxml_schematron/iso-schematron.xsd</filename>
@@ -381,13 +381,13 @@
381381
<filename>hvac.rb</filename>
382382
<filetype>rb</filetype>
383383
<usage_type>resource</usage_type>
384-
<checksum>9931AEE6</checksum>
384+
<checksum>DBD9E002</checksum>
385385
</file>
386386
<file>
387387
<filename>hvac_sizing.rb</filename>
388388
<filetype>rb</filetype>
389389
<usage_type>resource</usage_type>
390-
<checksum>71FED9DF</checksum>
390+
<checksum>1E606DE3</checksum>
391391
</file>
392392
<file>
393393
<filename>lighting.rb</filename>
@@ -573,7 +573,7 @@
573573
<filename>simcontrols.rb</filename>
574574
<filetype>rb</filetype>
575575
<usage_type>resource</usage_type>
576-
<checksum>6239E428</checksum>
576+
<checksum>24E3F0EE</checksum>
577577
</file>
578578
<file>
579579
<filename>unit_conversions.rb</filename>
@@ -639,7 +639,7 @@
639639
<filename>test_defaults.rb</filename>
640640
<filetype>rb</filetype>
641641
<usage_type>test</usage_type>
642-
<checksum>EF2DA229</checksum>
642+
<checksum>B645C92F</checksum>
643643
</file>
644644
<file>
645645
<filename>test_enclosure.rb</filename>
@@ -711,7 +711,7 @@
711711
<filename>test_validation.rb</filename>
712712
<filetype>rb</filetype>
713713
<usage_type>test</usage_type>
714-
<checksum>32DEB854</checksum>
714+
<checksum>EE974D71</checksum>
715715
</file>
716716
<file>
717717
<filename>test_water_heater.rb</filename>

‎HPXMLtoOpenStudio/resources/geometry.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ def self.set_zone_volumes(spaces:,
346346
# @param model [OpenStudio::Model::Model] OpenStudio Model object
347347
# @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
348348
# @param walls_top [Double] the total height of the dwelling unit
349-
# @return nil
349+
# @return [void]
350350
def self.explode_surfaces(model:,
351351
hpxml_bldg:,
352352
walls_top:)

0 commit comments

Comments
 (0)