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,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
+ # Heating Coils Gas Percent Change
6
+
7
+ ## Description
8
+ This is a general purpose measure to calibrate Gas Heating Coils with a Percent Change.
9
+
10
+ ## Modeler Description
11
+ It will be used for calibration of rated capacity and efficiency and parasitic loads. User can choose between a SINGLE coil or ALL the Coils.
12
+
13
+ ## Measure Type
14
+ ModelMeasure
15
+
16
+ ## Taxonomy
17
+
18
+
19
+ ## Arguments
20
+
21
+
22
+ ### Apply the Measure to a SINGLE Gas Heating Coil, ALL the Gas Heating Coils or NONE.
23
+
24
+ **Name:** coil,
25
+ **Type:** Choice,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+ ### Percent Change for coil Efficiency.
31
+ Percent Change for coil Efficiency.
32
+ **Name:** coil_efficiency_perc_change,
33
+ **Type:** Double,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### Percent Change for coil Capacity.
39
+ Percent Change for coil Capacity.
40
+ **Name:** coil_capacity_perc_change,
41
+ **Type:** Double,
42
+ **Units:** ,
43
+ **Required:** true,
44
+ **Model Dependent:** false
45
+
46
+ ### Percent Change for coil parasitic electric load.
47
+ Percent Change for coil parasitic electric load.
48
+ **Name:** coil_parasitic_electric_perc_change,
49
+ **Type:** Double,
50
+ **Units:** ,
51
+ **Required:** true,
52
+ **Model Dependent:** false
53
+
54
+ ### Percent Change for coil parasitic gas load.
55
+ Percent Change for coil parasitic gas load.
56
+ **Name:** coil_parasitic_gas_perc_change,
57
+ **Type:** Double,
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,271 @@
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 CoilHeatingGasPercentChange < OpenStudio::Measure::ModelMeasure
38
+ # human readable name
39
+ def name
40
+ 'Heating Coils Gas Percent Change'
41
+ end
42
+
43
+ # human readable description
44
+ def description
45
+ 'This is a general purpose measure to calibrate Gas Heating Coils 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 rated capacity and efficiency and parasitic loads. User can choose between a SINGLE coil or ALL the Coils.'
51
+ end
52
+
53
+ def change_name(object, coil_parasitic_gas_perc_change, coil_efficiency_perc_change, coil_parasitic_electric_perc_change, coil_capacity_perc_change)
54
+ nameString = object.name.get.to_s
55
+ if coil_parasitic_gas_perc_change != 1.0
56
+ nameString += " #{coil_parasitic_gas_perc_change.round(2)}percng gasPara"
57
+ end
58
+ if coil_parasitic_electric_perc_change != 1.0
59
+ nameString += " #{coil_parasitic_electric_perc_change.round(2)}percng elecPara"
60
+ end
61
+ if coil_efficiency_perc_change != 1.0
62
+ nameString += " #{coil_efficiency_perc_change.round(2)}percng coilEff"
63
+ end
64
+ if coil_capacity_perc_change != 1.0
65
+ nameString += " #{coil_capacity_perc_change.round(2)}percng coilCap"
66
+ end
67
+ object.setName(nameString)
68
+ end
69
+
70
+ # define the arguments that the user will input
71
+ def arguments(model)
72
+ args = OpenStudio::Measure::OSArgumentVector.new
73
+
74
+ # populate choice argument for constructions that are applied to surfaces in the model
75
+ loop_handles = OpenStudio::StringVector.new
76
+ loop_display_names = OpenStudio::StringVector.new
77
+
78
+ # putting air loops and names into hash
79
+ loop_args = model.getAirLoopHVACs
80
+ loop_args_hash = {}
81
+ loop_args.each do |loop_arg|
82
+ loop_args_hash[loop_arg.name.to_s] = loop_arg
83
+ end
84
+
85
+ # looping through sorted hash of air loops
86
+ loop_args_hash.sort.map do |_key, value|
87
+ show_loop = false
88
+ components = value.supplyComponents
89
+ components.each do |component|
90
+ next if component.to_CoilHeatingGas.empty?
91
+ show_loop = true
92
+ loop_handles << component.handle.to_s
93
+ loop_display_names << component.name.to_s
94
+ end
95
+
96
+ # if loop as object of correct type then add to hash.
97
+ # if show_loop == true
98
+ # loop_handles << value.handle.to_s
99
+ # loop_display_names << key
100
+ # end
101
+ end
102
+
103
+ # add building to string vector with space type
104
+ building = model.getBuilding
105
+ loop_handles << building.handle.to_s
106
+ loop_display_names << '*All Gas Heating Coils*'
107
+ loop_handles << '0'
108
+ loop_display_names << '*None*'
109
+
110
+ # make a choice argument for space type
111
+ coil_arg = OpenStudio::Measure::OSArgument.makeChoiceArgument('coil', loop_handles, loop_display_names)
112
+ coil_arg.setDisplayName('Apply the Measure to a SINGLE Gas Heating Coil, ALL the Gas Heating Coils or NONE.')
113
+ coil_arg.setDefaultValue('*All Gas Heating Coils*') # if no space type is chosen this will run on the entire building
114
+ args << coil_arg
115
+
116
+ # coil_efficiency_perc_change
117
+ coil_efficiency_perc_change = OpenStudio::Measure::OSArgument.makeDoubleArgument('coil_efficiency_perc_change', true)
118
+ coil_efficiency_perc_change.setDisplayName('Percent Change for coil Efficiency.')
119
+ coil_efficiency_perc_change.setDescription('Percent Change for coil Efficiency.')
120
+ coil_efficiency_perc_change.setDefaultValue(0.0)
121
+ args << coil_efficiency_perc_change
122
+
123
+ # coil_capacity_perc_change
124
+ coil_capacity_perc_change = OpenStudio::Measure::OSArgument.makeDoubleArgument('coil_capacity_perc_change', true)
125
+ coil_capacity_perc_change.setDisplayName('Percent Change for coil Capacity.')
126
+ coil_capacity_perc_change.setDescription('Percent Change for coil Capacity.')
127
+ coil_capacity_perc_change.setDefaultValue(0.0)
128
+ args << coil_capacity_perc_change
129
+
130
+ # coil_parasitic_electric_perc_change
131
+ coil_parasitic_electric_perc_change = OpenStudio::Measure::OSArgument.makeDoubleArgument('coil_parasitic_electric_perc_change', true)
132
+ coil_parasitic_electric_perc_change.setDisplayName('Percent Change for coil parasitic electric load.')
133
+ coil_parasitic_electric_perc_change.setDescription('Percent Change for coil parasitic electric load.')
134
+ coil_parasitic_electric_perc_change.setDefaultValue(0.0)
135
+ args << coil_parasitic_electric_perc_change
136
+
137
+ # coil_parasitic_gas_perc_change
138
+ coil_parasitic_gas_perc_change = OpenStudio::Measure::OSArgument.makeDoubleArgument('coil_parasitic_gas_perc_change', true)
139
+ coil_parasitic_gas_perc_change.setDisplayName('Percent Change for coil parasitic gas load.')
140
+ coil_parasitic_gas_perc_change.setDescription('Percent Change for coil parasitic gas load.')
141
+ coil_parasitic_gas_perc_change.setDefaultValue(0.0)
142
+ args << coil_parasitic_gas_perc_change
143
+
144
+ args
145
+ end
146
+
147
+ # define what happens when the measure is run
148
+ def run(model, runner, user_arguments)
149
+ super(model, runner, user_arguments)
150
+
151
+ # use the built-in error checking
152
+ unless runner.validateUserArguments(arguments(model), user_arguments)
153
+ return false
154
+ end
155
+
156
+ # assign the user inputs to variables
157
+ coil_object = runner.getOptionalWorkspaceObjectChoiceValue('coil', user_arguments, model)
158
+ coil_handle = runner.getStringArgumentValue('coil', user_arguments)
159
+
160
+ coil_capacity_perc_change = runner.getDoubleArgumentValue('coil_capacity_perc_change', user_arguments)
161
+ coil_efficiency_perc_change = runner.getDoubleArgumentValue('coil_efficiency_perc_change', user_arguments)
162
+ coil_parasitic_electric_perc_change = runner.getDoubleArgumentValue('coil_parasitic_electric_perc_change', user_arguments)
163
+ coil_parasitic_gas_perc_change = runner.getDoubleArgumentValue('coil_parasitic_gas_perc_change', user_arguments)
164
+
165
+ # find objects to change
166
+ coils = []
167
+ building = model.getBuilding
168
+ building_handle = building.handle.to_s
169
+ runner.registerInfo("coil_handle: #{coil_handle}")
170
+ # setup coils
171
+ if coil_handle == building_handle
172
+ # Use ALL coils
173
+ runner.registerInfo('Applying change to ALL Coils')
174
+ loops = model.getAirLoopHVACs
175
+ # loop through air loops
176
+ loops.each do |loop|
177
+ supply_components = loop.supplyComponents
178
+ # find coils on loops
179
+ supply_components.each do |supply_component|
180
+ unless supply_component.to_CoilHeatingGas.empty?
181
+ coils << supply_component.to_CoilHeatingGas.get
182
+ end
183
+ end
184
+ end
185
+ elsif coil_handle == 0.to_s
186
+ # coils set to NONE so do nothing
187
+ runner.registerInfo('Applying change to NONE Coils')
188
+ elsif !coil_handle.empty?
189
+ # Single coil handle found, check if object is good
190
+ if !coil_object.get.to_CoilHeatingGas.empty?
191
+ runner.registerInfo("Applying change to #{coil_object.get.name} coil")
192
+ coils << coil_object.get.to_CoilHeatingGas.get
193
+ else
194
+ runner.registerError("coil with handle #{coil_handle} could not be found.")
195
+ end
196
+ else
197
+ runner.registerError('coil handle is empty.')
198
+ return false
199
+ end
200
+
201
+ # report initial condition of model
202
+ runner.registerInitialCondition("Coils to change: #{coils.size}")
203
+ runner.registerInfo("Coils to change: #{coils.size}")
204
+ altered_coils = []
205
+ altered_capacity = []
206
+ altered_parasiteelectric = []
207
+ altered_coilefficiency = []
208
+ altered_parasitegas = []
209
+ # loop through coils
210
+ coils.each do |coil|
211
+ altered_coil = false
212
+ # coil_capacity_perc_change
213
+ if coil_capacity_perc_change != 0.0
214
+ if coil.nominalCapacity.is_initialized
215
+ runner.registerInfo("Applying nominalCapacity #{coil_capacity_perc_change} Percent Change to #{coil.name.get}.")
216
+ coil.setNominalCapacity(coil.nominalCapacity.get + coil.nominalCapacity.get * coil_capacity_perc_change * 0.01)
217
+ altered_capacity << coil.handle.to_s
218
+ altered_coil = true
219
+ end
220
+ end
221
+
222
+ # modify coil_efficiency_perc_change
223
+ if coil_efficiency_perc_change != 0.0
224
+ runner.registerInfo("Applying gasBurnerEfficiency #{coil_efficiency_perc_change} Percent Change to #{coil.name.get}.")
225
+ if (coil.gasBurnerEfficiency + coil.gasBurnerEfficiency * coil_efficiency_perc_change * 0.01) <= 1
226
+ coil.setGasBurnerEfficiency(coil.gasBurnerEfficiency + coil.gasBurnerEfficiency * coil_efficiency_perc_change * 0.01)
227
+ else
228
+ coil.setGasBurnerEfficiency(1.0)
229
+ runner.registerWarning("#{coil_efficiency_perc_change} Percent Change results in Efficiency greater than 1.")
230
+ end
231
+ altered_coilefficiency << coil.handle.to_s
232
+ altered_coil = true
233
+ end
234
+
235
+ # coil_parasitic_electric_perc_change
236
+ if coil_parasitic_electric_perc_change != 0.0
237
+ runner.registerInfo("Applying parasiticElectricLoad #{coil_parasitic_electric_perc_change} Percent Change to #{coil.name.get}.")
238
+ coil.setParasiticElectricLoad(coil.parasiticElectricLoad + coil.parasiticElectricLoad * coil_parasitic_electric_perc_change * 0.01)
239
+ altered_parasiteelectric << coil.handle.to_s
240
+ altered_coil = true
241
+ end
242
+
243
+ # coil_parasitic_gas_perc_change
244
+ if coil_parasitic_gas_perc_change != 0.0
245
+ runner.registerInfo("Applying parasiticGasLoad #{coil_parasitic_gas_perc_change} Percent Change to #{coil.name.get}.")
246
+ coil.setParasiticGasLoad(coil.parasiticGasLoad + coil.parasiticGasLoad * coil_parasitic_gas_perc_change * 0.01)
247
+ altered_parasitegas << coil.handle.to_s
248
+ altered_coil = true
249
+ end
250
+
251
+ next unless altered_coil
252
+ altered_coils << coil.handle.to_s
253
+ change_name(coil, coil_parasitic_gas_perc_change, coil_efficiency_perc_change, coil_parasitic_electric_perc_change, coil_capacity_perc_change)
254
+ runner.registerInfo("coil name changed to: #{coil.name.get}")
255
+ end # end coil loop
256
+
257
+ # na if nothing in model to look at
258
+ if altered_coils.empty?
259
+ runner.registerAsNotApplicable('No Coils were altered in the model')
260
+ return true
261
+ end
262
+
263
+ # report final condition of model
264
+ runner.registerFinalCondition("#{altered_coils.size} Coils objects were altered.")
265
+
266
+ true
267
+ end
268
+ end
269
+
270
+ # register the measure to be used by the application
271
+ CoilHeatingGasPercentChange.new.registerWithApplication
@@ -0,0 +1,111 @@
1
+ <measure>
2
+ <schema_version>3.0</schema_version>
3
+ <name>coil_heating_gas_percent_change</name>
4
+ <uid>8589af79-cfe7-45fb-9c79-e7b95e5fb02f</uid>
5
+ <version_id>3591edb1-4d18-493c-b290-8c6287dd10c1</version_id>
6
+ <version_modified>20200325T030944Z</version_modified>
7
+ <xml_checksum>1F3D2430</xml_checksum>
8
+ <class_name>CoilHeatingGasPercentChange</class_name>
9
+ <display_name>Heating Coils Gas Percent Change</display_name>
10
+ <description>This is a general purpose measure to calibrate Gas Heating Coils with a Percent Change.</description>
11
+ <modeler_description>It will be used for calibration of rated capacity and efficiency and parasitic loads. User can choose between a SINGLE coil or ALL the Coils.</modeler_description>
12
+ <arguments>
13
+ <argument>
14
+ <name>coil</name>
15
+ <display_name>Apply the Measure to a SINGLE Gas Heating Coil, ALL the Gas Heating Coils or NONE.</display_name>
16
+ <type>Choice</type>
17
+ <required>true</required>
18
+ <model_dependent>false</model_dependent>
19
+ <default_value>*All Gas Heating Coils*</default_value>
20
+ <choices>
21
+ <choice>
22
+ <value>{a20d912d-d927-4389-a1e6-ac7cde75c769}</value>
23
+ <display_name>*All Gas Heating Coils*</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>coil_efficiency_perc_change</name>
33
+ <display_name>Percent Change for coil Efficiency.</display_name>
34
+ <description>Percent Change for coil Efficiency.</description>
35
+ <type>Double</type>
36
+ <required>true</required>
37
+ <model_dependent>false</model_dependent>
38
+ <default_value>0</default_value>
39
+ </argument>
40
+ <argument>
41
+ <name>coil_capacity_perc_change</name>
42
+ <display_name>Percent Change for coil Capacity.</display_name>
43
+ <description>Percent Change for coil Capacity.</description>
44
+ <type>Double</type>
45
+ <required>true</required>
46
+ <model_dependent>false</model_dependent>
47
+ <default_value>0</default_value>
48
+ </argument>
49
+ <argument>
50
+ <name>coil_parasitic_electric_perc_change</name>
51
+ <display_name>Percent Change for coil parasitic electric load.</display_name>
52
+ <description>Percent Change for coil parasitic electric load.</description>
53
+ <type>Double</type>
54
+ <required>true</required>
55
+ <model_dependent>false</model_dependent>
56
+ <default_value>0</default_value>
57
+ </argument>
58
+ <argument>
59
+ <name>coil_parasitic_gas_perc_change</name>
60
+ <display_name>Percent Change for coil parasitic gas load.</display_name>
61
+ <description>Percent Change for coil parasitic gas load.</description>
62
+ <type>Double</type>
63
+ <required>true</required>
64
+ <model_dependent>false</model_dependent>
65
+ <default_value>0</default_value>
66
+ </argument>
67
+ </arguments>
68
+ <outputs/>
69
+ <provenances/>
70
+ <tags>
71
+ <tag>HVAC.Heating</tag>
72
+ </tags>
73
+ <attributes>
74
+ <attribute>
75
+ <name>Measure Type</name>
76
+ <value>ModelMeasure</value>
77
+ <datatype>string</datatype>
78
+ </attribute>
79
+ </attributes>
80
+ <files>
81
+ <file>
82
+ <filename>LICENSE.md</filename>
83
+ <filetype>md</filetype>
84
+ <usage_type>license</usage_type>
85
+ <checksum>E0468DD6</checksum>
86
+ </file>
87
+ <file>
88
+ <filename>README.md.erb</filename>
89
+ <filetype>erb</filetype>
90
+ <usage_type>readmeerb</usage_type>
91
+ <checksum>703C9964</checksum>
92
+ </file>
93
+ <file>
94
+ <filename>README.md</filename>
95
+ <filetype>md</filetype>
96
+ <usage_type>readme</usage_type>
97
+ <checksum>92E7D6F3</checksum>
98
+ </file>
99
+ <file>
100
+ <version>
101
+ <software_program>OpenStudio</software_program>
102
+ <identifier>2.1.0</identifier>
103
+ <min_compatible>2.1.0</min_compatible>
104
+ </version>
105
+ <filename>measure.rb</filename>
106
+ <filetype>rb</filetype>
107
+ <usage_type>script</usage_type>
108
+ <checksum>925516DE</checksum>
109
+ </file>
110
+ </files>
111
+ </measure>