Merge pull request #1456 from NREL/whole_sfa_mf_models_unit_multiplier

Allow simulating whole SFA/MF buildings

.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   run-unit-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:develop
+      image: docker://nrel/openstudio:3.7.0-rc1
     steps:
       - uses: actions/checkout@v3
         with:
@@ -63,7 +63,7 @@ jobs:
   run-workflow-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:develop
+      image: docker://nrel/openstudio:3.7.0-rc1
     steps:
       - uses: actions/checkout@v3
         with:

BuildResidentialHPXML/README.md

@@ -22,6 +22,17 @@ Absolute/relative path of the HPXML file.
 
 <br/>
 
+**Existing HPXML File Path**
+
+Absolute/relative path of the existing HPXML file. If not provided, a new HPXML file with one Building element is created. If provided, a new Building element will be appended to this HPXML file (e.g., to create a multifamily HPXML file describing multiple dwelling units).
+
+- **Name:** ``existing_hpxml_path``
+- **Type:** ``String``
+
+- **Required:** ``false``
+
+<br/>
+
 **Software Info: Program Used**
 
 The name of the software program used.
@@ -271,6 +282,17 @@ The year the building was built.
 
 <br/>
 
+**Building Construction: Unit Multiplier**
+
+The number of similar dwelling units. EnergyPlus simulation results will be multiplied this value. If not provided, defaults to 1.
+
+- **Name:** ``unit_multiplier``
+- **Type:** ``Integer``
+
+- **Required:** ``false``
+
+<br/>
+
 **Geometry: Unit Type**
 
 The type of dwelling unit. Use single-family attached for a dwelling unit with 1 or more stories, attached units to one or both sides, and no units above/below. Use apartment unit for a dwelling unit with 1 story, attached units to one, two, or three sides, and units above and/or below.

BuildResidentialHPXML/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_hpxml</name>
   <uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
-  <version_id>93c1361d-ce33-4609-ba76-21245e0ee0d7</version_id>
-  <version_modified>2023-10-23T16:23:38Z</version_modified>
+  <version_id>d77dae30-70b5-4522-90fe-fb58f53cc600</version_id>
+  <version_modified>2023-11-01T02:43:51Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -19,6 +19,14 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
     </argument>
+    <argument>
+      <name>existing_hpxml_path</name>
+      <display_name>Existing HPXML File Path</display_name>
+      <description>Absolute/relative path of the existing HPXML file. If not provided, a new HPXML file with one Building element is created. If provided, a new Building element will be appended to this HPXML file (e.g., to create a multifamily HPXML file describing multiple dwelling units).</description>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
     <argument>
       <name>software_info_program_used</name>
       <display_name>Software Info: Program Used</display_name>
@@ -532,6 +540,14 @@
       <required>false</required>
       <model_dependent>false</model_dependent>
     </argument>
+    <argument>
+      <name>unit_multiplier</name>
+      <display_name>Building Construction: Unit Multiplier</display_name>
+      <description>The number of similar dwelling units. EnergyPlus simulation results will be multiplied this value. If not provided, defaults to 1.</description>
+      <type>Integer</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
     <argument>
       <name>geometry_unit_type</name>
       <display_name>Geometry: Unit Type</display_name>
@@ -6735,7 +6751,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>02398DA0</checksum>
+      <checksum>28DA31D7</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -6752,7 +6768,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>D0F900F0</checksum>
+      <checksum>266F1E06</checksum>
     </file>
     <file>
       <filename>geometry.rb</filename>
@@ -6764,7 +6780,7 @@
       <filename>build_residential_hpxml_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>09CBC38A</checksum>
+      <checksum>F24631AD</checksum>
     </file>
   </files>
 </measure>