urbanopt-cli 0.5.1 → 0.5.2

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>hpxm_lto_openstudio</name>
   <uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
-  <version_id>d8a65282-212d-45ec-9233-6967bef4042f</version_id>
-  <version_modified>20201210T202958Z</version_modified>
+  <version_id>7266ea6e-ed3a-43e7-a608-e73f3c14757f</version_id>
+  <version_modified>20210325T174426Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -24,13 +24,32 @@
       <display_name>Directory for Output Files</display_name>
       <description>Absolute/relative path for the output files directory.</description>
       <type>String</type>
-      <required>false</required>
+      <required>true</required>
       <model_dependent>false</model_dependent>
     </argument>
     <argument>
       <name>debug</name>
       <display_name>Debug Mode?</display_name>
-      <description>If enabled: 1) Writes in.osm file, 2) Writes in.xml HPXML file with defaults populated, 3) Generates additional log output, and 4) Creates all EnergyPlus output files. Any files written will be in the output path specified above.</description>
+      <description>If true: 1) Writes in.osm file, 2) Generates additional log output, and 3) Creates all EnergyPlus output files.</description>
+      <type>Boolean</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>false</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
+    <argument>
+      <name>skip_validation</name>
+      <display_name>Skip Validation?</display_name>
+      <description>If true, bypasses HPXML input validation for faster performance. WARNING: This should only be used if the supplied HPXML file has already been validated against the Schema &amp; Schematron documents.</description>
       <type>Boolean</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -46,6 +65,14 @@
         </choice>
       </choices>
     </argument>
+    <argument>
+      <name>building_id</name>
+      <display_name>BuildingID</display_name>
+      <description>The ID of the HPXML Building. Only required if there are multiple Building elements in the HPXML file.</description>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
   </arguments>
   <outputs />
   <provenances />
@@ -87,18 +114,6 @@
       <usage_type>resource</usage_type>
       <checksum>38ED685E</checksum>
     </file>
-    <file>
-      <filename>unit_conversions.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>6F263948</checksum>
-    </file>
-    <file>
-      <filename>unit_conversions.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>6F263948</checksum>
-    </file>
     <file>
       <filename>util.rb</filename>
       <filetype>rb</filetype>
@@ -268,232 +283,244 @@
       <checksum>00BB7C11</checksum>
     </file>
     <file>
-      <filename>test_miscloads.rb</filename>
+      <filename>validator.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>8FFE4973</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>7039FF35</checksum>
     </file>
     <file>
-      <filename>test_lighting.rb</filename>
+      <filename>test_hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>F42143F8</checksum>
+      <checksum>35C3F156</checksum>
     </file>
     <file>
-      <filename>meta_measure.rb</filename>
+      <filename>simcontrols.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>0C040490</checksum>
+      <checksum>77520F9B</checksum>
     </file>
     <file>
-      <filename>test_constructions.rb</filename>
+      <filename>unit_conversions.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>5E866DCA</checksum>
+    </file>
+    <file>
+      <filename>test_miscloads.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>1DEAF026</checksum>
+      <checksum>CAB25584</checksum>
     </file>
     <file>
-      <filename>constructions.rb</filename>
+      <filename>test_lighting.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>BA0409DC</checksum>
+      <usage_type>test</usage_type>
+      <checksum>4E79FEBB</checksum>
     </file>
     <file>
-      <filename>BaseElements.xsd</filename>
-      <filetype>xsd</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>B7D212FC</checksum>
+      <filename>test_location.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E35FFC5D</checksum>
     </file>
     <file>
-      <filename>HPXMLDataTypes.xsd</filename>
-      <filetype>xsd</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>C13E66F3</checksum>
+      <filename>test_simcontrols.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>4548B844</checksum>
     </file>
     <file>
-      <filename>validator.rb</filename>
+      <filename>test_pv.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>7039FF35</checksum>
+      <usage_type>test</usage_type>
+      <checksum>CCE7EC8C</checksum>
     </file>
     <file>
-      <filename>test_validation.rb</filename>
+      <filename>test_water_heater.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>DF4C6299</checksum>
+      <checksum>468A0868</checksum>
     </file>
     <file>
-      <filename>version.rb</filename>
+      <filename>test_generator.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>A1532F79</checksum>
+      <usage_type>test</usage_type>
+      <checksum>F67DB8C9</checksum>
     </file>
     <file>
-      <filename>hvac_sizing.rb</filename>
+      <filename>test_constructions.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>51B1E37F</checksum>
+      <usage_type>test</usage_type>
+      <checksum>106158AA</checksum>
     </file>
     <file>
-      <filename>test_hvac_sizing.rb</filename>
+      <filename>test_airflow.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>35C3F156</checksum>
+      <checksum>E6A57DCD</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>E4CE9FD0</checksum>
+      <checksum>5C04ADBE</checksum>
     </file>
     <file>
-      <filename>waterheater.rb</filename>
-      <filetype>rb</filetype>
+      <filename>HPXMLDataTypes.xsd</filename>
+      <filetype>xsd</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8CC67A4B</checksum>
+      <checksum>09DB4799</checksum>
     </file>
     <file>
-      <filename>simcontrols.rb</filename>
-      <filetype>rb</filetype>
+      <filename>BaseElements.xsd</filename>
+      <filetype>xsd</filetype>
       <usage_type>resource</usage_type>
-      <checksum>1164C9B8</checksum>
+      <checksum>5894425E</checksum>
     </file>
     <file>
-      <filename>test_location.rb</filename>
+      <filename>test_hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>983025AE</checksum>
+      <checksum>558ED24D</checksum>
     </file>
     <file>
-      <filename>test_simcontrols.rb</filename>
+      <filename>version.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>5CEBAA1B</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>4F621F55</checksum>
     </file>
     <file>
       <filename>location.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>CFF8A021</checksum>
+      <checksum>CB27A3C5</checksum>
     </file>
     <file>
-      <filename>xmlhelper.rb</filename>
+      <filename>generator.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>1932CF82</checksum>
+      <checksum>8094AEAC</checksum>
     </file>
     <file>
-      <filename>HPXMLvalidator.xml</filename>
-      <filetype>xml</filetype>
+      <filename>pv.rb</filename>
+      <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7FDAF453</checksum>
+      <checksum>120417ED</checksum>
     </file>
     <file>
       <filename>test_hotwater_appliance.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>A751054A</checksum>
+      <checksum>9911B5A5</checksum>
     </file>
     <file>
-      <filename>test_hvac.rb</filename>
+      <filename>waterheater.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>ABFAA1F9</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>C696219C</checksum>
     </file>
     <file>
-      <filename>test_airflow.rb</filename>
+      <filename>constructions.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>B065BC98</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>4FD58D3F</checksum>
     </file>
     <file>
-      <filename>test_pv.rb</filename>
+      <filename>test_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>6EBE898A</checksum>
+      <checksum>21C7F17E</checksum>
     </file>
     <file>
-      <filename>test_water_heater.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>00FF316C</checksum>
+      <filename>HPXMLvalidator.xml</filename>
+      <filetype>xml</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>BCC4746A</checksum>
     </file>
     <file>
-      <filename>pv.rb</filename>
+      <filename>hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>DF137AA1</checksum>
+      <checksum>53FE554B</checksum>
     </file>
     <file>
-      <filename>test_generator.rb</filename>
+      <filename>test_validation.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>223C82A9</checksum>
+      <checksum>012DB13A</checksum>
     </file>
     <file>
-      <filename>generator.rb</filename>
+      <filename>EPvalidator.xml</filename>
+      <filetype>xml</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>D0C1F54C</checksum>
+    </file>
+    <file>
+      <filename>weather.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>EC9E575F</checksum>
+      <checksum>AC14851E</checksum>
     </file>
     <file>
-      <filename>test_defaults.rb</filename>
+      <filename>lighting.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>2040ABBC</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>5507213C</checksum>
     </file>
     <file>
-      <filename>EPvalidator.xml</filename>
-      <filetype>xml</filetype>
+      <filename>misc_loads.rb</filename>
+      <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>2129504F</checksum>
+      <checksum>4FB83469</checksum>
     </file>
     <file>
-      <filename>weather.rb</filename>
+      <filename>meta_measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>AC14851E</checksum>
+      <checksum>5523EAA1</checksum>
     </file>
     <file>
       <filename>geometry.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>6B904FD9</checksum>
+      <checksum>E5B56D54</checksum>
     </file>
     <file>
       <filename>airflow.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>C58C7B84</checksum>
+      <checksum>4A23F2F5</checksum>
     </file>
     <file>
-      <filename>hotwater_appliances.rb</filename>
+      <filename>xmlhelper.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>9F302346</checksum>
+      <checksum>EEAB4FC6</checksum>
     </file>
     <file>
-      <filename>lighting.rb</filename>
+      <filename>hotwater_appliances.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>FD083F5C</checksum>
+      <checksum>EF9BC498</checksum>
     </file>
     <file>
-      <filename>schedules.rb</filename>
+      <filename>hpxml_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>C714CC53</checksum>
+      <checksum>F38F9875</checksum>
     </file>
     <file>
-      <filename>misc_loads.rb</filename>
+      <filename>hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>77F89B51</checksum>
+      <checksum>0021C3D6</checksum>
     </file>
     <file>
       <filename>hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7FAEF245</checksum>
+      <checksum>376EE0A8</checksum>
     </file>
     <file>
       <version>
@@ -504,19 +531,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>D6647EEC</checksum>
+      <checksum>AB6B67F1</checksum>
     </file>
     <file>
-      <filename>hpxml_defaults.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>4AD8B2E6</checksum>
-    </file>
-    <file>
-      <filename>hpxml.rb</filename>
+      <filename>schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>CED559D7</checksum>
+      <checksum>D76F0C2B</checksum>
     </file>
   </files>
 </measure>

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/BaseElements.xsd

@@ -449,7 +449,7 @@
 							<xs:documentation>Portable room dehumidifiers are typically used to dehumidify a single room or space and can be easily moved to where they are needed. Whole-home dehumidifiers are typically installed to use your home’s air ducts to dehumidify one or more rooms and are often permanent. Some dehumifiers can operate in both configurations by means of a ducting kit.</xs:documentation>
 						</xs:annotation>
 					</xs:element>
-					<xs:element minOccurs="0" name="Location" type="DehumidifierLocation"/>
+					<xs:element minOccurs="0" name="Location" type="AdjacentTo"/>
 					<xs:element minOccurs="0" name="Efficiency" type="HPXMLDouble">
 						<xs:annotation>
 							<xs:documentation>[L/kWh] DEPRECATED. This will be removed in v4.0. Use EnergyFactor or IntegratedEnergyFactor instead.</xs:documentation>
@@ -1273,7 +1273,6 @@
 											<xs:choice>
 												<xs:element name="AirDistribution" type="AirDistributionInfo"/>
 												<xs:element name="HydronicDistribution" type="HydronicDistributionInfo"/>
-												<xs:element name="HydronicAndAirDistribution" type="HydronicAndAirDistributionInfo"/>
 												<xs:element name="Other" type="HPXMLString">
 													<xs:annotation>
 														<xs:documentation>describe</xs:documentation>
@@ -1288,18 +1287,14 @@
 											<xs:documentation>[sq.ft.] Conditioned floor area that this distribution system serves.</xs:documentation>
 										</xs:annotation>
 									</xs:element>
-									<xs:element minOccurs="0" name="AnnualHeatingDistributionSystemEfficiency" type="HPXMLDouble">
+									<xs:element minOccurs="0" name="AnnualHeatingDistributionSystemEfficiency" type="Fraction">
 										<xs:annotation>
-											<xs:documentation>For software that does not calculate an annual distribution system efficiency (DSE) for heating, the DSE may be approximated by equation
-												3.4.i in ANSI/BPI-2400-S-2012: Standard Practice for Standardized Qualification of Whole-House Energy Savings, Predictions by Calibration to Energy Use
-												History.</xs:documentation>
+											<xs:documentation>For software that does not calculate an annual distribution system efficiency (DSE) for heating, the DSE may be approximated by equation 3.4.i in ANSI/BPI-2400-S-2012: Standard Practice for Standardized Qualification of Whole-House Energy Savings, Predictions by Calibration to Energy Use History. Enter values as a fractional number between 0 and 1, i.e. 80% = 0.8</xs:documentation>
 										</xs:annotation>
 									</xs:element>
-									<xs:element minOccurs="0" name="AnnualCoolingDistributionSystemEfficiency" type="HPXMLDouble">
+									<xs:element minOccurs="0" name="AnnualCoolingDistributionSystemEfficiency" type="Fraction">
 										<xs:annotation>
-											<xs:documentation>For software that does not calculate an annual distribution system efficiency (DSE) for cooling, the DSE may be approximated by equation
-												3.4.i in ANSI/BPI-2400-S-2012: Standard Practice for Standardized Qualification of Whole-House Energy Savings, Predictions by Calibration to Energy Use
-												History.</xs:documentation>
+											<xs:documentation>For software that does not calculate an annual distribution system efficiency (DSE) for cooling, the DSE may be approximated by equation 3.4.i in ANSI/BPI-2400-S-2012: Standard Practice for Standardized Qualification of Whole-House Energy Savings, Predictions by Calibration to Energy Use History. Enter values as a fractional number between 0 and 1, i.e. 80% = 0.8</xs:documentation>
 										</xs:annotation>
 									</xs:element>
 									<xs:element minOccurs="0" name="HVACDistributionImprovement" type="HVACDistributionImprovementInfo"/>
@@ -3828,93 +3823,6 @@
 		</xs:sequence>
 		<xs:attribute name="dataSource" type="DataSource"/>
 	</xs:complexType>
-	<xs:complexType name="HydronicAndAirDistributionInfo">
-		<xs:sequence>
-			<xs:element name="HydronicAndAirDistributionType" type="HydronicAndAirDistributionType" minOccurs="0"/>
-			<xs:element name="AirHandlerMotorType" type="AirHandlerMotorType" minOccurs="0"/>
-			<xs:element minOccurs="0" name="DuctLeakageMeasurement" type="DuctLeakageMeasurementType" maxOccurs="unbounded"/>
-			<xs:element minOccurs="0" name="DuctSystemSizingAppropriate" type="HPXMLBoolean"/>
-			<xs:element maxOccurs="unbounded" minOccurs="0" name="Ducts">
-				<xs:complexType>
-					<xs:sequence>
-						<xs:element name="DuctType" type="DuctType" minOccurs="0"/>
-						<xs:element name="DuctMaterial" type="DuctMaterial" minOccurs="0"/>
-						<xs:element minOccurs="0" name="DuctInsulationMaterial" type="InsulationMaterial"/>
-						<xs:element name="DuctInsulationRValue" type="RValue" minOccurs="0"/>
-						<xs:element minOccurs="0" name="DuctInsulationThickness" type="LengthMeasurement">
-							<xs:annotation>
-								<xs:documentation>[in]</xs:documentation>
-							</xs:annotation>
-						</xs:element>
-						<xs:element minOccurs="0" name="DuctInsulationCondition" type="InsulationCondition"/>
-						<xs:element name="DuctLocation" type="DuctLocation" minOccurs="0"/>
-						<xs:element minOccurs="0" name="FractionDuctArea" type="Fraction">
-							<xs:annotation>
-								<xs:documentation>If a DuctType of supply or return is specified above, this is the fraction of the supply or return duct area. If DuctType is omitted above, this is
-									the fraction of the total duct area. </xs:documentation>
-							</xs:annotation>
-						</xs:element>
-						<xs:element minOccurs="0" name="DuctSurfaceArea" type="SurfaceArea">
-							<xs:annotation>
-								<xs:documentation>[sq.ft.]</xs:documentation>
-							</xs:annotation>
-						</xs:element>
-						<xs:element minOccurs="0" ref="extension"/>
-					</xs:sequence>
-					<xs:attribute name="dataSource" type="DataSource"/>
-				</xs:complexType>
-			</xs:element>
-			<xs:element minOccurs="0" name="NumberofReturnRegisters" type="IntegerGreaterThanOrEqualToZero"/>
-			<xs:element minOccurs="0" name="TotalExternalStaticPressureMeasurement">
-				<xs:complexType>
-					<xs:sequence>
-						<xs:element minOccurs="0" name="Supply" type="TotalExternalStaticPressureMeasurement"/>
-						<xs:element minOccurs="0" name="Return" type="TotalExternalStaticPressureMeasurement"/>
-					</xs:sequence>
-					<xs:attribute name="dataSource" type="DataSource"/>
-				</xs:complexType>
-			</xs:element>
-			<xs:element name="FractionHydronicPipeInsulated" type="Fraction" minOccurs="0"/>
-			<xs:element minOccurs="0" name="PipeRValue" type="RValue"/>
-			<xs:element minOccurs="0" name="PipeInsulationThickness" type="LengthMeasurement">
-				<xs:annotation>
-					<xs:documentation>[in]</xs:documentation>
-				</xs:annotation>
-			</xs:element>
-			<xs:element minOccurs="0" name="PipeLength" type="LengthMeasurement">
-				<xs:annotation>
-					<xs:documentation>[ft]</xs:documentation>
-				</xs:annotation>
-			</xs:element>
-			<xs:element minOccurs="0" name="PipeDiameter" type="PipeDiameterType"/>
-			<xs:element minOccurs="0" name="SupplyTemperature" type="Temperature">
-				<xs:annotation>
-					<xs:documentation>[degF]</xs:documentation>
-				</xs:annotation>
-			</xs:element>
-			<xs:element minOccurs="0" name="ReturnTemperature" type="Temperature">
-				<xs:annotation>
-					<xs:documentation>[degF]</xs:documentation>
-				</xs:annotation>
-			</xs:element>
-			<xs:element minOccurs="0" name="PumpandZoneValve">
-				<xs:complexType>
-					<xs:sequence>
-						<xs:element minOccurs="0" name="ValveCorrections" type="HPXMLBoolean">
-							<xs:annotation>
-								<xs:documentation>System Pump and Zone Valve Corrections made</xs:documentation>
-							</xs:annotation>
-						</xs:element>
-						<xs:element minOccurs="0" name="ThermostaticRadiatorValves" type="HPXMLBoolean"/>
-						<xs:element minOccurs="0" name="VariableSpeedPump" type="HPXMLBoolean"/>
-					</xs:sequence>
-					<xs:attribute name="dataSource" type="DataSource"/>
-				</xs:complexType>
-			</xs:element>
-			<xs:element minOccurs="0" ref="extension"/>
-		</xs:sequence>
-		<xs:attribute name="dataSource" type="DataSource"/>
-	</xs:complexType>
 	<xs:element name="BuildingSystemIdentifiers">
 		<xs:annotation>
 			<xs:documentation>HPXML records may contain data about an individual, either a person, or a business. This element contains the root elements for individual identifier values between a