openstudio-common-measures 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (165) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +44 -0
  3. data/Rakefile +3 -0
  4. data/lib/measures/ChangeBuildingLocation/measure.xml +11 -11
  5. data/lib/measures/ExportScheduleCSV/measure.rb +1 -1
  6. data/lib/measures/ExportScheduleCSV/measure.xml +16 -15
  7. data/lib/measures/ImportEnvelopeAndInternalLoadsFromIdf/measure.xml +7 -6
  8. data/lib/measures/MeterFlodPlot/measure.rb +1 -1
  9. data/lib/measures/MeterFlodPlot/measure.xml +16 -15
  10. data/lib/measures/ReportModelChanges/measure.xml +2 -2
  11. data/lib/measures/RunPeriodMultiple/measure.xml +12 -11
  12. data/lib/measures/ServerDirectoryCleanup/README.md +97 -3
  13. data/lib/measures/ServerDirectoryCleanup/measure.rb +1 -1
  14. data/lib/measures/ServerDirectoryCleanup/measure.xml +10 -59
  15. data/lib/measures/UnmetLoadHoursTroubleshooting/README.md +9 -3
  16. data/lib/measures/UnmetLoadHoursTroubleshooting/measure.rb +1 -1
  17. data/lib/measures/UnmetLoadHoursTroubleshooting/measure.xml +66 -17
  18. data/lib/measures/VentilationQAQC/README.md +9 -3
  19. data/lib/measures/VentilationQAQC/measure.rb +52 -45
  20. data/lib/measures/VentilationQAQC/measure.xml +25 -30
  21. data/lib/measures/ZoneReport/README.md +2 -2
  22. data/lib/measures/ZoneReport/measure.rb +1 -1
  23. data/lib/measures/ZoneReport/measure.xml +10 -11
  24. data/lib/measures/add_ems_to_control_ev_charging/LICENSE.MD.txt +15 -0
  25. data/lib/measures/{AddDaylightSensors → add_ems_to_control_ev_charging}/LICENSE.md +0 -0
  26. data/lib/measures/add_ems_to_control_ev_charging/ReadMe.MD +29 -0
  27. data/lib/measures/add_ems_to_control_ev_charging/measure.rb +288 -0
  28. data/lib/measures/add_ems_to_control_ev_charging/measure.xml +87 -0
  29. data/lib/measures/add_ev_load/LICENSE.MD.txt +15 -0
  30. data/lib/measures/{EnableDemandControlledVentilation → add_ev_load}/LICENSE.md +0 -0
  31. data/lib/measures/add_ev_load/ReadMe.MD +34 -0
  32. data/lib/measures/add_ev_load/measure.rb +328 -0
  33. data/lib/measures/add_ev_load/measure.xml +153 -0
  34. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/PSN_BuildingKey.csv +104 -0
  35. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/PSN_BuildingKey_v2.csv +104 -0
  36. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow1_flex1.csv +96 -0
  37. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow1_flex2.csv +96 -0
  38. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow1_flex3.csv +96 -0
  39. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow2_flex1.csv +96 -0
  40. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow2_flex2.csv +96 -0
  41. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow2_flex3.csv +96 -0
  42. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow3_flex1.csv +96 -0
  43. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow3_flex2.csv +96 -0
  44. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg1_dow3_flex3.csv +96 -0
  45. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow1_flex1.csv +96 -0
  46. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow1_flex2.csv +96 -0
  47. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow1_flex3.csv +96 -0
  48. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow2_flex1.csv +96 -0
  49. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow2_flex2.csv +96 -0
  50. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow2_flex3.csv +96 -0
  51. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow3_flex1.csv +96 -0
  52. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow3_flex2.csv +96 -0
  53. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg2_dow3_flex3.csv +96 -0
  54. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow1_flex1.csv +96 -0
  55. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow1_flex2.csv +96 -0
  56. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow1_flex3.csv +96 -0
  57. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow2_flex1.csv +96 -0
  58. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow2_flex2.csv +96 -0
  59. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow2_flex3.csv +96 -0
  60. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow3_flex1.csv +96 -0
  61. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow3_flex2.csv +96 -0
  62. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/chg3_dow3_flex3.csv +96 -0
  63. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/fast_charge_15min_Saturday.csv +96 -0
  64. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/fast_charge_15min_Sunday.csv +96 -0
  65. data/lib/measures/add_ev_load/resources/EV_Load_Profiles/fast_charge_15min_Weekday.csv +96 -0
  66. data/lib/measures/envelope_and_internal_load_breakdown/README.md +4 -3
  67. data/lib/measures/envelope_and_internal_load_breakdown/measure.rb +7 -4
  68. data/lib/measures/envelope_and_internal_load_breakdown/measure.xml +16 -17
  69. data/lib/measures/envelope_and_internal_load_breakdown/resources/report.html.erb +1 -0
  70. data/lib/measures/example_report/README.md +27 -5
  71. data/lib/measures/example_report/measure.rb +7 -4
  72. data/lib/measures/example_report/measure.xml +16 -29
  73. data/lib/measures/example_report/resources/report.html.erb +1 -0
  74. data/lib/measures/gem_env_report/measure.xml +1 -1
  75. data/lib/measures/generic_qaqc/README.md +187 -5
  76. data/lib/measures/generic_qaqc/measure.rb +1 -1
  77. data/lib/measures/generic_qaqc/measure.xml +15 -85
  78. data/lib/measures/generic_qaqc/resources/report.html.erb +1 -0
  79. data/lib/measures/hvac_psychrometric_chart/README.md +11 -5
  80. data/lib/measures/hvac_psychrometric_chart/measure.rb +1 -1
  81. data/lib/measures/hvac_psychrometric_chart/measure.xml +13 -18
  82. data/lib/measures/hvac_psychrometric_chart/resources/report.html.erb +1 -0
  83. data/lib/measures/inject_idf_objects/measure.xml +25 -24
  84. data/lib/measures/openstudio_results/README.md +195 -5
  85. data/lib/measures/openstudio_results/measure.rb +2 -2
  86. data/lib/measures/openstudio_results/measure.xml +30 -154
  87. data/lib/measures/openstudio_results/resources/report.html.erb +1 -0
  88. data/lib/measures/set_run_period/measure.xml +2 -2
  89. data/lib/measures/{EnableEconomizerControl → view_data}/LICENSE.md +0 -0
  90. data/lib/measures/view_data/README.md +64 -0
  91. data/lib/measures/{AddDaylightSensors → view_data}/README.md.erb +0 -0
  92. data/lib/measures/view_data/measure.rb +454 -0
  93. data/lib/measures/view_data/measure.xml +159 -0
  94. data/lib/measures/view_data/resources/report.html.in +2881 -0
  95. data/lib/measures/view_data/resources/va3c.rb +1021 -0
  96. data/lib/measures/{ImproveFanBeltEfficiency → view_model}/LICENSE.md +0 -0
  97. data/lib/measures/view_model/README.md +26 -0
  98. data/lib/measures/{EnableDemandControlledVentilation → view_model}/README.md.erb +0 -0
  99. data/lib/measures/view_model/measure.rb +146 -0
  100. data/lib/measures/view_model/measure.xml +98 -0
  101. data/lib/measures/view_model/resources/report.html.in +2881 -0
  102. data/lib/measures/view_model/resources/va3c.rb +1021 -0
  103. data/lib/openstudio/common_measures/version.rb +1 -1
  104. data/openstudio-common-measures.gemspec +1 -1
  105. metadata +61 -71
  106. data/lib/measures/AddDaylightSensors/README.md +0 -136
  107. data/lib/measures/AddDaylightSensors/measure.rb +0 -521
  108. data/lib/measures/AddDaylightSensors/measure.xml +0 -233
  109. data/lib/measures/EnableDemandControlledVentilation/README.md +0 -32
  110. data/lib/measures/EnableDemandControlledVentilation/measure.rb +0 -154
  111. data/lib/measures/EnableDemandControlledVentilation/measure.xml +0 -99
  112. data/lib/measures/EnableEconomizerControl/README.md +0 -48
  113. data/lib/measures/EnableEconomizerControl/README.md.erb +0 -42
  114. data/lib/measures/EnableEconomizerControl/measure.rb +0 -172
  115. data/lib/measures/EnableEconomizerControl/measure.xml +0 -124
  116. data/lib/measures/ImproveFanBeltEfficiency/README.md +0 -104
  117. data/lib/measures/ImproveFanBeltEfficiency/README.md.erb +0 -42
  118. data/lib/measures/ImproveFanBeltEfficiency/measure.rb +0 -366
  119. data/lib/measures/ImproveFanBeltEfficiency/measure.xml +0 -185
  120. data/lib/measures/ImproveMotorEfficiency/LICENSE.md +0 -27
  121. data/lib/measures/ImproveMotorEfficiency/README.md +0 -104
  122. data/lib/measures/ImproveMotorEfficiency/README.md.erb +0 -42
  123. data/lib/measures/ImproveMotorEfficiency/measure.rb +0 -365
  124. data/lib/measures/ImproveMotorEfficiency/measure.xml +0 -182
  125. data/lib/measures/IncreaseInsulationRValueForExteriorWalls/LICENSE.md +0 -27
  126. data/lib/measures/IncreaseInsulationRValueForExteriorWalls/README.md +0 -64
  127. data/lib/measures/IncreaseInsulationRValueForExteriorWalls/README.md.erb +0 -42
  128. data/lib/measures/IncreaseInsulationRValueForExteriorWalls/measure.rb +0 -422
  129. data/lib/measures/IncreaseInsulationRValueForExteriorWalls/measure.xml +0 -150
  130. data/lib/measures/IncreaseInsulationRValueForRoofs/LICENSE.md +0 -27
  131. data/lib/measures/IncreaseInsulationRValueForRoofs/README.md +0 -64
  132. data/lib/measures/IncreaseInsulationRValueForRoofs/README.md.erb +0 -42
  133. data/lib/measures/IncreaseInsulationRValueForRoofs/measure.rb +0 -422
  134. data/lib/measures/IncreaseInsulationRValueForRoofs/measure.xml +0 -143
  135. data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/LICENSE.md +0 -27
  136. data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/README.md +0 -97
  137. data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/README.md.erb +0 -42
  138. data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/measure.rb +0 -450
  139. data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/measure.xml +0 -186
  140. data/lib/measures/ReduceLightingLoadsByPercentage/LICENSE.md +0 -27
  141. data/lib/measures/ReduceLightingLoadsByPercentage/README.md +0 -96
  142. data/lib/measures/ReduceLightingLoadsByPercentage/README.md.erb +0 -42
  143. data/lib/measures/ReduceLightingLoadsByPercentage/measure.rb +0 -513
  144. data/lib/measures/ReduceLightingLoadsByPercentage/measure.xml +0 -191
  145. data/lib/measures/ReduceSpaceInfiltrationByPercentage/LICENSE.md +0 -27
  146. data/lib/measures/ReduceSpaceInfiltrationByPercentage/README.md +0 -104
  147. data/lib/measures/ReduceSpaceInfiltrationByPercentage/README.md.erb +0 -42
  148. data/lib/measures/ReduceSpaceInfiltrationByPercentage/measure.rb +0 -349
  149. data/lib/measures/ReduceSpaceInfiltrationByPercentage/measure.xml +0 -181
  150. data/lib/measures/ReduceVentilationByPercentage/LICENSE.md +0 -27
  151. data/lib/measures/ReduceVentilationByPercentage/README.md +0 -40
  152. data/lib/measures/ReduceVentilationByPercentage/README.md.erb +0 -42
  153. data/lib/measures/ReduceVentilationByPercentage/measure.rb +0 -291
  154. data/lib/measures/ReduceVentilationByPercentage/measure.xml +0 -96
  155. data/lib/measures/VentilationQAQC/ExampleModel.osm +0 -28468
  156. data/lib/measures/create_variable_speed_rtu/LICENSE.md +0 -27
  157. data/lib/measures/create_variable_speed_rtu/README.md +0 -120
  158. data/lib/measures/create_variable_speed_rtu/README.md.erb +0 -42
  159. data/lib/measures/create_variable_speed_rtu/measure.rb +0 -539
  160. data/lib/measures/create_variable_speed_rtu/measure.xml +0 -207
  161. data/lib/measures/radiant_slab_with_doas/LICENSE.md +0 -27
  162. data/lib/measures/radiant_slab_with_doas/README.md +0 -156
  163. data/lib/measures/radiant_slab_with_doas/README.md.erb +0 -42
  164. data/lib/measures/radiant_slab_with_doas/measure.rb +0 -403
  165. data/lib/measures/radiant_slab_with_doas/measure.xml +0 -345
@@ -2,16 +2,16 @@
2
2
 
3
3
  ###### (Automatically generated documentation)
4
4
 
5
- #
5
+ # Example Report
6
6
 
7
7
  ## Description
8
-
8
+ Simple example of modular code to create tables and charts in OpenStudio reporting measures. This is not meant to use as is, it is an example to help with reporting measure development.
9
9
 
10
10
  ## Modeler Description
11
-
11
+ This measure uses the same framework and technologies (bootstrap and dimple) that the standard OpenStudio results report uses to create an html report with tables and charts. Download this measure and copy it to your Measures directory using PAT or the OpenStudio application. Then alter the data in os_lib_reporting_custom.rb to suit your needs. Make new sections and tables as needed.
12
12
 
13
13
  ## Measure Type
14
- ModelMeasure
14
+ ReportingMeasure
15
15
 
16
16
  ## Taxonomy
17
17
 
@@ -19,8 +19,30 @@ ModelMeasure
19
19
  ## Arguments
20
20
 
21
21
 
22
+ ### Tasty Treats
23
+
24
+ **Name:** template_section,
25
+ **Type:** Boolean,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+ ### Material Properties
31
+
32
+ **Name:** mat_prop_section,
33
+ **Type:** Boolean,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### General Building Information
39
+
40
+ **Name:** general_building_information_section,
41
+ **Type:** Boolean,
42
+ **Units:** ,
43
+ **Required:** true,
44
+ **Model Dependent:** false
22
45
 
23
46
 
24
- This measure does not have any user arguments
25
47
 
26
48
 
@@ -65,17 +65,20 @@ class ExampleReport < OpenStudio::Measure::ReportingMeasure
65
65
  result = []
66
66
 
67
67
  # instead of hand populating, any methods with 'section' in the name will be added in the order they appear
68
- all_setions = OsLib_Reporting_example.methods(false)
69
- all_setions.each do |section|
68
+ all_sections = OsLib_Reporting_example.methods(false)
69
+ method_hash = {}
70
+ all_sections.each do |section|
70
71
  next if !section.to_s.include? 'section'
71
- result << section.to_s
72
+ method_hash[section.to_s] = OsLib_Reporting_example.method(section).source_location.last
72
73
  end
74
+ # sort methods by location in file (this was not necessary when using Ruby 2.2.4)
75
+ result = method_hash.sort_by { |_key, value| value }.to_h.keys
73
76
 
74
77
  result
75
78
  end
76
79
 
77
80
  # define the arguments that the user will input
78
- def arguments
81
+ def arguments(model = nil)
79
82
  args = OpenStudio::Measure::OSArgumentVector.new
80
83
 
81
84
  # populate arguments
@@ -3,8 +3,8 @@
3
3
  <schema_version>3.0</schema_version>
4
4
  <name>example_report</name>
5
5
  <uid>174a6f71-3e8c-4f99-9e7a-b64f2e7535d4</uid>
6
- <version_id>a274e765-411c-4d8c-b68c-93ca1cc29a1c</version_id>
7
- <version_modified>20200509T041907Z</version_modified>
6
+ <version_id>4a8f98cc-b27f-411d-a80d-e9d89bf64806</version_id>
7
+ <version_modified>20200623T192428Z</version_modified>
8
8
  <xml_checksum>557BF06F</xml_checksum>
9
9
  <class_name>ExampleReport</class_name>
10
10
  <display_name>Example Report</display_name>
@@ -14,9 +14,7 @@
14
14
  <argument>
15
15
  <name>template_section</name>
16
16
  <display_name>Tasty Treats</display_name>
17
- <description></description>
18
17
  <type>Boolean</type>
19
- <units></units>
20
18
  <required>true</required>
21
19
  <model_dependent>false</model_dependent>
22
20
  <default_value>true</default_value>
@@ -30,15 +28,11 @@
30
28
  <display_name>false</display_name>
31
29
  </choice>
32
30
  </choices>
33
- <min_value></min_value>
34
- <max_value></max_value>
35
31
  </argument>
36
32
  <argument>
37
33
  <name>mat_prop_section</name>
38
34
  <display_name>Material Properties</display_name>
39
- <description></description>
40
35
  <type>Boolean</type>
41
- <units></units>
42
36
  <required>true</required>
43
37
  <model_dependent>false</model_dependent>
44
38
  <default_value>true</default_value>
@@ -52,15 +46,11 @@
52
46
  <display_name>false</display_name>
53
47
  </choice>
54
48
  </choices>
55
- <min_value></min_value>
56
- <max_value></max_value>
57
49
  </argument>
58
50
  <argument>
59
51
  <name>general_building_information_section</name>
60
52
  <display_name>General Building Information</display_name>
61
- <description></description>
62
53
  <type>Boolean</type>
63
- <units></units>
64
54
  <required>true</required>
65
55
  <model_dependent>false</model_dependent>
66
56
  <default_value>true</default_value>
@@ -74,8 +64,6 @@
74
64
  <display_name>false</display_name>
75
65
  </choice>
76
66
  </choices>
77
- <min_value></min_value>
78
- <max_value></max_value>
79
67
  </argument>
80
68
  </arguments>
81
69
  <outputs />
@@ -156,19 +144,7 @@
156
144
  <filename>ExampleReport_Test.rb</filename>
157
145
  <filetype>rb</filetype>
158
146
  <usage_type>test</usage_type>
159
- <checksum>AFC7D248</checksum>
160
- </file>
161
- <file>
162
- <filename>README.md</filename>
163
- <filetype>md</filetype>
164
- <usage_type>readme</usage_type>
165
- <checksum>0B68E96D</checksum>
166
- </file>
167
- <file>
168
- <filename>report.html.erb</filename>
169
- <filetype>erb</filetype>
170
- <usage_type>resource</usage_type>
171
- <checksum>708516C5</checksum>
147
+ <checksum>DF6EDC31</checksum>
172
148
  </file>
173
149
  <file>
174
150
  <version>
@@ -179,8 +155,19 @@
179
155
  <filename>measure.rb</filename>
180
156
  <filetype>rb</filetype>
181
157
  <usage_type>script</usage_type>
182
- <checksum>4107DCF6</checksum>
158
+ <checksum>148E4830</checksum>
159
+ </file>
160
+ <file>
161
+ <filename>README.md</filename>
162
+ <filetype>md</filetype>
163
+ <usage_type>readme</usage_type>
164
+ <checksum>3C0851D8</checksum>
165
+ </file>
166
+ <file>
167
+ <filename>report.html.erb</filename>
168
+ <filetype>erb</filetype>
169
+ <usage_type>resource</usage_type>
170
+ <checksum>AD451814</checksum>
183
171
  </file>
184
172
  </files>
185
173
  </measure>
186
- <error>wrong number of arguments (given 1, expected 0)</error>
@@ -38,6 +38,7 @@
38
38
 
39
39
 
40
40
 
41
+
41
42
  <!DOCTYPE html>
42
43
  <html lang="en">
43
44
  <head>
@@ -81,7 +81,7 @@
81
81
  <checksum>2E192C55</checksum>
82
82
  </file>
83
83
  <file>
84
- <filename>test.rb</filename>
84
+ <filename>gem_env_report_Test.rb</filename>
85
85
  <filetype>rb</filetype>
86
86
  <usage_type>test</usage_type>
87
87
  <checksum>57B19EEF</checksum>
@@ -2,16 +2,16 @@
2
2
 
3
3
  ###### (Automatically generated documentation)
4
4
 
5
- #
5
+ # Generic QAQC
6
6
 
7
7
  ## Description
8
-
8
+ This measure extracts key simulation results and performs basic model QAQC checks. Each category of checks provides a description of the source of the check. In some cases the target standards and tollerances are adjustable.
9
9
 
10
10
  ## Modeler Description
11
-
11
+ Reads the model and sql file to pull out the necessary information and run the model checks. The check results show up as warning messages in the measure's output on the PAT run tab.
12
12
 
13
13
  ## Measure Type
14
- ModelMeasure
14
+ ReportingMeasure
15
15
 
16
16
  ## Taxonomy
17
17
 
@@ -19,8 +19,190 @@ ModelMeasure
19
19
  ## Arguments
20
20
 
21
21
 
22
+ ### Target ASHRAE Standard
23
+ This used to set the target standard for most checks.
24
+ **Name:** template,
25
+ **Type:** Choice,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+ ### EUI Reasonableness (General)
31
+ Check EUI for model against selected ASHRAE standard DOE prototype buildings.
32
+ **Name:** check_eui_reasonableness,
33
+ **Type:** Boolean,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### EUI Reasonableness Tolerance
39
+
40
+ **Name:** check_eui_reasonableness_tol,
41
+ **Type:** Double,
42
+ **Units:** fraction,
43
+ **Required:** true,
44
+ **Model Dependent:** false
45
+
46
+ ### End Use by Category (General)
47
+ Check end use by category against selected ASHRAE standard DOE prototype buildings.
48
+ **Name:** check_eui_by_end_use,
49
+ **Type:** Boolean,
50
+ **Units:** ,
51
+ **Required:** true,
52
+ **Model Dependent:** false
53
+
54
+ ### End Use by Category Tolerance
55
+
56
+ **Name:** check_eui_by_end_use_tol,
57
+ **Type:** Double,
58
+ **Units:** fraction,
59
+ **Required:** true,
60
+ **Model Dependent:** false
61
+
62
+ ### Mechanical System Part Load Efficiency (General)
63
+ Check 40% and 80% part load efficency against selected ASHRAE standard for the following compenent types: ChillerElectricEIR, CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilHeatingDXSingleSpeed. Checking EIR Function of Part Load Ratio curve for chiller and EIR Function of Flow Fraction for DX coils.
64
+ **Name:** check_mech_sys_part_load_eff,
65
+ **Type:** Boolean,
66
+ **Units:** ,
67
+ **Required:** true,
68
+ **Model Dependent:** false
69
+
70
+ ### Mechanical System Part Load Efficiency Tolerance
71
+
72
+ **Name:** check_mech_sys_part_load_eff_tol,
73
+ **Type:** Double,
74
+ **Units:** fraction,
75
+ **Required:** true,
76
+ **Model Dependent:** false
77
+
78
+ ### Mechanical System Capacity (General)
79
+ Check HVAC capacity against ASHRAE rules of thumb for chiller max flow rate, air loop max flow rate, air loop cooling capciaty, and zone heating capcaity. Zone heating check will skip thermal zones without any exterior exposure, and thermal zones that are not conditioned.
80
+ **Name:** check_mech_sys_capacity,
81
+ **Type:** Boolean,
82
+ **Units:** ,
83
+ **Required:** true,
84
+ **Model Dependent:** false
85
+
86
+ ### Simultaneous Heating and Cooling (General)
87
+ Check for simultaneous heating and cooling by looping through all Single Duct VAV Reheat Air Terminals and analyzing hourly data when there is a cooling load.
88
+ **Name:** check_simultaneous_heating_and_cooling,
89
+ **Type:** Boolean,
90
+ **Units:** ,
91
+ **Required:** true,
92
+ **Model Dependent:** false
93
+
94
+ ### Simultaneous Heating and Cooling Max Tolerance
95
+
96
+ **Name:** check_simultaneous_heating_and_cooling_max_tol,
97
+ **Type:** Double,
98
+ **Units:** fraction,
99
+ **Required:** true,
100
+ **Model Dependent:** false
101
+
102
+ ### Internal Loads (Baseline)
103
+ Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against selected ASHRAE standard and DOE Prototype buildings.
104
+ **Name:** check_internal_loads,
105
+ **Type:** Boolean,
106
+ **Units:** ,
107
+ **Required:** true,
108
+ **Model Dependent:** false
109
+
110
+ ### Internal Loads Tolerance
111
+
112
+ **Name:** check_internal_loads_tol,
113
+ **Type:** Double,
114
+ **Units:** fraction,
115
+ **Required:** true,
116
+ **Model Dependent:** false
117
+
118
+ ### Schedules (Baseline)
119
+ Check schedules for lighting, ventilation, occupant density, plug loads, and equipment based on DOE reference building schedules in terms of full load hours per year.
120
+ **Name:** check_schedules,
121
+ **Type:** Boolean,
122
+ **Units:** ,
123
+ **Required:** true,
124
+ **Model Dependent:** false
125
+
126
+ ### Schedules Tolerance
127
+
128
+ **Name:** check_schedules_tol,
129
+ **Type:** Double,
130
+ **Units:** fraction,
131
+ **Required:** true,
132
+ **Model Dependent:** false
133
+
134
+ ### Envelope R-Value (Baseline)
135
+ Check envelope against selected ASHRAE standard. Roof reflectance of 55%, wall relfectance of 30%.
136
+ **Name:** check_envelope_conductance,
137
+ **Type:** Boolean,
138
+ **Units:** ,
139
+ **Required:** true,
140
+ **Model Dependent:** false
141
+
142
+ ### Envelope R-Value Tolerance
143
+
144
+ **Name:** check_envelope_conductance_tol,
145
+ **Type:** Double,
146
+ **Units:** fraction,
147
+ **Required:** true,
148
+ **Model Dependent:** false
149
+
150
+ ### Domestic Hot Water (Baseline)
151
+ Check against the 2011 ASHRAE Handbook - HVAC Applications, Table 7 section 50.14.
152
+ **Name:** check_domestic_hot_water,
153
+ **Type:** Boolean,
154
+ **Units:** ,
155
+ **Required:** true,
156
+ **Model Dependent:** false
157
+
158
+ ### Domestic Hot Water Tolerance
159
+
160
+ **Name:** check_domestic_hot_water_tol,
161
+ **Type:** Double,
162
+ **Units:** fraction,
163
+ **Required:** true,
164
+ **Model Dependent:** false
165
+
166
+ ### Mechanical System Efficiency (Baseline)
167
+ Check against selected ASHRAE standard for the following component types: ChillerElectricEIR, CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilHeatingDXSingleSpeed, BoilerHotWater, FanConstantVolume, FanVariableVolume, PumpConstantSpeed, PumpVariableSpeed.
168
+ **Name:** check_mech_sys_efficiency,
169
+ **Type:** Boolean,
170
+ **Units:** ,
171
+ **Required:** true,
172
+ **Model Dependent:** false
173
+
174
+ ### Mechanical System Efficiency Tolerance
175
+
176
+ **Name:** check_mech_sys_efficiency_tol,
177
+ **Type:** Double,
178
+ **Units:** fraction,
179
+ **Required:** true,
180
+ **Model Dependent:** false
181
+
182
+ ### Mechanical System Type (Baseline)
183
+ Check against ASHRAE 90.1. Infers the baseline system type based on the equipment serving the zone and their heating/cooling fuels. Only does a high-level inference; does not look for the presence/absence of required controls, etc.
184
+ **Name:** check_mech_sys_type,
185
+ **Type:** Boolean,
186
+ **Units:** ,
187
+ **Required:** true,
188
+ **Model Dependent:** false
189
+
190
+ ### Supply and Zone Air Temperature (Baseline)
191
+ Check if fans modeled to ASHRAE 90.1 2013 Section G3.1.2.9 requirements. Compare the supply air temperature for each thermal zone against the thermostat setpoints. Throw flag if temperature difference excedes threshold of 20.0F plus the selected tolerance.
192
+ **Name:** check_supply_air_and_thermostat_temp_difference,
193
+ **Type:** Boolean,
194
+ **Units:** ,
195
+ **Required:** true,
196
+ **Model Dependent:** false
197
+
198
+ ### Supply and Zone Air Temperature Tolerance
199
+
200
+ **Name:** check_supply_air_and_thermostat_temp_difference_tol,
201
+ **Type:** Double,
202
+ **Units:** F,
203
+ **Required:** true,
204
+ **Model Dependent:** false
22
205
 
23
206
 
24
- This measure does not have any user arguments
25
207
 
26
208
 
@@ -108,7 +108,7 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
108
108
  end
109
109
 
110
110
  # define the arguments that the user will input
111
- def arguments
111
+ def arguments(model = nil)
112
112
  args = OpenStudio::Measure::OSArgumentVector.new
113
113
 
114
114
  # Make an argument for the template
@@ -3,8 +3,8 @@
3
3
  <schema_version>3.0</schema_version>
4
4
  <name>generic_qaqc</name>
5
5
  <uid>d58d6b29-69ba-4915-b907-3c2c37ddb7c7</uid>
6
- <version_id>250c809c-d96f-4023-8035-766f71c9e84b</version_id>
7
- <version_modified>20200509T041913Z</version_modified>
6
+ <version_id>d5440237-cf84-4f6b-9369-611c253371a3</version_id>
7
+ <version_modified>20200623T192456Z</version_modified>
8
8
  <xml_checksum>0A3BF61C</xml_checksum>
9
9
  <class_name>GenericQAQC</class_name>
10
10
  <display_name>Generic QAQC</display_name>
@@ -16,7 +16,6 @@
16
16
  <display_name>Target ASHRAE Standard</display_name>
17
17
  <description>This used to set the target standard for most checks.</description>
18
18
  <type>Choice</type>
19
- <units></units>
20
19
  <required>true</required>
21
20
  <model_dependent>false</model_dependent>
22
21
  <default_value>90.1-2013</default_value>
@@ -46,15 +45,12 @@
46
45
  <display_name>90.1-2013</display_name>
47
46
  </choice>
48
47
  </choices>
49
- <min_value></min_value>
50
- <max_value></max_value>
51
48
  </argument>
52
49
  <argument>
53
50
  <name>check_eui_reasonableness</name>
54
51
  <display_name>EUI Reasonableness (General)</display_name>
55
52
  <description>Check EUI for model against selected ASHRAE standard DOE prototype buildings.</description>
56
53
  <type>Boolean</type>
57
- <units></units>
58
54
  <required>true</required>
59
55
  <model_dependent>false</model_dependent>
60
56
  <default_value>true</default_value>
@@ -68,27 +64,21 @@
68
64
  <display_name>false</display_name>
69
65
  </choice>
70
66
  </choices>
71
- <min_value></min_value>
72
- <max_value></max_value>
73
67
  </argument>
74
68
  <argument>
75
69
  <name>check_eui_reasonableness_tol</name>
76
70
  <display_name>EUI Reasonableness Tolerance</display_name>
77
- <description></description>
78
71
  <type>Double</type>
79
72
  <units>fraction</units>
80
73
  <required>true</required>
81
74
  <model_dependent>false</model_dependent>
82
75
  <default_value>0.1</default_value>
83
- <min_value></min_value>
84
- <max_value></max_value>
85
76
  </argument>
86
77
  <argument>
87
78
  <name>check_eui_by_end_use</name>
88
79
  <display_name>End Use by Category (General)</display_name>
89
80
  <description>Check end use by category against selected ASHRAE standard DOE prototype buildings.</description>
90
81
  <type>Boolean</type>
91
- <units></units>
92
82
  <required>true</required>
93
83
  <model_dependent>false</model_dependent>
94
84
  <default_value>true</default_value>
@@ -102,27 +92,21 @@
102
92
  <display_name>false</display_name>
103
93
  </choice>
104
94
  </choices>
105
- <min_value></min_value>
106
- <max_value></max_value>
107
95
  </argument>
108
96
  <argument>
109
97
  <name>check_eui_by_end_use_tol</name>
110
98
  <display_name>End Use by Category Tolerance</display_name>
111
- <description></description>
112
99
  <type>Double</type>
113
100
  <units>fraction</units>
114
101
  <required>true</required>
115
102
  <model_dependent>false</model_dependent>
116
103
  <default_value>0.25</default_value>
117
- <min_value></min_value>
118
- <max_value></max_value>
119
104
  </argument>
120
105
  <argument>
121
106
  <name>check_mech_sys_part_load_eff</name>
122
107
  <display_name>Mechanical System Part Load Efficiency (General)</display_name>
123
108
  <description>Check 40% and 80% part load efficency against selected ASHRAE standard for the following compenent types: ChillerElectricEIR, CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilHeatingDXSingleSpeed. Checking EIR Function of Part Load Ratio curve for chiller and EIR Function of Flow Fraction for DX coils.</description>
124
109
  <type>Boolean</type>
125
- <units></units>
126
110
  <required>true</required>
127
111
  <model_dependent>false</model_dependent>
128
112
  <default_value>true</default_value>
@@ -136,27 +120,21 @@
136
120
  <display_name>false</display_name>
137
121
  </choice>
138
122
  </choices>
139
- <min_value></min_value>
140
- <max_value></max_value>
141
123
  </argument>
142
124
  <argument>
143
125
  <name>check_mech_sys_part_load_eff_tol</name>
144
126
  <display_name>Mechanical System Part Load Efficiency Tolerance</display_name>
145
- <description></description>
146
127
  <type>Double</type>
147
128
  <units>fraction</units>
148
129
  <required>true</required>
149
130
  <model_dependent>false</model_dependent>
150
131
  <default_value>0.05</default_value>
151
- <min_value></min_value>
152
- <max_value></max_value>
153
132
  </argument>
154
133
  <argument>
155
134
  <name>check_mech_sys_capacity</name>
156
135
  <display_name>Mechanical System Capacity (General)</display_name>
157
136
  <description>Check HVAC capacity against ASHRAE rules of thumb for chiller max flow rate, air loop max flow rate, air loop cooling capciaty, and zone heating capcaity. Zone heating check will skip thermal zones without any exterior exposure, and thermal zones that are not conditioned.</description>
158
137
  <type>Boolean</type>
159
- <units></units>
160
138
  <required>true</required>
161
139
  <model_dependent>false</model_dependent>
162
140
  <default_value>true</default_value>
@@ -170,15 +148,12 @@
170
148
  <display_name>false</display_name>
171
149
  </choice>
172
150
  </choices>
173
- <min_value></min_value>
174
- <max_value></max_value>
175
151
  </argument>
176
152
  <argument>
177
153
  <name>check_simultaneous_heating_and_cooling</name>
178
154
  <display_name>Simultaneous Heating and Cooling (General)</display_name>
179
155
  <description>Check for simultaneous heating and cooling by looping through all Single Duct VAV Reheat Air Terminals and analyzing hourly data when there is a cooling load. </description>
180
156
  <type>Boolean</type>
181
- <units></units>
182
157
  <required>true</required>
183
158
  <model_dependent>false</model_dependent>
184
159
  <default_value>true</default_value>
@@ -192,27 +167,21 @@
192
167
  <display_name>false</display_name>
193
168
  </choice>
194
169
  </choices>
195
- <min_value></min_value>
196
- <max_value></max_value>
197
170
  </argument>
198
171
  <argument>
199
172
  <name>check_simultaneous_heating_and_cooling_max_tol</name>
200
173
  <display_name>Simultaneous Heating and Cooling Max Tolerance</display_name>
201
- <description></description>
202
174
  <type>Double</type>
203
175
  <units>fraction</units>
204
176
  <required>true</required>
205
177
  <model_dependent>false</model_dependent>
206
178
  <default_value>0.05</default_value>
207
- <min_value></min_value>
208
- <max_value></max_value>
209
179
  </argument>
210
180
  <argument>
211
181
  <name>check_internal_loads</name>
212
182
  <display_name>Internal Loads (Baseline)</display_name>
213
183
  <description>Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against selected ASHRAE standard and DOE Prototype buildings.</description>
214
184
  <type>Boolean</type>
215
- <units></units>
216
185
  <required>true</required>
217
186
  <model_dependent>false</model_dependent>
218
187
  <default_value>true</default_value>
@@ -226,27 +195,21 @@
226
195
  <display_name>false</display_name>
227
196
  </choice>
228
197
  </choices>
229
- <min_value></min_value>
230
- <max_value></max_value>
231
198
  </argument>
232
199
  <argument>
233
200
  <name>check_internal_loads_tol</name>
234
201
  <display_name>Internal Loads Tolerance</display_name>
235
- <description></description>
236
202
  <type>Double</type>
237
203
  <units>fraction</units>
238
204
  <required>true</required>
239
205
  <model_dependent>false</model_dependent>
240
206
  <default_value>0.1</default_value>
241
- <min_value></min_value>
242
- <max_value></max_value>
243
207
  </argument>
244
208
  <argument>
245
209
  <name>check_schedules</name>
246
210
  <display_name>Schedules (Baseline)</display_name>
247
211
  <description>Check schedules for lighting, ventilation, occupant density, plug loads, and equipment based on DOE reference building schedules in terms of full load hours per year.</description>
248
212
  <type>Boolean</type>
249
- <units></units>
250
213
  <required>true</required>
251
214
  <model_dependent>false</model_dependent>
252
215
  <default_value>true</default_value>
@@ -260,27 +223,21 @@
260
223
  <display_name>false</display_name>
261
224
  </choice>
262
225
  </choices>
263
- <min_value></min_value>
264
- <max_value></max_value>
265
226
  </argument>
266
227
  <argument>
267
228
  <name>check_schedules_tol</name>
268
229
  <display_name>Schedules Tolerance</display_name>
269
- <description></description>
270
230
  <type>Double</type>
271
231
  <units>fraction</units>
272
232
  <required>true</required>
273
233
  <model_dependent>false</model_dependent>
274
234
  <default_value>0.05</default_value>
275
- <min_value></min_value>
276
- <max_value></max_value>
277
235
  </argument>
278
236
  <argument>
279
237
  <name>check_envelope_conductance</name>
280
238
  <display_name>Envelope R-Value (Baseline)</display_name>
281
239
  <description>Check envelope against selected ASHRAE standard. Roof reflectance of 55%, wall relfectance of 30%.</description>
282
240
  <type>Boolean</type>
283
- <units></units>
284
241
  <required>true</required>
285
242
  <model_dependent>false</model_dependent>
286
243
  <default_value>true</default_value>
@@ -294,27 +251,21 @@
294
251
  <display_name>false</display_name>
295
252
  </choice>
296
253
  </choices>
297
- <min_value></min_value>
298
- <max_value></max_value>
299
254
  </argument>
300
255
  <argument>
301
256
  <name>check_envelope_conductance_tol</name>
302
257
  <display_name>Envelope R-Value Tolerance</display_name>
303
- <description></description>
304
258
  <type>Double</type>
305
259
  <units>fraction</units>
306
260
  <required>true</required>
307
261
  <model_dependent>false</model_dependent>
308
262
  <default_value>0.1</default_value>
309
- <min_value></min_value>
310
- <max_value></max_value>
311
263
  </argument>
312
264
  <argument>
313
265
  <name>check_domestic_hot_water</name>
314
266
  <display_name>Domestic Hot Water (Baseline)</display_name>
315
267
  <description>Check against the 2011 ASHRAE Handbook - HVAC Applications, Table 7 section 50.14.</description>
316
268
  <type>Boolean</type>
317
- <units></units>
318
269
  <required>true</required>
319
270
  <model_dependent>false</model_dependent>
320
271
  <default_value>true</default_value>
@@ -328,27 +279,21 @@
328
279
  <display_name>false</display_name>
329
280
  </choice>
330
281
  </choices>
331
- <min_value></min_value>
332
- <max_value></max_value>
333
282
  </argument>
334
283
  <argument>
335
284
  <name>check_domestic_hot_water_tol</name>
336
285
  <display_name>Domestic Hot Water Tolerance</display_name>
337
- <description></description>
338
286
  <type>Double</type>
339
287
  <units>fraction</units>
340
288
  <required>true</required>
341
289
  <model_dependent>false</model_dependent>
342
290
  <default_value>0.25</default_value>
343
- <min_value></min_value>
344
- <max_value></max_value>
345
291
  </argument>
346
292
  <argument>
347
293
  <name>check_mech_sys_efficiency</name>
348
294
  <display_name>Mechanical System Efficiency (Baseline)</display_name>
349
295
  <description>Check against selected ASHRAE standard for the following component types: ChillerElectricEIR, CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilHeatingDXSingleSpeed, BoilerHotWater, FanConstantVolume, FanVariableVolume, PumpConstantSpeed, PumpVariableSpeed.</description>
350
296
  <type>Boolean</type>
351
- <units></units>
352
297
  <required>true</required>
353
298
  <model_dependent>false</model_dependent>
354
299
  <default_value>true</default_value>
@@ -362,27 +307,21 @@
362
307
  <display_name>false</display_name>
363
308
  </choice>
364
309
  </choices>
365
- <min_value></min_value>
366
- <max_value></max_value>
367
310
  </argument>
368
311
  <argument>
369
312
  <name>check_mech_sys_efficiency_tol</name>
370
313
  <display_name>Mechanical System Efficiency Tolerance</display_name>
371
- <description></description>
372
314
  <type>Double</type>
373
315
  <units>fraction</units>
374
316
  <required>true</required>
375
317
  <model_dependent>false</model_dependent>
376
318
  <default_value>0.1</default_value>
377
- <min_value></min_value>
378
- <max_value></max_value>
379
319
  </argument>
380
320
  <argument>
381
321
  <name>check_mech_sys_type</name>
382
322
  <display_name>Mechanical System Type (Baseline)</display_name>
383
323
  <description>Check against ASHRAE 90.1. Infers the baseline system type based on the equipment serving the zone and their heating/cooling fuels. Only does a high-level inference; does not look for the presence/absence of required controls, etc.</description>
384
324
  <type>Boolean</type>
385
- <units></units>
386
325
  <required>true</required>
387
326
  <model_dependent>false</model_dependent>
388
327
  <default_value>true</default_value>
@@ -396,15 +335,12 @@
396
335
  <display_name>false</display_name>
397
336
  </choice>
398
337
  </choices>
399
- <min_value></min_value>
400
- <max_value></max_value>
401
338
  </argument>
402
339
  <argument>
403
340
  <name>check_supply_air_and_thermostat_temp_difference</name>
404
341
  <display_name>Supply and Zone Air Temperature (Baseline)</display_name>
405
342
  <description>Check if fans modeled to ASHRAE 90.1 2013 Section G3.1.2.9 requirements. Compare the supply air temperature for each thermal zone against the thermostat setpoints. Throw flag if temperature difference excedes threshold of 20.0F plus the selected tolerance.</description>
406
343
  <type>Boolean</type>
407
- <units></units>
408
344
  <required>true</required>
409
345
  <model_dependent>false</model_dependent>
410
346
  <default_value>true</default_value>
@@ -418,20 +354,15 @@
418
354
  <display_name>false</display_name>
419
355
  </choice>
420
356
  </choices>
421
- <min_value></min_value>
422
- <max_value></max_value>
423
357
  </argument>
424
358
  <argument>
425
359
  <name>check_supply_air_and_thermostat_temp_difference_tol</name>
426
360
  <display_name>Supply and Zone Air Temperature Tolerance</display_name>
427
- <description></description>
428
361
  <type>Double</type>
429
362
  <units>F</units>
430
363
  <required>true</required>
431
364
  <model_dependent>false</model_dependent>
432
365
  <default_value>0.5</default_value>
433
- <min_value></min_value>
434
- <max_value></max_value>
435
366
  </argument>
436
367
  </arguments>
437
368
  <outputs />
@@ -560,12 +491,6 @@
560
491
  <usage_type>license</usage_type>
561
492
  <checksum>E0468DD6</checksum>
562
493
  </file>
563
- <file>
564
- <filename>README.md</filename>
565
- <filetype>md</filetype>
566
- <usage_type>readme</usage_type>
567
- <checksum>0B68E96D</checksum>
568
- </file>
569
494
  <file>
570
495
  <filename>check_mech_sys_type.rb</filename>
571
496
  <filetype>rb</filetype>
@@ -722,12 +647,6 @@
722
647
  <usage_type>resource</usage_type>
723
648
  <checksum>F47A1139</checksum>
724
649
  </file>
725
- <file>
726
- <filename>report.html.erb</filename>
727
- <filetype>erb</filetype>
728
- <usage_type>resource</usage_type>
729
- <checksum>708516C5</checksum>
730
- </file>
731
650
  <file>
732
651
  <filename>CreateResults.rb</filename>
733
652
  <filetype>rb</filetype>
@@ -749,8 +668,19 @@
749
668
  <filename>measure.rb</filename>
750
669
  <filetype>rb</filetype>
751
670
  <usage_type>script</usage_type>
752
- <checksum>720C8B98</checksum>
671
+ <checksum>A998285D</checksum>
672
+ </file>
673
+ <file>
674
+ <filename>README.md</filename>
675
+ <filetype>md</filetype>
676
+ <usage_type>readme</usage_type>
677
+ <checksum>BBC2D3D5</checksum>
678
+ </file>
679
+ <file>
680
+ <filename>report.html.erb</filename>
681
+ <filetype>erb</filetype>
682
+ <usage_type>resource</usage_type>
683
+ <checksum>AD451814</checksum>
753
684
  </file>
754
685
  </files>
755
686
  </measure>
756
- <error>wrong number of arguments (given 1, expected 0)</error>