openstudio-calibration 0.1.3 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (162) hide show
  1. checksums.yaml +5 -5
  2. data/.gitignore +1 -0
  3. data/.rubocop.yml +7 -0
  4. data/CHANGELOG.md +40 -8
  5. data/Gemfile +6 -3
  6. data/Jenkinsfile +7 -2
  7. data/LICENSE.md +1 -1
  8. data/README.md +15 -4
  9. data/Rakefile +6 -6
  10. data/doc_templates/LICENSE.md +1 -1
  11. data/doc_templates/copyright_erb.txt +1 -1
  12. data/doc_templates/copyright_js.txt +1 -1
  13. data/doc_templates/copyright_ruby.txt +1 -1
  14. data/lib/measures/AddMonthlyJSONUtilityData/LICENSE.md +1 -1
  15. data/lib/measures/AddMonthlyJSONUtilityData/measure.rb +1 -1
  16. data/lib/measures/AddMonthlyJSONUtilityData/measure.xml +12 -11
  17. data/lib/measures/AddMonthlyUtilityData/LICENSE.md +1 -1
  18. data/lib/measures/AddMonthlyUtilityData/measure.rb +1 -1
  19. data/lib/measures/AddMonthlyUtilityData/measure.xml +13 -12
  20. data/lib/measures/CalibrationReports/LICENSE.md +1 -1
  21. data/lib/measures/CalibrationReports/README.md +2 -2
  22. data/lib/measures/CalibrationReports/measure.rb +1 -1
  23. data/lib/measures/CalibrationReports/measure.xml +11 -11
  24. data/lib/measures/CalibrationReportsEnhanced/LICENSE.md +1 -1
  25. data/lib/measures/CalibrationReportsEnhanced/measure.rb +2 -2
  26. data/lib/measures/CalibrationReportsEnhanced/measure.xml +18 -17
  27. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/LICENSE.md +1 -1
  28. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/measure.rb +1 -1
  29. data/lib/measures/CoilCoolingDXSingleSpeedMultiplier/measure.xml +14 -13
  30. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/LICENSE.md +1 -1
  31. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/measure.rb +1 -1
  32. data/lib/measures/CoilCoolingDXSingleSpeedPercentChange/measure.xml +14 -13
  33. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/LICENSE.md +1 -1
  34. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/measure.rb +1 -1
  35. data/lib/measures/CoilCoolingDXTwoSpeedMultiplier/measure.xml +14 -13
  36. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/LICENSE.md +1 -1
  37. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/measure.rb +1 -1
  38. data/lib/measures/CoilCoolingDXTwoSpeedPercentChange/measure.xml +14 -13
  39. data/lib/measures/CoilCoolingWaterMultiplier/LICENSE.md +1 -1
  40. data/lib/measures/CoilCoolingWaterMultiplier/measure.rb +1 -1
  41. data/lib/measures/CoilCoolingWaterMultiplier/measure.xml +14 -13
  42. data/lib/measures/CoilCoolingWaterPercentChange/LICENSE.md +1 -1
  43. data/lib/measures/CoilCoolingWaterPercentChange/measure.rb +1 -1
  44. data/lib/measures/CoilCoolingWaterPercentChange/measure.xml +14 -13
  45. data/lib/measures/CoilHeatingElectricMultiplier/LICENSE.md +1 -1
  46. data/lib/measures/CoilHeatingElectricMultiplier/measure.rb +1 -1
  47. data/lib/measures/CoilHeatingElectricMultiplier/measure.xml +14 -13
  48. data/lib/measures/CoilHeatingElectricPercentChange/LICENSE.md +1 -1
  49. data/lib/measures/CoilHeatingElectricPercentChange/measure.rb +1 -1
  50. data/lib/measures/CoilHeatingElectricPercentChange/measure.xml +14 -13
  51. data/lib/measures/CoilHeatingGasMultiplier/LICENSE.md +1 -1
  52. data/lib/measures/CoilHeatingGasMultiplier/measure.rb +1 -1
  53. data/lib/measures/CoilHeatingGasMultiplier/measure.xml +14 -13
  54. data/lib/measures/CoilHeatingGasPercentChange/LICENSE.md +1 -1
  55. data/lib/measures/CoilHeatingGasPercentChange/measure.rb +1 -1
  56. data/lib/measures/CoilHeatingGasPercentChange/measure.xml +14 -13
  57. data/lib/measures/CoilHeatingWaterMultiplier/LICENSE.md +1 -1
  58. data/lib/measures/CoilHeatingWaterMultiplier/measure.rb +1 -1
  59. data/lib/measures/CoilHeatingWaterMultiplier/measure.xml +14 -13
  60. data/lib/measures/CoilHeatingWaterPercentChange/LICENSE.md +1 -1
  61. data/lib/measures/CoilHeatingWaterPercentChange/measure.rb +1 -1
  62. data/lib/measures/CoilHeatingWaterPercentChange/measure.xml +14 -13
  63. data/lib/measures/ConstructionLayerZeroMaterialProperties/LICENSE.md +1 -1
  64. data/lib/measures/ConstructionLayerZeroMaterialProperties/measure.rb +1 -1
  65. data/lib/measures/ConstructionLayerZeroMaterialProperties/measure.xml +12 -11
  66. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/LICENSE.md +1 -1
  67. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/measure.rb +1 -1
  68. data/lib/measures/ElectricBaseboardEfficiencyAndCapacity/measure.xml +12 -11
  69. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/LICENSE.md +1 -1
  70. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/measure.rb +3 -3
  71. data/lib/measures/ExteriorWallThermalPropertiesMultiplier/measure.xml +24 -11
  72. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/LICENSE.md +1 -1
  73. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/measure.rb +3 -3
  74. data/lib/measures/ExteriorWallThermalPropertiesPercentChange/measure.xml +24 -11
  75. data/lib/measures/FansMultiplier/LICENSE.md +1 -1
  76. data/lib/measures/FansMultiplier/measure.rb +1 -1
  77. data/lib/measures/FansMultiplier/measure.xml +14 -13
  78. data/lib/measures/FansPercentChange/LICENSE.md +1 -1
  79. data/lib/measures/FansPercentChange/measure.rb +1 -1
  80. data/lib/measures/FansPercentChange/measure.xml +14 -13
  81. data/lib/measures/GeneralCalibrationMeasureMultiplier/LICENSE.md +1 -1
  82. data/lib/measures/GeneralCalibrationMeasureMultiplier/measure.rb +1 -1
  83. data/lib/measures/GeneralCalibrationMeasureMultiplier/measure.xml +16 -15
  84. data/lib/measures/GeneralCalibrationMeasurePercentChange/LICENSE.md +1 -1
  85. data/lib/measures/GeneralCalibrationMeasurePercentChange/measure.rb +1 -1
  86. data/lib/measures/GeneralCalibrationMeasurePercentChange/measure.xml +16 -15
  87. data/lib/measures/HardSizeHvac/LICENSE.md +1 -1
  88. data/lib/measures/HardSizeHvac/measure.rb +1 -1
  89. data/lib/measures/HardSizeHvac/measure.xml +13 -12
  90. data/lib/measures/RValueOfInsulationForConstructionMultiplier/LICENSE.md +1 -1
  91. data/lib/measures/RValueOfInsulationForConstructionMultiplier/measure.rb +1 -1
  92. data/lib/measures/RValueOfInsulationForConstructionMultiplier/measure.xml +12 -11
  93. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/LICENSE.md +1 -1
  94. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/measure.rb +1 -1
  95. data/lib/measures/RValueOfInsulationForConstructionPercentageChange/measure.xml +12 -11
  96. data/lib/measures/RoofThermalPropertiesMultiplier/LICENSE.md +1 -1
  97. data/lib/measures/RoofThermalPropertiesMultiplier/measure.rb +3 -3
  98. data/lib/measures/RoofThermalPropertiesMultiplier/measure.xml +24 -11
  99. data/lib/measures/RoofThermalPropertiesPercentChange/LICENSE.md +1 -1
  100. data/lib/measures/RoofThermalPropertiesPercentChange/measure.rb +3 -3
  101. data/lib/measures/RoofThermalPropertiesPercentChange/measure.xml +24 -11
  102. data/lib/measures/TimeseriesObjectiveFunction/LICENSE.md +1 -1
  103. data/lib/measures/TimeseriesObjectiveFunction/README.md +5 -171
  104. data/lib/measures/TimeseriesObjectiveFunction/measure.rb +3 -7
  105. data/lib/measures/TimeseriesObjectiveFunction/measure.xml +84 -9
  106. data/lib/measures/TimeseriesObjectiveFunction/resources/report.html.erb +6 -1
  107. data/lib/measures/TimeseriesPlot/LICENSE.md +1 -1
  108. data/lib/measures/TimeseriesPlot/README.md +5 -35
  109. data/lib/measures/TimeseriesPlot/measure.rb +1 -1
  110. data/lib/measures/TimeseriesPlot/measure.xml +28 -13
  111. data/lib/measures/TimeseriesPlot/resources/report.html.erb +6 -1
  112. data/lib/measures/WaterHeaterMixedMultiplier/LICENSE.md +1 -1
  113. data/lib/measures/WaterHeaterMixedMultiplier/measure.rb +1 -1
  114. data/lib/measures/WaterHeaterMixedMultiplier/measure.xml +14 -13
  115. data/lib/measures/WaterHeaterMixedPercentChange/LICENSE.md +1 -1
  116. data/lib/measures/WaterHeaterMixedPercentChange/measure.rb +1 -1
  117. data/lib/measures/WaterHeaterMixedPercentChange/measure.xml +14 -13
  118. data/lib/measures/{CalibrationReportsEnhanced21 → inspect_and_edit_parametric_schedules}/LICENSE.md +1 -1
  119. data/lib/measures/inspect_and_edit_parametric_schedules/README.md +41 -0
  120. data/lib/measures/{zone_report → inspect_and_edit_parametric_schedules}/README.md.erb +12 -1
  121. data/lib/measures/inspect_and_edit_parametric_schedules/docs/.gitkeep +0 -0
  122. data/lib/measures/inspect_and_edit_parametric_schedules/docs/apply_measures_now.png +0 -0
  123. data/lib/measures/inspect_and_edit_parametric_schedules/measure.rb +224 -0
  124. data/lib/measures/inspect_and_edit_parametric_schedules/measure.xml +125 -0
  125. data/lib/measures/{zone_report → shift_hours_of_operation}/LICENSE.md +1 -1
  126. data/lib/measures/shift_hours_of_operation/README.md +147 -0
  127. data/lib/measures/{MaalkaMonthlyJSONUtilityData → shift_hours_of_operation}/README.md.erb +5 -0
  128. data/lib/measures/shift_hours_of_operation/docs/.gitkeep +0 -0
  129. data/lib/measures/shift_hours_of_operation/measure.rb +525 -0
  130. data/lib/measures/shift_hours_of_operation/measure.xml +280 -0
  131. data/lib/openstudio/{calibration_measures → calibration}/extension.rb +2 -2
  132. data/lib/openstudio/{calibration_measures → calibration}/version.rb +3 -3
  133. data/lib/openstudio/{calibration_measures.rb → calibration.rb} +3 -3
  134. data/lib/{openstudio-calibration-measures.rb → openstudio-calibration.rb} +2 -2
  135. data/openstudio-calibration.gemspec +38 -0
  136. metadata +50 -61
  137. data/lib/measures/AddMonthlyUtilityData/tests/AddMonthlyUtilityData_Test.rb +0 -88
  138. data/lib/measures/AddMonthlyUtilityData/tests/electric_billed_usages.json +0 -198
  139. data/lib/measures/AddMonthlyUtilityData/tests/gas_billed_usages.json +0 -198
  140. data/lib/measures/CalibrationReports/tests/CalibrationReports_Test.rb +0 -523
  141. data/lib/measures/CalibrationReports/tests/ExampleModel.osm +0 -10497
  142. data/lib/measures/CalibrationReports/tests/ExampleModelNoDemandInput.osm +0 -10560
  143. data/lib/measures/CalibrationReports/tests/ExampleModelNoGasInput.osm +0 -10456
  144. data/lib/measures/CalibrationReports/tests/USA_CO_Golden-NREL.724666_TMY3.epw +0 -8768
  145. data/lib/measures/CalibrationReportsEnhanced/tests/CalibrationReportsEnhanced_Test.rb +0 -734
  146. data/lib/measures/CalibrationReportsEnhanced/tests/ExampleModel.osm +0 -10497
  147. data/lib/measures/CalibrationReportsEnhanced/tests/ExampleModel_FuelOil.osm +0 -12740
  148. data/lib/measures/CalibrationReportsEnhanced/tests/USA_CO_Golden-NREL.724666_TMY3.epw +0 -8768
  149. data/lib/measures/CalibrationReportsEnhanced21/README.md +0 -109
  150. data/lib/measures/CalibrationReportsEnhanced21/README.md.erb +0 -42
  151. data/lib/measures/CalibrationReportsEnhanced21/measure.rb +0 -690
  152. data/lib/measures/CalibrationReportsEnhanced21/measure.xml +0 -269
  153. data/lib/measures/CalibrationReportsEnhanced21/resources/report.html.in +0 -380
  154. data/lib/measures/MaalkaMonthlyJSONUtilityData/LICENSE.md +0 -27
  155. data/lib/measures/MaalkaMonthlyJSONUtilityData/README.md +0 -104
  156. data/lib/measures/MaalkaMonthlyJSONUtilityData/measure.rb +0 -304
  157. data/lib/measures/MaalkaMonthlyJSONUtilityData/measure.xml +0 -216
  158. data/lib/measures/zone_report/README.md +0 -26
  159. data/lib/measures/zone_report/measure.rb +0 -706
  160. data/lib/measures/zone_report/measure.xml +0 -67
  161. data/lib/measures/zone_report/resources/report.html.in +0 -342
  162. data/openstudio-calibration-measures.gemspec +0 -30
@@ -1,690 +0,0 @@
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
- require 'erb'
37
- require 'json'
38
-
39
- # start the measure
40
- class CalibrationReportsEnhanced21 < OpenStudio::Measure::ReportingMeasure
41
- # define the name that a user will see, this method may be deprecated as
42
- # the display name in PAT comes from the name field in measure.xml
43
- def name
44
- 'Calibration Reports Enhanced'
45
- end
46
-
47
- # human readable description
48
- def description
49
- 'This measure is intended for calibibration of modeled results against user entered utility bill.'
50
- end
51
-
52
- # human readable description of modeling approach
53
- def modeler_description
54
- 'Measure looks at consumption for electricity and natural gas, and demand for electricity. It is inteneded to be used with no more than one gas an electric bills. Each bill can have multiple billing periods. Make sure ot use an AMY matching the utility data time frame.'
55
- end
56
-
57
- # define the arguments that the user will input
58
- def arguments
59
- args = OpenStudio::Measure::OSArgumentVector.new
60
-
61
- # Electric NMBE limit
62
- electric_nmbe_limit = OpenStudio::Measure::OSArgument.makeDoubleArgument('electric_nmbe_limit', true)
63
- electric_nmbe_limit.setDisplayName('Electric NMBE limit (%)')
64
- electric_nmbe_limit.setDefaultValue(5.0)
65
- args << electric_nmbe_limit
66
-
67
- # Electric CVRMSE limit
68
- electric_cvrmse_limit = OpenStudio::Measure::OSArgument.makeDoubleArgument('electric_cvrmse_limit', true)
69
- electric_cvrmse_limit.setDisplayName('Electric CVRMSE limit (%)')
70
- electric_cvrmse_limit.setDefaultValue(15.0)
71
- args << electric_cvrmse_limit
72
-
73
- # Gas NMBE limit
74
- gas_nmbe_limit = OpenStudio::Measure::OSArgument.makeDoubleArgument('gas_nmbe_limit', true)
75
- gas_nmbe_limit.setDisplayName('Gas NMBE limit (%)')
76
- gas_nmbe_limit.setDefaultValue(5.0)
77
- args << gas_nmbe_limit
78
-
79
- # Gas CVRMSE limit
80
- gas_cvrmse_limit = OpenStudio::Measure::OSArgument.makeDoubleArgument('gas_cvrmse_limit', true)
81
- gas_cvrmse_limit.setDisplayName('Gas CVRMSE limit (%)')
82
- gas_cvrmse_limit.setDefaultValue(15.0)
83
- args << gas_cvrmse_limit
84
-
85
- args
86
- end # end the arguments method
87
-
88
- def outputs
89
- result = OpenStudio::Measure::OSOutputVector.new
90
-
91
- # electric consumption values
92
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_consumption_actual') # kWh
93
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_consumption_modeled') # kWh
94
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_consumption_cvrmse') # %
95
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_consumption_nmbe') # %
96
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_sum_of_squares') # kWh
97
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_dof') # na
98
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_rmse') # kWh^0.5
99
-
100
- # electric peak values
101
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_peak_demand_nmbe') # %
102
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_peak_demand_actual') # kW
103
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_peak_demand_modeled') # kW
104
-
105
- # gas consumption values
106
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_consumption_actual') # therms
107
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_consumption_modeled') # therms
108
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_consumption_cvrmse') # %
109
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_consumption_nmbe') # %
110
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_sum_of_squares') # therms
111
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_dof') # na
112
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_rmse') # therms^0.5
113
-
114
- # total fuel values (gas plus electric only? not district?)
115
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('total_sum_of_squares') # kBtu
116
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('total_dof') # na
117
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('total_rmse') # kBtu^0.5
118
-
119
- # within limit check values
120
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_cvrmse_within_limit') # na
121
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('electricity_nmbe_within_limit') # na
122
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_cvrmse_within_limit') # na
123
- result << OpenStudio::Measure::OSOutput.makeDoubleOutput('natural_gas_nmbe_within_limit') # na
124
-
125
- result
126
- end
127
-
128
- # define what happens when the measure is run
129
- def run(runner, user_arguments)
130
- super(runner, user_arguments)
131
-
132
- # use the built-in error checking
133
- return false unless runner.validateUserArguments(arguments, user_arguments)
134
-
135
- electric_nmbe_limit = runner.getDoubleArgumentValue('electric_nmbe_limit', user_arguments)
136
- electric_cvrmse_limit = runner.getDoubleArgumentValue('electric_cvrmse_limit', user_arguments)
137
- gas_nmbe_limit = runner.getDoubleArgumentValue('gas_nmbe_limit', user_arguments)
138
- gas_cvrmse_limit = runner.getDoubleArgumentValue('gas_cvrmse_limit', user_arguments)
139
-
140
- os_version = OpenStudio::VersionString.new(OpenStudio.openStudioVersion)
141
- min_version_feature1 = OpenStudio::VersionString.new('1.2.2')
142
-
143
- # get the last model and sql file
144
-
145
- model = runner.lastOpenStudioModel
146
- if model.empty?
147
- runner.registerError('Cannot find last model.')
148
- return false
149
- end
150
- model = model.get
151
-
152
- sqlFile = runner.lastEnergyPlusSqlFile
153
- if sqlFile.empty?
154
- runner.registerError('Cannot find last sql file.')
155
- return false
156
- end
157
- sqlFile = sqlFile.get
158
- model.setSqlFile(sqlFile)
159
-
160
- # put data into variables, these are available in the local scope binding
161
- # building_name = model.getBuilding.name.get
162
-
163
- web_asset_path = OpenStudio.getSharedResourcesPath / OpenStudio::Path.new('web_assets')
164
-
165
- energy = ''
166
-
167
- calibrationGuidelines = OpenStudio::Model::UtilityBill.calibrationGuidelines
168
- energy << 'var calibrationGuidelines = ['
169
- calibrationGuidelines.each do |calibrationGuideline|
170
- energy << '"' << calibrationGuideline << '",'
171
- end
172
- energy = energy[0..-2]
173
- energy << "];\n"
174
-
175
- maxNMBE = OpenStudio::Model::UtilityBill.maxNMBE(calibrationGuidelines[0])
176
- energy << 'var ashraeMaxNMBE = '
177
- energy << if !maxNMBE.empty?
178
- maxNMBE.get.to_s
179
- else
180
- 'N/A'
181
- end
182
- energy << ";\n"
183
- if os_version >= min_version_feature1
184
- runner.registerValue('ashrae_max_nmbe', maxNMBE.get, '%')
185
- end
186
-
187
- maxCVRMSE = OpenStudio::Model::UtilityBill.maxCVRMSE(calibrationGuidelines[0])
188
- energy << 'var ashraeMaxCVRMSE = '
189
- energy << if !maxCVRMSE.empty?
190
- maxCVRMSE.get.to_s
191
- else
192
- 'N/A'
193
- end
194
- energy << ";\n"
195
- if os_version >= min_version_feature1
196
- runner.registerValue('ashrae_max_cvrmse', maxCVRMSE.get, '%')
197
- end
198
-
199
- maxNMBE = OpenStudio::Model::UtilityBill.maxNMBE(calibrationGuidelines[1])
200
- energy << 'var fempMaxNMBE = '
201
- energy << if !maxNMBE.empty?
202
- maxNMBE.get.to_s
203
- else
204
- 'N/A'
205
- end
206
- energy << ";\n"
207
- if os_version >= min_version_feature1
208
- runner.registerValue('femp_max_nmbe', maxNMBE.get, '%')
209
- end
210
-
211
- maxCVRMSE = OpenStudio::Model::UtilityBill.maxCVRMSE(calibrationGuidelines[1])
212
- energy << 'var fempMaxCVRMSE = '
213
- energy << if !maxCVRMSE.empty?
214
- maxCVRMSE.get.to_s
215
- else
216
- 'N/A'
217
- end
218
- energy << ";\n"
219
- if os_version >= min_version_feature1
220
- runner.registerValue('femp_max_cvrmse', maxCVRMSE.get, '%')
221
- end
222
-
223
- energyElec = "\t\"Electricity Consumption\":{\n\t\t\"units\":\"kWh\",\n"
224
- energyDemand = "\t\"Electricity Demand\":{\n\t\t\"units\":\"kW\",\n"
225
- energyGas = "\t\"Natural Gas Consumption\":{\n\t\t\"units\":\"therms\",\n"
226
- tempStartDate = ''
227
- tempEndDate = ''
228
- elecStartDate = "\t\t\t\t\"Start\":["
229
- elecEndDate = "\t\t\t\t\"End\":["
230
- gasStartDate = "\t\t\t\t\"Start\":["
231
- gasEndDate = "\t\t\t\t\"End\":["
232
- elecActualConsumption = "\t\t\t\t\"Actual\":["
233
- elecModelConsumption = "\t\t\t\t\"Model\":["
234
- actualPeakDemand = "\t\t\t\t\"Actual\":["
235
- modelPeakDemand = "\t\t\t\t\"Model\":["
236
- gasActualConsumption = "\t\t\t\t\"Actual\":["
237
- gasModelConsumption = "\t\t\t\t\"Model\":["
238
- elecNMBE = "\t\t\t\t\"NMBE\":["
239
- demandNMBE = "\t\t\t\t\"NMBE\":["
240
- gasNMBE = "\t\t\t\t\"NMBE\":["
241
- peakDemandUnitConversionFactor = 1.0
242
- consumptionUnitConversionFactor = 1.0
243
- hasElec = false
244
- hasDemand = false
245
- hasGas = false
246
-
247
- missingData = false
248
- # must have a runPeriod
249
- runPeriod = model.runPeriod
250
- if runPeriod.empty?
251
- missingData = true
252
- runner.registerWarning('Model has no run period and cannot generate all data.')
253
- end
254
-
255
- # must have a calendarYear to generate model data
256
- yearDescription = model.yearDescription
257
- if yearDescription.empty?
258
- missingData = true
259
- runner.registerWarning('Model has no year description and cannot generate all data.')
260
- end
261
- calendarYear = yearDescription.get.calendarYear
262
- if calendarYear.empty?
263
- missingData = true
264
- runner.registerWarning('Model has no calendar year and cannot generate all data.')
265
- end
266
-
267
- all_actual_consumption_values = []
268
- all_modeled_consumption_values = []
269
-
270
- # sort bills by fuel type and name
271
- utilityBills = model.getUtilityBills.sort { |x, y| (x.fuelType.valueDescription + x.name.get) <=> (y.fuelType.valueDescription + y.name.get) }
272
- registered_fuel_types = []
273
-
274
- utilityBills.each do |utilityBill|
275
- utility_bill_name = OpenStudio.toUnderscoreCase(utilityBill.name.get)
276
- utility_bill_fuel_type = OpenStudio.toUnderscoreCase(utilityBill.fuelType.valueDescription)
277
- if registered_fuel_types.include?(utility_bill_fuel_type)
278
- runner.registerWarning("More than one utility bill of fuel type #{utility_bill_fuel_type} is in the model. Skipping #{utility_bill_name}.")
279
- next
280
- else
281
- registered_fuel_types << utility_bill_fuel_type
282
- end
283
-
284
- cvrsme = 0.0
285
- unless utilityBill.CVRMSE.empty?
286
- cvrsme = utilityBill.CVRMSE.get
287
- if os_version >= min_version_feature1
288
- runner.registerValue("#{utility_bill_fuel_type}_consumption_cvrmse", cvrsme, '%')
289
- end
290
- cvrsme = format '%.2f', cvrsme
291
- end
292
-
293
- nmbe = 0.0
294
- unless utilityBill.NMBE.empty?
295
- nmbe = utilityBill.NMBE.get
296
- if os_version >= min_version_feature1
297
- runner.registerValue("#{utility_bill_fuel_type}_consumption_nmbe", nmbe, '%')
298
- end
299
- nmbe = format '%.2f', nmbe
300
- end
301
-
302
- string = ''
303
- string << "\t\t\"cvrsme\":\"" << cvrsme.to_s << "\",\n\t\t\"nmbe\":\"" << nmbe.to_s << "\",\n\t\t\t\"data\":{\n"
304
-
305
- hasDemandValues = false
306
- if !utilityBill.peakDemandUnitConversionFactor.empty?
307
- hasDemandValues = true
308
- energyElec << string
309
- energyDemand << string
310
- peakDemandUnitConversionFactor = utilityBill.peakDemandUnitConversionFactor.get
311
- else
312
- hasDemandValues = false
313
- energyGas << string
314
- end
315
-
316
- consumptionUnitConversionFactor = utilityBill.consumptionUnitConversionFactor
317
-
318
- period_index = 1
319
- actual_consumption = 0.0
320
- modeled_consumption = 0.0
321
- actual_consumption_values = []
322
- modeled_consumption_values = []
323
- actual_demand = 0.0
324
- modeled_demand = 0.0
325
-
326
- utilityBill.billingPeriods.each do |billingPeriod|
327
- tempStartDate = '"' << billingPeriod.startDate.monthOfYear.value.to_s
328
- tempStartDate << '/'
329
- tempStartDate << billingPeriod.startDate.dayOfMonth.to_s << '"'
330
- tempEndDate = '"' << billingPeriod.endDate.monthOfYear.value.to_s
331
- tempEndDate << '/'
332
- tempEndDate << billingPeriod.endDate.dayOfMonth.to_s << '"'
333
- if os_version >= min_version_feature1
334
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_start_date", billingPeriod.startDate.to_s)
335
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_end_date", billingPeriod.endDate.to_s)
336
- end
337
-
338
- if hasDemandValues
339
- elecStartDate << tempStartDate << ','
340
- elecEndDate << tempEndDate << ','
341
-
342
- consumption = billingPeriod.consumption
343
- if !consumption.empty?
344
- hasElec = true
345
- elecActualConsumption << consumption.get.to_s
346
- actual_consumption += consumption.get
347
- actual_consumption_values << consumption.get
348
- all_actual_consumption_values << consumption.get * utilityBill.consumptionUnitConversionFactor
349
- if os_version >= min_version_feature1
350
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_consumption_actual",
351
- consumption.get,
352
- utilityBill.consumptionUnit)
353
- end
354
- else
355
- elecActualConsumption << '0'
356
- end
357
- elecActualConsumption << ','
358
-
359
- consumption = billingPeriod.modelConsumption
360
- if !consumption.empty?
361
- hasElec = true
362
- temp = consumption.get / consumptionUnitConversionFactor
363
- elecModelConsumption << temp.round(2).to_s
364
- modeled_consumption += temp
365
- modeled_consumption_values << temp
366
- all_modeled_consumption_values << consumption.get
367
- if os_version >= min_version_feature1
368
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_consumption_modeled",
369
- temp,
370
- utilityBill.consumptionUnit)
371
- end
372
- else
373
- elecModelConsumption << '0'
374
- end
375
- elecModelConsumption << ','
376
-
377
- peakDemand = billingPeriod.peakDemand
378
- if !peakDemand.empty?
379
- hasDemand = true
380
- actualPeakDemand << peakDemand.get.to_s
381
- actual_demand = peakDemand.get if peakDemand.get > actual_demand
382
- if os_version >= min_version_feature1
383
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_peak_demand_actual",
384
- peakDemand.get,
385
- utilityBill.peakDemandUnit.get)
386
- end
387
- else
388
- actualPeakDemand << '0'
389
- end
390
- actualPeakDemand << ','
391
-
392
- peakDemand = billingPeriod.modelPeakDemand
393
- if !peakDemand.empty?
394
- hasDemand = true
395
- temp = peakDemand.get / 1000
396
- temp_str = format '%.1f', temp
397
- modelPeakDemand << temp_str.to_s
398
- modeled_demand = temp if temp > modeled_demand
399
- if os_version >= min_version_feature1
400
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_peak_demand_modeled",
401
- temp,
402
- utilityBill.peakDemandUnit.get)
403
- end
404
- else
405
- modelPeakDemand << '0'
406
- end
407
- modelPeakDemand << ','
408
-
409
- if !billingPeriod.peakDemand.empty? && !billingPeriod.modelPeakDemand.empty? && (billingPeriod.consumption.get != 0)
410
- percent = 100 * ((billingPeriod.modelPeakDemand.get / 1000) - billingPeriod.peakDemand.get) / billingPeriod.peakDemand.get
411
- percent_str = format '%.2f', percent
412
- demandNMBE << percent_str.to_s
413
- if os_version >= min_version_feature1
414
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_peak_demand_nmbe",
415
- percent,
416
- '%')
417
- end
418
- else
419
- demandNMBE << '0'
420
- end
421
- demandNMBE << ','
422
-
423
- if !billingPeriod.consumption.empty? && !billingPeriod.modelConsumption.empty? && (billingPeriod.consumption.get != 0)
424
- percent = 100 * ((billingPeriod.modelConsumption.get / consumptionUnitConversionFactor) - billingPeriod.consumption.get) / billingPeriod.consumption.get
425
- percent_str = format '%.2f', percent
426
- elecNMBE << percent_str.to_s
427
- if os_version >= min_version_feature1
428
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_consumption_nmbe",
429
- percent,
430
- '%')
431
- end
432
- else
433
- elecNMBE << '0'
434
- end
435
- elecNMBE << ','
436
-
437
- else
438
- gasStartDate << tempStartDate << ','
439
- gasEndDate << tempEndDate << ','
440
-
441
- consumption = billingPeriod.consumption
442
- if !consumption.empty?
443
- hasGas = true
444
- gasActualConsumption << consumption.get.to_s
445
- actual_consumption += consumption.get
446
- actual_consumption_values << consumption.get
447
- all_actual_consumption_values << consumption.get * utilityBill.consumptionUnitConversionFactor
448
- if os_version >= min_version_feature1
449
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_consumption_actual",
450
- consumption.get,
451
- utilityBill.consumptionUnit)
452
- end
453
- else
454
- gasActualConsumption << '0'
455
- end
456
- gasActualConsumption << ','
457
-
458
- consumption = billingPeriod.modelConsumption
459
- if !consumption.empty?
460
- hasGas = true
461
- temp = consumption.get / consumptionUnitConversionFactor
462
- gasModelConsumption << temp.round(2).to_s
463
- modeled_consumption += temp
464
- modeled_consumption_values << temp
465
- all_modeled_consumption_values << consumption.get
466
- if os_version >= min_version_feature1
467
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_consumption_modeled",
468
- temp,
469
- utilityBill.consumptionUnit)
470
- end
471
- else
472
- gasModelConsumption << '0'
473
- end
474
- gasModelConsumption << ','
475
-
476
- if !billingPeriod.consumption.empty? && !billingPeriod.modelConsumption.empty? && (billingPeriod.consumption.get != 0)
477
- percent = 100 * ((billingPeriod.modelConsumption.get / consumptionUnitConversionFactor) - billingPeriod.consumption.get) / billingPeriod.consumption.get
478
- percent_str = format '%.2f', percent
479
- gasNMBE << percent_str.to_s
480
- if os_version >= min_version_feature1
481
- runner.registerValue("#{utility_bill_fuel_type}_period_#{period_index}_consumption_nmbe",
482
- percent,
483
- '%')
484
- end
485
- else
486
- gasNMBE << '0'
487
- end
488
- gasNMBE << ','
489
-
490
- end
491
- period_index += 1
492
- end
493
-
494
- next unless os_version >= min_version_feature1
495
- if actual_consumption > 0.0
496
- runner.registerValue("#{utility_bill_fuel_type}_consumption_actual",
497
- actual_consumption,
498
- utilityBill.consumptionUnit)
499
- runner.registerValue("#{utility_bill_fuel_type}_consumption_modeled",
500
- modeled_consumption,
501
- utilityBill.consumptionUnit)
502
- end
503
- if actual_demand > 0.0
504
- runner.registerValue("#{utility_bill_fuel_type}_peak_demand_actual",
505
- actual_demand,
506
- utilityBill.peakDemandUnit.get)
507
- runner.registerValue("#{utility_bill_fuel_type}_peak_demand_modeled",
508
- modeled_demand,
509
- utilityBill.peakDemandUnit.get)
510
- runner.registerValue("#{utility_bill_fuel_type}_peak_demand_nmbe",
511
- 100.0 * (modeled_demand - actual_demand) / actual_demand,
512
- '%')
513
- end
514
- next unless !actual_consumption_values.empty? && (actual_consumption_values.size == modeled_consumption_values.size)
515
- sum_squares = 0.0
516
- actual_consumption_values.each_index do |i|
517
- sum_squares += (actual_consumption_values[i] - modeled_consumption_values[i])**2
518
- end
519
- rmse = Math.sqrt(sum_squares / actual_consumption_values.size)
520
- runner.registerValue("#{utility_bill_fuel_type}_sum_of_squares",
521
- sum_squares,
522
- utilityBill.consumptionUnit)
523
- runner.registerValue("#{utility_bill_fuel_type}_dof",
524
- actual_consumption_values.size)
525
- runner.registerValue("#{utility_bill_fuel_type}_rmse",
526
- rmse,
527
- utilityBill.consumptionUnit + '^0.5')
528
- end
529
-
530
- if os_version >= min_version_feature1
531
- if !all_actual_consumption_values.empty? && (all_actual_consumption_values.size == all_modeled_consumption_values.size)
532
- sum_squares = 0.0
533
- all_actual_consumption_values.each_index do |i|
534
- sum_squares += (all_actual_consumption_values[i] - all_modeled_consumption_values[i])**2
535
- end
536
- rmse = Math.sqrt(sum_squares / all_actual_consumption_values.size)
537
- runner.registerValue('total_sum_of_squares',
538
- sum_squares,
539
- 'kBtu')
540
- runner.registerValue('total_dof',
541
- all_actual_consumption_values.size)
542
- runner.registerValue('total_rmse',
543
- rmse,
544
- 'kBtu^0.5')
545
- end
546
-
547
- end
548
-
549
- elecStartDate = elecStartDate[0..-2]
550
- elecStartDate << "],\n"
551
- elecEndDate = elecEndDate[0..-2]
552
- elecEndDate << "],\n"
553
- elecActualConsumption = elecActualConsumption[0..-2]
554
- elecActualConsumption << "],\n"
555
- elecModelConsumption = elecModelConsumption[0..-2]
556
- elecModelConsumption << "],\n"
557
- actualPeakDemand = actualPeakDemand[0..-2]
558
- actualPeakDemand << "],\n"
559
- modelPeakDemand = modelPeakDemand[0..-2]
560
- modelPeakDemand << "],\n"
561
- elecNMBE = elecNMBE[0..-2]
562
- elecNMBE << "]\n"
563
- demandNMBE = demandNMBE[0..-2]
564
- demandNMBE << "]\n"
565
- energyElec << elecStartDate << elecEndDate << elecActualConsumption << elecModelConsumption << elecNMBE
566
- energyElec << "\t\t}\n" << "\t},\n"
567
-
568
- energyDemand << elecStartDate << elecEndDate << actualPeakDemand << modelPeakDemand << demandNMBE
569
- energyDemand << "\t\t}\n" << "\t},\n"
570
-
571
- gasStartDate = gasStartDate[0..-2]
572
- gasStartDate << "],\n"
573
- gasEndDate = gasEndDate[0..-2]
574
- gasEndDate << "],\n"
575
- gasActualConsumption = gasActualConsumption[0..-2]
576
- gasActualConsumption << "],\n"
577
- gasModelConsumption = gasModelConsumption[0..-2]
578
- gasModelConsumption << "],\n"
579
- gasNMBE = gasNMBE[0..-2]
580
- gasNMBE << "]\n"
581
- energyGas << gasStartDate << gasEndDate << gasActualConsumption << gasModelConsumption << gasNMBE
582
- energyGas << "\t\t}\n" << "\t},\n"
583
-
584
- energy << "var consumption = {\n"
585
-
586
- energy << energyElec if hasElec
587
-
588
- energy << energyDemand if hasDemand
589
-
590
- energy << energyGas if hasGas
591
-
592
- energy << '};'
593
-
594
- # echo out our values
595
- # runner.registerInfo("This building is named #{building_name}.")
596
-
597
- # read in template
598
- html_in_path = "#{File.dirname(__FILE__)}/resources/report.html.in"
599
- html_in_path = if File.exist?(html_in_path)
600
- html_in_path
601
- else
602
- "#{File.dirname(__FILE__)}/report.html.in"
603
- end
604
- html_in = ''
605
- File.open(html_in_path, 'r') do |file|
606
- html_in = file.read
607
- end
608
-
609
- # configure template with variable values
610
- renderer = ERB.new(html_in)
611
- html_out = renderer.result(binding)
612
-
613
- # write html file
614
- html_out_path = './report.html'
615
- File.open(html_out_path, 'w') do |file|
616
- file << html_out
617
- # make sure data is written to the disk one way or the other
618
- begin
619
- file.fsync
620
- rescue StandardError
621
- file.flush
622
- end
623
- end
624
-
625
- # closing the sql file
626
- sqlFile.close
627
-
628
- # reporting final condition
629
- if missingData == true
630
- runner.registerFinalCondition('Calibration Report was not generated successfully.')
631
- else
632
- runner.registerFinalCondition('Calibration Report generated successfully.')
633
- end
634
-
635
- # write json specific file format, everything can be derived from reported attributes
636
- result_hash = {}
637
- runner.result.attributes.each do |attribute|
638
- # skip individual period metrics
639
- next if /period_\d+_consumption/.match(attribute.name)
640
-
641
- if match_data = /(.*)_consumption_cvrmse/.match(attribute.name)
642
- cvrmse = attribute.valueAsDouble
643
-
644
- # this is a hack
645
- is_electric = /electric/i.match(match_data[1])
646
-
647
- within_limit = false
648
- within_limit = if is_electric
649
- (cvrmse <= electric_cvrmse_limit)
650
- else
651
- (cvrmse <= gas_cvrmse_limit)
652
- end
653
- result_hash[match_data[1] + '_cvrmse_within_limit'] = within_limit
654
- within_limit_i = if within_limit
655
- 1
656
- else
657
- 0
658
- end
659
- runner.registerValue("#{match_data[1]}_cvrmse_within_limit", within_limit_i)
660
- elsif match_data = /(.*)_consumption_nmbe/i.match(attribute.name)
661
- nmbe = attribute.valueAsDouble
662
-
663
- # this is a hack
664
- is_electric = /electric/i.match(match_data[1])
665
-
666
- within_limit = false
667
- within_limit = if is_electric
668
- (nmbe.abs <= electric_nmbe_limit)
669
- else
670
- (nmbe.abs <= gas_nmbe_limit)
671
- end
672
- result_hash[match_data[1] + '_nmbe_within_limit'] = within_limit
673
- within_limit_i = if within_limit
674
- 1
675
- else
676
- 0
677
- end
678
- runner.registerValue("#{match_data[1]}_nmbe_within_limit", within_limit_i)
679
- end
680
- end
681
- File.open('./report_guideline.json', 'w') do |f|
682
- f.write(result_hash.to_json)
683
- end
684
-
685
- true
686
- end # end the run method
687
- end # end the measure
688
-
689
- # this allows the measure to be use by the application
690
- CalibrationReportsEnhanced21.new.registerWithApplication