openstudio-calibration 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (218) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +29 -0
  3. data/CHANGELOG.md +14 -0
  4. data/Gemfile +20 -0
  5. data/Jenkinsfile +6 -0
  6. data/LICENSE.md +27 -0
  7. data/README.md +33 -0
  8. data/Rakefile +50 -0
  9. data/doc_templates/LICENSE.md +27 -0
  10. data/doc_templates/README.md.erb +42 -0
  11. data/doc_templates/copyright_erb.txt +36 -0
  12. data/doc_templates/copyright_js.txt +4 -0
  13. data/doc_templates/copyright_ruby.txt +34 -0
  14. data/lib/files/.gitkeep +0 -0
  15. data/lib/measures/AddMonthlyJSONUtilityData/LICENSE.md +27 -0
  16. data/lib/measures/AddMonthlyJSONUtilityData/README.md +96 -0
  17. data/lib/measures/AddMonthlyJSONUtilityData/README.md.erb +42 -0
  18. data/lib/measures/AddMonthlyJSONUtilityData/measure.rb +280 -0
  19. data/lib/measures/AddMonthlyJSONUtilityData/measure.xml +163 -0
  20. data/lib/measures/AddMonthlyUtilityData/LICENSE.md +27 -0
  21. data/lib/measures/AddMonthlyUtilityData/README.md +64 -0
  22. data/lib/measures/AddMonthlyUtilityData/README.md.erb +42 -0
  23. data/lib/measures/AddMonthlyUtilityData/measure.rb +312 -0
  24. data/lib/measures/AddMonthlyUtilityData/measure.xml +115 -0
  25. data/lib/measures/AddMonthlyUtilityData/tests/AddMonthlyUtilityData_Test.rb +88 -0
  26. data/lib/measures/AddMonthlyUtilityData/tests/electric_billed_usages.json +198 -0
  27. data/lib/measures/AddMonthlyUtilityData/tests/gas_billed_usages.json +198 -0
  28. data/lib/measures/CalibrationReports/LICENSE.md +27 -0
  29. data/lib/measures/CalibrationReports/README.md +26 -0
  30. data/lib/measures/CalibrationReports/README.md.erb +42 -0
  31. data/lib/measures/CalibrationReports/measure.rb +511 -0
  32. data/lib/measures/CalibrationReports/measure.xml +98 -0
  33. data/lib/measures/CalibrationReports/resources/report.html.in +379 -0
  34. data/lib/measures/CalibrationReports/tests/CalibrationReports_Test.rb +523 -0
  35. data/lib/measures/CalibrationReports/tests/ExampleModel.osm +10497 -0
  36. data/lib/measures/CalibrationReports/tests/ExampleModelNoDemandInput.osm +10560 -0
  37. data/lib/measures/CalibrationReports/tests/ExampleModelNoGasInput.osm +10456 -0
  38. data/lib/measures/CalibrationReports/tests/USA_CO_Golden-NREL.724666_TMY3.epw +8768 -0
  39. data/lib/measures/CalibrationReportsEnhanced/LICENSE.md +27 -0
  40. data/lib/measures/CalibrationReportsEnhanced/README.md +143 -0
  41. data/lib/measures/CalibrationReportsEnhanced/README.md.erb +42 -0
  42. data/lib/measures/CalibrationReportsEnhanced/measure.rb +798 -0
  43. data/lib/measures/CalibrationReportsEnhanced/measure.xml +372 -0
  44. data/lib/measures/CalibrationReportsEnhanced/resources/report.html.in +380 -0
  45. data/lib/measures/CalibrationReportsEnhanced/tests/CalibrationReportsEnhanced_Test.rb +734 -0
  46. data/lib/measures/CalibrationReportsEnhanced/tests/ExampleModel.osm +10497 -0
  47. data/lib/measures/CalibrationReportsEnhanced/tests/ExampleModel_FuelOil.osm +12740 -0
  48. data/lib/measures/CalibrationReportsEnhanced/tests/USA_CO_Golden-NREL.724666_TMY3.epw +8768 -0
  49. data/lib/measures/CalibrationReportsEnhanced21/LICENSE.md +27 -0
  50. data/lib/measures/CalibrationReportsEnhanced21/README.md +109 -0
  51. data/lib/measures/CalibrationReportsEnhanced21/README.md.erb +42 -0
  52. data/lib/measures/CalibrationReportsEnhanced21/measure.rb +690 -0
  53. data/lib/measures/CalibrationReportsEnhanced21/measure.xml +269 -0
  54. data/lib/measures/CalibrationReportsEnhanced21/resources/report.html.in +380 -0
  55. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/LICENSE.md +27 -0
  56. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/README.md +48 -0
  57. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/README.md.erb +42 -0
  58. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/measure.rb +237 -0
  59. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/measure.xml +93 -0
  60. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/LICENSE.md +27 -0
  61. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/README.md +48 -0
  62. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/README.md.erb +42 -0
  63. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/measure.rb +228 -0
  64. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/measure.xml +93 -0
  65. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/LICENSE.md +27 -0
  66. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/README.md +64 -0
  67. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/README.md.erb +42 -0
  68. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/measure.rb +280 -0
  69. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/measure.xml +111 -0
  70. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/LICENSE.md +27 -0
  71. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/README.md +64 -0
  72. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/README.md.erb +42 -0
  73. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/measure.rb +270 -0
  74. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/measure.xml +111 -0
  75. data/lib/measures/CoilCoolingWaterMultiplier/LICENSE.md +27 -0
  76. data/lib/measures/CoilCoolingWaterMultiplier/README.md +80 -0
  77. data/lib/measures/CoilCoolingWaterMultiplier/README.md.erb +42 -0
  78. data/lib/measures/CoilCoolingWaterMultiplier/measure.rb +324 -0
  79. data/lib/measures/CoilCoolingWaterMultiplier/measure.xml +129 -0
  80. data/lib/measures/CoilCoolingWaterPercentChange/LICENSE.md +27 -0
  81. data/lib/measures/CoilCoolingWaterPercentChange/README.md +80 -0
  82. data/lib/measures/CoilCoolingWaterPercentChange/README.md.erb +42 -0
  83. data/lib/measures/CoilCoolingWaterPercentChange/measure.rb +311 -0
  84. data/lib/measures/CoilCoolingWaterPercentChange/measure.xml +129 -0
  85. data/lib/measures/CoilHeatingElectricMultiplier/LICENSE.md +27 -0
  86. data/lib/measures/CoilHeatingElectricMultiplier/README.md +48 -0
  87. data/lib/measures/CoilHeatingElectricMultiplier/README.md.erb +42 -0
  88. data/lib/measures/CoilHeatingElectricMultiplier/measure.rb +240 -0
  89. data/lib/measures/CoilHeatingElectricMultiplier/measure.xml +93 -0
  90. data/lib/measures/CoilHeatingElectricPercentChange/LICENSE.md +27 -0
  91. data/lib/measures/CoilHeatingElectricPercentChange/README.md +48 -0
  92. data/lib/measures/CoilHeatingElectricPercentChange/README.md.erb +42 -0
  93. data/lib/measures/CoilHeatingElectricPercentChange/measure.rb +231 -0
  94. data/lib/measures/CoilHeatingElectricPercentChange/measure.xml +93 -0
  95. data/lib/measures/CoilHeatingGasMultiplier/LICENSE.md +27 -0
  96. data/lib/measures/CoilHeatingGasMultiplier/README.md +64 -0
  97. data/lib/measures/CoilHeatingGasMultiplier/README.md.erb +42 -0
  98. data/lib/measures/CoilHeatingGasMultiplier/measure.rb +282 -0
  99. data/lib/measures/CoilHeatingGasMultiplier/measure.xml +111 -0
  100. data/lib/measures/CoilHeatingGasPercentChange/LICENSE.md +27 -0
  101. data/lib/measures/CoilHeatingGasPercentChange/README.md +64 -0
  102. data/lib/measures/CoilHeatingGasPercentChange/README.md.erb +42 -0
  103. data/lib/measures/CoilHeatingGasPercentChange/measure.rb +271 -0
  104. data/lib/measures/CoilHeatingGasPercentChange/measure.xml +111 -0
  105. data/lib/measures/CoilHeatingWaterMultiplier/LICENSE.md +27 -0
  106. data/lib/measures/CoilHeatingWaterMultiplier/README.md +48 -0
  107. data/lib/measures/CoilHeatingWaterMultiplier/README.md.erb +42 -0
  108. data/lib/measures/CoilHeatingWaterMultiplier/measure.rb +235 -0
  109. data/lib/measures/CoilHeatingWaterMultiplier/measure.xml +93 -0
  110. data/lib/measures/CoilHeatingWaterPercentChange/LICENSE.md +27 -0
  111. data/lib/measures/CoilHeatingWaterPercentChange/README.md +48 -0
  112. data/lib/measures/CoilHeatingWaterPercentChange/README.md.erb +42 -0
  113. data/lib/measures/CoilHeatingWaterPercentChange/measure.rb +226 -0
  114. data/lib/measures/CoilHeatingWaterPercentChange/measure.xml +93 -0
  115. data/lib/measures/ConstructionLayerZeroMaterialProperties/LICENSE.md +27 -0
  116. data/lib/measures/ConstructionLayerZeroMaterialProperties/README.md +88 -0
  117. data/lib/measures/ConstructionLayerZeroMaterialProperties/README.md.erb +42 -0
  118. data/lib/measures/ConstructionLayerZeroMaterialProperties/measure.rb +221 -0
  119. data/lib/measures/ConstructionLayerZeroMaterialProperties/measure.xml +194 -0
  120. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/LICENSE.md +27 -0
  121. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/README.md +40 -0
  122. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/README.md.erb +42 -0
  123. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/measure.rb +102 -0
  124. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/measure.xml +78 -0
  125. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/LICENSE.md +27 -0
  126. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/README.md +48 -0
  127. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/README.md.erb +42 -0
  128. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/measure.rb +263 -0
  129. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/measure.xml +97 -0
  130. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/LICENSE.md +27 -0
  131. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/README.md +48 -0
  132. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/README.md.erb +42 -0
  133. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/measure.rb +253 -0
  134. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/measure.xml +97 -0
  135. data/lib/measures/FansMultiplier/LICENSE.md +27 -0
  136. data/lib/measures/FansMultiplier/README.md +64 -0
  137. data/lib/measures/FansMultiplier/README.md.erb +42 -0
  138. data/lib/measures/FansMultiplier/measure.rb +297 -0
  139. data/lib/measures/FansMultiplier/measure.xml +166 -0
  140. data/lib/measures/FansPercentChange/LICENSE.md +27 -0
  141. data/lib/measures/FansPercentChange/README.md +64 -0
  142. data/lib/measures/FansPercentChange/README.md.erb +42 -0
  143. data/lib/measures/FansPercentChange/measure.rb +286 -0
  144. data/lib/measures/FansPercentChange/measure.xml +166 -0
  145. data/lib/measures/GeneralCalibrationMeasureMultiplier/LICENSE.md +27 -0
  146. data/lib/measures/GeneralCalibrationMeasureMultiplier/README.md +112 -0
  147. data/lib/measures/GeneralCalibrationMeasureMultiplier/README.md.erb +42 -0
  148. data/lib/measures/GeneralCalibrationMeasureMultiplier/measure.rb +639 -0
  149. data/lib/measures/GeneralCalibrationMeasureMultiplier/measure.xml +229 -0
  150. data/lib/measures/GeneralCalibrationMeasurePercentChange/LICENSE.md +27 -0
  151. data/lib/measures/GeneralCalibrationMeasurePercentChange/README.md +112 -0
  152. data/lib/measures/GeneralCalibrationMeasurePercentChange/README.md.erb +42 -0
  153. data/lib/measures/GeneralCalibrationMeasurePercentChange/measure.rb +756 -0
  154. data/lib/measures/GeneralCalibrationMeasurePercentChange/measure.xml +229 -0
  155. data/lib/measures/HardSizeHvac/LICENSE.md +27 -0
  156. data/lib/measures/HardSizeHvac/README.md +26 -0
  157. data/lib/measures/HardSizeHvac/README.md.erb +42 -0
  158. data/lib/measures/HardSizeHvac/measure.rb +88 -0
  159. data/lib/measures/HardSizeHvac/measure.xml +81 -0
  160. data/lib/measures/MaalkaMonthlyJSONUtilityData/LICENSE.md +27 -0
  161. data/lib/measures/MaalkaMonthlyJSONUtilityData/README.md +104 -0
  162. data/lib/measures/MaalkaMonthlyJSONUtilityData/README.md.erb +42 -0
  163. data/lib/measures/MaalkaMonthlyJSONUtilityData/measure.rb +304 -0
  164. data/lib/measures/MaalkaMonthlyJSONUtilityData/measure.xml +216 -0
  165. data/lib/measures/RValueOfInsulationForConstructionMultiplier/LICENSE.md +27 -0
  166. data/lib/measures/RValueOfInsulationForConstructionMultiplier/README.md +40 -0
  167. data/lib/measures/RValueOfInsulationForConstructionMultiplier/README.md.erb +42 -0
  168. data/lib/measures/RValueOfInsulationForConstructionMultiplier/measure.rb +196 -0
  169. data/lib/measures/RValueOfInsulationForConstructionMultiplier/measure.xml +132 -0
  170. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/LICENSE.md +27 -0
  171. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/README.md +40 -0
  172. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/README.md.erb +42 -0
  173. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/measure.rb +189 -0
  174. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/measure.xml +132 -0
  175. data/lib/measures/RoofThermalPropertiesMultiplier/LICENSE.md +27 -0
  176. data/lib/measures/RoofThermalPropertiesMultiplier/README.md +48 -0
  177. data/lib/measures/RoofThermalPropertiesMultiplier/README.md.erb +42 -0
  178. data/lib/measures/RoofThermalPropertiesMultiplier/measure.rb +263 -0
  179. data/lib/measures/RoofThermalPropertiesMultiplier/measure.xml +97 -0
  180. data/lib/measures/RoofThermalPropertiesPercentChange/LICENSE.md +27 -0
  181. data/lib/measures/RoofThermalPropertiesPercentChange/README.md +48 -0
  182. data/lib/measures/RoofThermalPropertiesPercentChange/README.md.erb +42 -0
  183. data/lib/measures/RoofThermalPropertiesPercentChange/measure.rb +253 -0
  184. data/lib/measures/RoofThermalPropertiesPercentChange/measure.xml +97 -0
  185. data/lib/measures/TimeseriesObjectiveFunction/LICENSE.md +27 -0
  186. data/lib/measures/TimeseriesObjectiveFunction/README.md +207 -0
  187. data/lib/measures/TimeseriesObjectiveFunction/README.md.erb +42 -0
  188. data/lib/measures/TimeseriesObjectiveFunction/measure.rb +748 -0
  189. data/lib/measures/TimeseriesObjectiveFunction/measure.xml +435 -0
  190. data/lib/measures/TimeseriesObjectiveFunction/resources/report.html.erb +288 -0
  191. data/lib/measures/TimeseriesPlot/LICENSE.md +27 -0
  192. data/lib/measures/TimeseriesPlot/README.md +56 -0
  193. data/lib/measures/TimeseriesPlot/README.md.erb +42 -0
  194. data/lib/measures/TimeseriesPlot/measure.rb +302 -0
  195. data/lib/measures/TimeseriesPlot/measure.xml +137 -0
  196. data/lib/measures/TimeseriesPlot/resources/report.html.erb +270 -0
  197. data/lib/measures/WaterHeaterMixedMultiplier/LICENSE.md +27 -0
  198. data/lib/measures/WaterHeaterMixedMultiplier/README.md +64 -0
  199. data/lib/measures/WaterHeaterMixedMultiplier/README.md.erb +42 -0
  200. data/lib/measures/WaterHeaterMixedMultiplier/measure.rb +255 -0
  201. data/lib/measures/WaterHeaterMixedMultiplier/measure.xml +180 -0
  202. data/lib/measures/WaterHeaterMixedPercentChange/LICENSE.md +27 -0
  203. data/lib/measures/WaterHeaterMixedPercentChange/README.md +64 -0
  204. data/lib/measures/WaterHeaterMixedPercentChange/README.md.erb +42 -0
  205. data/lib/measures/WaterHeaterMixedPercentChange/measure.rb +245 -0
  206. data/lib/measures/WaterHeaterMixedPercentChange/measure.xml +180 -0
  207. data/lib/measures/zone_report/LICENSE.md +27 -0
  208. data/lib/measures/zone_report/README.md +26 -0
  209. data/lib/measures/zone_report/README.md.erb +42 -0
  210. data/lib/measures/zone_report/measure.rb +706 -0
  211. data/lib/measures/zone_report/measure.xml +67 -0
  212. data/lib/measures/zone_report/resources/report.html.in +342 -0
  213. data/lib/openstudio-calibration-measures.rb +36 -0
  214. data/lib/openstudio/calibration_measures.rb +37 -0
  215. data/lib/openstudio/calibration_measures/extension.rb +49 -0
  216. data/lib/openstudio/calibration_measures/version.rb +40 -0
  217. data/openstudio-calibration.gemspec +30 -0
  218. metadata +331 -0
@@ -0,0 +1,180 @@
1
+ <measure>
2
+ <schema_version>3.0</schema_version>
3
+ <name>water_heater_mixed_multiplier</name>
4
+ <uid>1e4d5053-d2c1-400d-9192-7a470e5a7b5c</uid>
5
+ <version_id>181c681e-5bb0-4c12-9be1-5cac332a1f07</version_id>
6
+ <version_modified>20200325T030943Z</version_modified>
7
+ <xml_checksum>D28BCE9C</xml_checksum>
8
+ <class_name>WaterHeaterMixedMultiplier</class_name>
9
+ <display_name>Water Heater Mixed Multiplier</display_name>
10
+ <description>This is a general purpose measure to calibrate WaterHeaterMixed with a Multiplier.</description>
11
+ <modeler_description>It will be used for calibration of WaterHeaterMixed. User can choose between a SINGLE WaterHeaterMixed or ALL the WaterHeaterMixed objects.</modeler_description>
12
+ <arguments>
13
+ <argument>
14
+ <name>water_heater</name>
15
+ <display_name>Apply the Measure to a SINGLE WaterHeaterMixed, ALL the WaterHeaterMixeds or NONE.</display_name>
16
+ <type>Choice</type>
17
+ <required>true</required>
18
+ <model_dependent>false</model_dependent>
19
+ <default_value>*All WaterHeaterMixeds*</default_value>
20
+ <choices>
21
+ <choice>
22
+ <value>{356082a9-49c2-4b10-9a47-190e186e24ec}</value>
23
+ <display_name>*All WaterHeaterMixeds*</display_name>
24
+ </choice>
25
+ <choice>
26
+ <value>0</value>
27
+ <display_name>*None*</display_name>
28
+ </choice>
29
+ </choices>
30
+ </argument>
31
+ <argument>
32
+ <name>maximum_capacity_multiplier</name>
33
+ <display_name>Multiplier for Heater Maximum Capacity.</display_name>
34
+ <description>Multiplier for Heater Maximum Capacity.</description>
35
+ <type>Double</type>
36
+ <required>true</required>
37
+ <model_dependent>false</model_dependent>
38
+ <default_value>1</default_value>
39
+ </argument>
40
+ <argument>
41
+ <name>minimum_capacity_multiplier</name>
42
+ <display_name>Multiplier for Heater Minimum Capacity.</display_name>
43
+ <description>Multiplier for Heater Minimum Capacity.</description>
44
+ <type>Double</type>
45
+ <required>true</required>
46
+ <model_dependent>false</model_dependent>
47
+ <default_value>1</default_value>
48
+ </argument>
49
+ <argument>
50
+ <name>thermal_efficiency_multiplier</name>
51
+ <display_name>Multiplier for Thermal Efficiency.</display_name>
52
+ <description>Multiplier for Thermal Efficiency.</description>
53
+ <type>Double</type>
54
+ <required>true</required>
55
+ <model_dependent>false</model_dependent>
56
+ <default_value>1</default_value>
57
+ </argument>
58
+ <argument>
59
+ <name>fuel_type</name>
60
+ <display_name>Heater Fuel Type.</display_name>
61
+ <description>Heater Fuel Type.</description>
62
+ <type>Choice</type>
63
+ <required>true</required>
64
+ <model_dependent>false</model_dependent>
65
+ <default_value>NaturalGas</default_value>
66
+ <choices>
67
+ <choice>
68
+ <value>NaturalGas</value>
69
+ <display_name>NaturalGas</display_name>
70
+ </choice>
71
+ <choice>
72
+ <value>Electricity</value>
73
+ <display_name>Electricity</display_name>
74
+ </choice>
75
+ <choice>
76
+ <value>PropaneGas</value>
77
+ <display_name>PropaneGas</display_name>
78
+ </choice>
79
+ </choices>
80
+ </argument>
81
+ </arguments>
82
+ <outputs/>
83
+ <provenances/>
84
+ <tags>
85
+ <tag>Service Water Heating.Water Heating</tag>
86
+ </tags>
87
+ <attributes>
88
+ <attribute>
89
+ <name>Intended Software Tool</name>
90
+ <value>Analysis Spreadsheet</value>
91
+ <datatype>string</datatype>
92
+ </attribute>
93
+ <attribute>
94
+ <name>Intended Use Case</name>
95
+ <value>Model Articulation</value>
96
+ <datatype>string</datatype>
97
+ </attribute>
98
+ <attribute>
99
+ <name>Intended Use Case</name>
100
+ <value>Calibration</value>
101
+ <datatype>string</datatype>
102
+ </attribute>
103
+ <attribute>
104
+ <name>Intended Use Case</name>
105
+ <value>Sensitivity Analysis</value>
106
+ <datatype>string</datatype>
107
+ </attribute>
108
+ <attribute>
109
+ <name>Measure Type</name>
110
+ <value>ModelMeasure</value>
111
+ <datatype>string</datatype>
112
+ </attribute>
113
+ <attribute>
114
+ <name>Intended Software Tool</name>
115
+ <value>Apply Measure Now</value>
116
+ <datatype>string</datatype>
117
+ </attribute>
118
+ <attribute>
119
+ <name>Intended Software Tool</name>
120
+ <value>OpenStudio Application</value>
121
+ <datatype>string</datatype>
122
+ </attribute>
123
+ <attribute>
124
+ <name>Intended Software Tool</name>
125
+ <value>Parametric Analysis Tool</value>
126
+ <datatype>string</datatype>
127
+ </attribute>
128
+ <attribute>
129
+ <name>Intended Software Tool</name>
130
+ <value>Analysis Spreadsheet</value>
131
+ <datatype>string</datatype>
132
+ </attribute>
133
+ <attribute>
134
+ <name>Intended Use Case</name>
135
+ <value>Model Articulation</value>
136
+ <datatype>string</datatype>
137
+ </attribute>
138
+ <attribute>
139
+ <name>Intended Use Case</name>
140
+ <value>Calibration</value>
141
+ <datatype>string</datatype>
142
+ </attribute>
143
+ <attribute>
144
+ <name>Intended Use Case</name>
145
+ <value>Sensitivity Analysis</value>
146
+ <datatype>string</datatype>
147
+ </attribute>
148
+ </attributes>
149
+ <files>
150
+ <file>
151
+ <filename>LICENSE.md</filename>
152
+ <filetype>md</filetype>
153
+ <usage_type>license</usage_type>
154
+ <checksum>E0468DD6</checksum>
155
+ </file>
156
+ <file>
157
+ <filename>README.md.erb</filename>
158
+ <filetype>erb</filetype>
159
+ <usage_type>readmeerb</usage_type>
160
+ <checksum>703C9964</checksum>
161
+ </file>
162
+ <file>
163
+ <filename>README.md</filename>
164
+ <filetype>md</filetype>
165
+ <usage_type>readme</usage_type>
166
+ <checksum>1626F8CE</checksum>
167
+ </file>
168
+ <file>
169
+ <version>
170
+ <software_program>OpenStudio</software_program>
171
+ <identifier>2.1.0</identifier>
172
+ <min_compatible>2.1.0</min_compatible>
173
+ </version>
174
+ <filename>measure.rb</filename>
175
+ <filetype>rb</filetype>
176
+ <usage_type>script</usage_type>
177
+ <checksum>B41A8DBE</checksum>
178
+ </file>
179
+ </files>
180
+ </measure>
@@ -0,0 +1,27 @@
1
+ OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
2
+
3
+ Redistribution and use in source and binary forms, with or without modification, are permitted
4
+ provided that the following conditions are met:
5
+
6
+ (1) Redistributions of source code must retain the above copyright notice, this list of conditions
7
+ and the following disclaimer.
8
+
9
+ (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
10
+ and the following disclaimer in the documentation and/or other materials provided with the distribution.
11
+
12
+ (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse
13
+ or promote products derived from this software without specific prior written permission from the
14
+ respective party.
15
+
16
+ (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other
17
+ derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar
18
+ designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
21
+ WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT,
23
+ OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
25
+ OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,64 @@
1
+
2
+
3
+ ###### (Automatically generated documentation)
4
+
5
+ # Water Heater Mixed Percent Change
6
+
7
+ ## Description
8
+ This is a general purpose measure to calibrate WaterHeaterMixed with a Percent Change.
9
+
10
+ ## Modeler Description
11
+ It will be used for calibration of WaterHeaterMixed. User can choose between a SINGLE WaterHeaterMixed or ALL the WaterHeaterMixed objects.
12
+
13
+ ## Measure Type
14
+ ModelMeasure
15
+
16
+ ## Taxonomy
17
+
18
+
19
+ ## Arguments
20
+
21
+
22
+ ### Apply the Measure to a SINGLE WaterHeaterMixed, ALL the WaterHeaterMixeds or NONE.
23
+
24
+ **Name:** water_heater,
25
+ **Type:** Choice,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+ ### Percent Change for Heater Maximum Capacity.
31
+ Percent Change for Heater Maximum Capacity.
32
+ **Name:** maximum_capacity_multiplier,
33
+ **Type:** Double,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### Percent Change for Heater Minimum Capacity.
39
+ Percent Change for Heater Minimum Capacity.
40
+ **Name:** minimum_capacity_multiplier,
41
+ **Type:** Double,
42
+ **Units:** ,
43
+ **Required:** true,
44
+ **Model Dependent:** false
45
+
46
+ ### Percent Change for Thermal Efficiency.
47
+ Percent Change for Thermal Efficiency.
48
+ **Name:** thermal_efficiency_multiplier,
49
+ **Type:** Double,
50
+ **Units:** ,
51
+ **Required:** true,
52
+ **Model Dependent:** false
53
+
54
+ ### Heater Fuel Type.
55
+ Heater Fuel Type.
56
+ **Name:** fuel_type,
57
+ **Type:** Choice,
58
+ **Units:** ,
59
+ **Required:** true,
60
+ **Model Dependent:** false
61
+
62
+
63
+
64
+
@@ -0,0 +1,42 @@
1
+ <%#= README.md.erb is used to auto-generate README.md. %>
2
+ <%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
3
+ ###### (Automatically generated documentation)
4
+
5
+ # <%= name %>
6
+
7
+ ## Description
8
+ <%= description %>
9
+
10
+ ## Modeler Description
11
+ <%= modelerDescription %>
12
+
13
+ ## Measure Type
14
+ <%= measureType %>
15
+
16
+ ## Taxonomy
17
+ <%= taxonomy %>
18
+
19
+ ## Arguments
20
+
21
+ <% arguments.each do |argument| %>
22
+ ### <%= argument[:display_name] %>
23
+ <%= argument[:description] %>
24
+ **Name:** <%= argument[:name] %>,
25
+ **Type:** <%= argument[:type] %>,
26
+ **Units:** <%= argument[:units] %>,
27
+ **Required:** <%= argument[:required] %>,
28
+ **Model Dependent:** <%= argument[:model_dependent] %>
29
+ <% end %>
30
+
31
+ <% if arguments.size == 0 %>
32
+ <%= "This measure does not have any user arguments" %>
33
+ <% end %>
34
+
35
+ <% if outputs.size > 0 %>
36
+ ## Outputs
37
+ <% output_names = [] %>
38
+ <% outputs.each do |output| %>
39
+ <% output_names << output[:display_name] %>
40
+ <% end %>
41
+ <%= output_names.join(", ") %>
42
+ <% end %>
@@ -0,0 +1,245 @@
1
+ # *******************************************************************************
2
+ # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
3
+ # All rights reserved.
4
+ # Redistribution and use in source and binary forms, with or without
5
+ # modification, are permitted provided that the following conditions are met:
6
+ #
7
+ # (1) Redistributions of source code must retain the above copyright notice,
8
+ # this list of conditions and the following disclaimer.
9
+ #
10
+ # (2) Redistributions in binary form must reproduce the above copyright notice,
11
+ # this list of conditions and the following disclaimer in the documentation
12
+ # and/or other materials provided with the distribution.
13
+ #
14
+ # (3) Neither the name of the copyright holder nor the names of any contributors
15
+ # may be used to endorse or promote products derived from this software without
16
+ # specific prior written permission from the respective party.
17
+ #
18
+ # (4) Other than as required in clauses (1) and (2), distributions in any form
19
+ # of modifications or other derivative works may not use the "OpenStudio"
20
+ # trademark, "OS", "os", or any other confusingly similar designation without
21
+ # specific prior written permission from Alliance for Sustainable Energy, LLC.
22
+ #
23
+ # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
24
+ # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
25
+ # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26
+ # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
27
+ # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
28
+ # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29
+ # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
30
+ # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31
+ # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
32
+ # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33
+ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34
+ # *******************************************************************************
35
+
36
+ # start the measure
37
+ class WaterHeaterMixedPercentChange < OpenStudio::Measure::ModelMeasure
38
+ # human readable name
39
+ def name
40
+ 'Water Heater Mixed Percent Change'
41
+ end
42
+
43
+ # human readable description
44
+ def description
45
+ 'This is a general purpose measure to calibrate WaterHeaterMixed with a Percent Change.'
46
+ end
47
+
48
+ # human readable description of modeling approach
49
+ def modeler_description
50
+ 'It will be used for calibration of WaterHeaterMixed. User can choose between a SINGLE WaterHeaterMixed or ALL the WaterHeaterMixed objects.'
51
+ end
52
+
53
+ def change_name(object, maximum_capacity_multiplier, minimum_capacity_multiplier, thermal_efficiency_multiplier, fuel_type, orig_fuel_type)
54
+ nameString = object.name.get.to_s
55
+ if maximum_capacity_multiplier != 0.0
56
+ nameString += " #{maximum_capacity_multiplier.round(2)}x maxCap"
57
+ end
58
+ if minimum_capacity_multiplier != 0.0
59
+ nameString += " #{minimum_capacity_multiplier.round(2)}x minCap"
60
+ end
61
+ if thermal_efficiency_multiplier != 0.0
62
+ nameString += " #{thermal_efficiency_multiplier.round(2)}x thermEff"
63
+ end
64
+ nameString += " #{fuel_type} fuel Change" if orig_fuel_type != fuel_type
65
+ object.setName(nameString)
66
+ end
67
+
68
+ # define the arguments that the user will input
69
+ def arguments(model)
70
+ args = OpenStudio::Measure::OSArgumentVector.new
71
+
72
+ # make a choice argument for model objects
73
+ water_heater_handles = OpenStudio::StringVector.new
74
+ water_heater_display_names = OpenStudio::StringVector.new
75
+
76
+ # putting model object and names into hash
77
+ water_heater_args = model.getWaterHeaterMixeds
78
+ water_heater_args.each do |water_heater_arg|
79
+ water_heater_handles << water_heater_arg.handle.to_s
80
+ water_heater_display_names << water_heater_arg.name.to_s
81
+ end
82
+
83
+ # add building to string vector with space type
84
+ building = model.getBuilding
85
+ water_heater_handles << building.handle.to_s
86
+ water_heater_display_names << '*All WaterHeaterMixeds*'
87
+ water_heater_handles << '0'
88
+ water_heater_display_names << '*None*'
89
+
90
+ # make a choice argument for space type
91
+ water_heater = OpenStudio::Measure::OSArgument.makeChoiceArgument('water_heater', water_heater_handles, water_heater_display_names)
92
+ water_heater.setDisplayName('Apply the Measure to a SINGLE WaterHeaterMixed, ALL the WaterHeaterMixeds or NONE.')
93
+ water_heater.setDefaultValue('*All WaterHeaterMixeds*') # if no space type is chosen this will run on the entire building
94
+ args << water_heater
95
+
96
+ # maximum_capacity_multiplier
97
+ maximum_capacity_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('maximum_capacity_multiplier', true)
98
+ maximum_capacity_multiplier.setDisplayName('Percent Change for Heater Maximum Capacity.')
99
+ maximum_capacity_multiplier.setDescription('Percent Change for Heater Maximum Capacity.')
100
+ maximum_capacity_multiplier.setDefaultValue(0.0)
101
+ maximum_capacity_multiplier.setMinValue(0.0)
102
+ args << maximum_capacity_multiplier
103
+
104
+ # minimum_capacity_multiplier
105
+ minimum_capacity_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('minimum_capacity_multiplier', true)
106
+ minimum_capacity_multiplier.setDisplayName('Percent Change for Heater Minimum Capacity.')
107
+ minimum_capacity_multiplier.setDescription('Percent Change for Heater Minimum Capacity.')
108
+ minimum_capacity_multiplier.setDefaultValue(0.0)
109
+ args << minimum_capacity_multiplier
110
+
111
+ # thermal_efficiency_multiplier
112
+ thermal_efficiency_multiplier = OpenStudio::Measure::OSArgument.makeDoubleArgument('thermal_efficiency_multiplier', true)
113
+ thermal_efficiency_multiplier.setDisplayName('Percent Change for Thermal Efficiency.')
114
+ thermal_efficiency_multiplier.setDescription('Percent Change for Thermal Efficiency.')
115
+ thermal_efficiency_multiplier.setDefaultValue(0.0)
116
+ args << thermal_efficiency_multiplier
117
+
118
+ # make a choice argument for fuel type
119
+ fuel_type = OpenStudio::StringVector.new
120
+ fuel_type << 'NaturalGas'
121
+ fuel_type << 'Electricity'
122
+ fuel_type << 'PropaneGas'
123
+
124
+ # heater_fuel_type
125
+ heater_fuel_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('fuel_type', fuel_type, fuel_type)
126
+ heater_fuel_type.setDisplayName('Heater Fuel Type.')
127
+ heater_fuel_type.setDescription('Heater Fuel Type.')
128
+ heater_fuel_type.setDefaultValue('NaturalGas')
129
+ args << heater_fuel_type
130
+
131
+ args
132
+ end
133
+
134
+ # define what happens when the measure is run
135
+ def run(model, runner, user_arguments)
136
+ super(model, runner, user_arguments)
137
+
138
+ # use the built-in error checking
139
+ unless runner.validateUserArguments(arguments(model), user_arguments)
140
+ return false
141
+ end
142
+
143
+ # assign the user inputs to variables
144
+ water_heater_object = runner.getOptionalWorkspaceObjectChoiceValue('water_heater', user_arguments, model)
145
+ water_heater_handle = runner.getStringArgumentValue('water_heater', user_arguments)
146
+ fuel_type = runner.getStringArgumentValue('fuel_type', user_arguments)
147
+ thermal_efficiency_multiplier = runner.getDoubleArgumentValue('thermal_efficiency_multiplier', user_arguments)
148
+ maximum_capacity_multiplier = runner.getDoubleArgumentValue('maximum_capacity_multiplier', user_arguments)
149
+ minimum_capacity_multiplier = runner.getDoubleArgumentValue('minimum_capacity_multiplier', user_arguments)
150
+
151
+ # find objects to change
152
+ water_heaters = []
153
+ building = model.getBuilding
154
+ building_handle = building.handle.to_s
155
+ runner.registerInfo("water_heater_handle: #{water_heater_handle}")
156
+ # setup water_heaters
157
+ if water_heater_handle == building_handle
158
+ # Use ALL SpaceTypes
159
+ runner.registerInfo('Applying change to ALL SpaceTypes')
160
+ water_heaters = model.getWaterHeaterMixeds
161
+ elsif water_heater_handle == 0.to_s
162
+ # SpaceTypes set to NONE so do nothing
163
+ runner.registerInfo('Applying change to NONE SpaceTypes')
164
+ elsif !water_heater_handle.empty?
165
+ # Single WaterHeaterMixed handle found, check if object is good
166
+ if !water_heater_object.get.to_WaterHeaterMixed.empty?
167
+ runner.registerInfo("Applying change to #{water_heater_object.get.name} WaterHeaterMixed")
168
+ water_heaters << water_heater_object.get.to_WaterHeaterMixed.get
169
+ else
170
+ runner.registerError("WaterHeaterMixed with handle #{water_heater_handle} could not be found.")
171
+ end
172
+ else
173
+ runner.registerError('WaterHeaterMixed handle is empty.')
174
+ return false
175
+ end
176
+
177
+ altered_heaters = []
178
+ altered_thermalefficiency = []
179
+ altered_max_cap = []
180
+ altered_min_cap = []
181
+
182
+ # report initial condition of model
183
+ runner.registerInitialCondition("Applying Percent Change to #{water_heaters.size} Water Heaters.")
184
+
185
+ # loop through space types
186
+ water_heaters.each do |water_heater|
187
+ altered_heater = false
188
+ # modify maximum_capacity_multiplier
189
+ if maximum_capacity_multiplier != 0.0
190
+ if water_heater.heaterMaximumCapacity.is_initialized
191
+ runner.registerInfo("Applying #{maximum_capacity_multiplier}x maximum capacity Percent Change to #{water_heater.name.get}.")
192
+ water_heater.setHeaterMaximumCapacity(water_heater.heaterMaximumCapacity.get + water_heater.heaterMaximumCapacity.get * maximum_capacity_multiplier * 0.01)
193
+ altered_max_cap << water_heater.handle.to_s
194
+ altered_heater = true
195
+ end
196
+ end
197
+
198
+ # modify minimum_capacity_multiplier
199
+ if minimum_capacity_multiplier != 0.0
200
+ if water_heater.heaterMinimumCapacity.is_initialized
201
+ runner.registerInfo("Applying #{minimum_capacity_multiplier}x minimum capacity Percent Change to #{water_heater.name.get}.")
202
+ water_heater.setHeaterMaximumCapacity(water_heater.heaterMinimumCapacity.get + water_heater.heaterMinimumCapacity.get * minimum_capacity_multiplier * 0.01)
203
+ altered_min_cap << water_heater.handle.to_s
204
+ altered_heater = true
205
+ end
206
+ end
207
+
208
+ # modify thermal_efficiency_multiplier
209
+ if thermal_efficiency_multiplier != 0.0
210
+ if water_heater.heaterThermalEfficiency.is_initialized
211
+ runner.registerInfo("Applying #{thermal_efficiency_multiplier}x thermal efficiency Percent Change to #{water_heater.name.get}.")
212
+ water_heater.setHeaterThermalEfficiency(water_heater.heaterThermalEfficiency.get + water_heater.heaterThermalEfficiency.get * thermal_efficiency_multiplier * 0.01)
213
+ altered_thermalefficiency << water_heater.handle.to_s
214
+ altered_heater = true
215
+ end
216
+ end
217
+
218
+ orig_fuel_type = water_heater.heaterFuelType
219
+ if orig_fuel_type != fuel_type
220
+ runner.registerInfo("Changing Fuel Type to #{fuel_type} for #{water_heater.name.get}.")
221
+ water_heater.setHeaterFuelType(fuel_type)
222
+ altered_heater = true
223
+ end
224
+
225
+ next unless altered_heater
226
+ altered_heaters << water_heater.handle.to_s
227
+ change_name(water_heater, maximum_capacity_multiplier, minimum_capacity_multiplier, thermal_efficiency_multiplier, fuel_type, orig_fuel_type)
228
+ runner.registerInfo("WaterHeater name changed to: #{water_heater.name.get}")
229
+ end # end water_heater loop
230
+
231
+ # na if nothing in model to look at
232
+ if altered_heaters.empty?
233
+ runner.registerAsNotApplicable('No WaterHeaters were altered in the model')
234
+ return true
235
+ end
236
+
237
+ # report final condition of model
238
+ runner.registerFinalCondition("#{altered_heaters.size} WaterHeater objects were altered.")
239
+
240
+ true
241
+ end
242
+ end
243
+
244
+ # register the measure to be used by the application
245
+ WaterHeaterMixedPercentChange.new.registerWithApplication