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
@@ -0,0 +1,147 @@
1
+
2
+
3
+ ###### (Automatically generated documentation)
4
+
5
+ # Shift Hours of Operation
6
+
7
+ ## Description
8
+ This measure will infer the hours of operation for the building and then will shift the start of the hours of operation and change the duration of the hours of operation. In an alternate workflow you can directly pass in target start and duration rather than a shift and delta. Inputs can vary for weekday, Saturday, and Sunday. if a day does not have any hours of operation to start with increasing hours of operation may not have any impact as the auto generated data may not know what to do during operating hours. Future version may be able to borrow a profile formula but would probably require additional user arguments.
9
+
10
+ ## Modeler Description
11
+ This will only impact schedule rulesets. It will use methods in openstudio-standards to infer hours of operation, develop a parametric formula for all of the ruleset schedules, alter the hours of operation inputs to that formula and then re-apply the schedules. Input is expose to set ramp frequency of the resulting schedules. If inputs are such that no changes are requested, bypass the measure with NA so that it will not be parameterized. An advanced option for this measure would be bool to use hours of operation from OSM schedule ruleset hours of operation instead of inferring from standards. This should allow different parts of the building to have different hours of operation in the seed model.
12
+
13
+ ## Measure Type
14
+ ModelMeasure
15
+
16
+ ## Taxonomy
17
+
18
+
19
+ ## Arguments
20
+
21
+
22
+ ### Shift the weekday start of hours of operation.
23
+ Use decimal hours so an 1 hour and 15 minute shift would be 1.25. Positive value moves the hour of operation later
24
+ **Name:** hoo_start_weekday,
25
+ **Type:** Double,
26
+ **Units:** Hours,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+
31
+
32
+
33
+ ### Extend the weekday of hours of operation.
34
+ Use decimal hours so an 1 hour and 15 minute would be 1.25. Positive value makes the hour of operation longer.
35
+ **Name:** hoo_dur_weekday,
36
+ **Type:** Double,
37
+ **Units:** Hours,
38
+ **Required:** true,
39
+ **Model Dependent:** false
40
+
41
+
42
+
43
+
44
+ ### Shift the saturday start of hours of operation.
45
+ Use decimal hours so an 1 hour and 15 minute shift would be 1.25. Positive value moves the hour of operation later
46
+ **Name:** hoo_start_saturday,
47
+ **Type:** Double,
48
+ **Units:** Hours,
49
+ **Required:** true,
50
+ **Model Dependent:** false
51
+
52
+
53
+
54
+
55
+ ### Extend the saturday of hours of operation.
56
+ Use decimal hours so an 1 hour and 15 minute would be 1.25. Positive value makes the hour of operation longer.
57
+ **Name:** hoo_dur_saturday,
58
+ **Type:** Double,
59
+ **Units:** Hours,
60
+ **Required:** true,
61
+ **Model Dependent:** false
62
+
63
+
64
+
65
+
66
+ ### Shift the sunday start of hours of operation.
67
+ Use decimal hours so an 1 hour and 15 minute shift would be 1.25. Positive value moves the hour of operation later
68
+ **Name:** hoo_start_sunday,
69
+ **Type:** Double,
70
+ **Units:** Hours,
71
+ **Required:** true,
72
+ **Model Dependent:** false
73
+
74
+
75
+
76
+
77
+ ### Extend the sunday of hours of operation.
78
+ Use decimal hours so an 1 hour and 15 minute would be 1.25. Positive value makes the hour of operation longer.
79
+ **Name:** hoo_dur_sunday,
80
+ **Type:** Double,
81
+ **Units:** Hours,
82
+ **Required:** true,
83
+ **Model Dependent:** false
84
+
85
+
86
+
87
+
88
+ ### Hours of operation values treated as deltas
89
+ When this is true the hours of operation start and duration represent a delta from the original model values. When switched to false they represent absolute values.
90
+ **Name:** delta_values,
91
+ **Type:** Boolean,
92
+ **Units:** ,
93
+ **Required:** true,
94
+ **Model Dependent:** false
95
+
96
+
97
+
98
+
99
+ ### Dynamically generate parametric schedules from current ruleset schedules.
100
+ When this is true the parametric schedule formulas and hours of operation will be generated from the existing model schedules. When false it expects the model already has parametric formulas stored.
101
+ **Name:** infer_parametric_schedules,
102
+ **Type:** Boolean,
103
+ **Units:** ,
104
+ **Required:** true,
105
+ **Model Dependent:** false
106
+
107
+
108
+
109
+
110
+ ### Fraction of Daily Occupancy Range.
111
+ This determine what fraction of occupancy be considered operating conditions. This fraction is normalized to expanded to range seen over the full year and does not necessary equal fraction of design occupancy. This value should be between 0 and 1.0 and is only used if dynamically generated parametric schedules are used.
112
+ **Name:** fraction_of_daily_occ_range,
113
+ **Type:** Double,
114
+ **Units:** Hours,
115
+ **Required:** true,
116
+ **Model Dependent:** false
117
+
118
+
119
+
120
+
121
+ ### Hours of Operation Variable Method for Scheudle Profile Formula.
122
+ If dynamically generate parametric schedules from current ruleset scheudles is selected ,this argument is used to determine if the schedule profile formulas define time of points in a profile as a a specific delta from the star, middle, or end of the horus of operation, or if the delta is fractaionl percentate of the horus fo operation ro non-operation/vacant time.
123
+ **Name:** hoo_var_method,
124
+ **Type:** Choice,
125
+ **Units:** ,
126
+ **Required:** true,
127
+ **Model Dependent:** false
128
+
129
+
130
+ **Choice Display Names** ["fractional", "hours"]
131
+
132
+
133
+
134
+ ### Use model hours of operation as target
135
+ The default behavior is for this to be false. This can not be used unless Dynamically generate parametric schedules from current ruleset schedules is set to false and if the schedules in the model already have parametric profiles. When changed to true all of the hours of operation start and duration values will be ignored as the bool to treat those values as relative or absolute. Instead the hours of operation schedules for the model will be used.
136
+ **Name:** target_hoo_from_model,
137
+ **Type:** Boolean,
138
+ **Units:** ,
139
+ **Required:** true,
140
+ **Model Dependent:** false
141
+
142
+
143
+
144
+
145
+
146
+
147
+
@@ -26,6 +26,11 @@
26
26
  **Units:** <%= argument[:units] %>,
27
27
  **Required:** <%= argument[:required] %>,
28
28
  **Model Dependent:** <%= argument[:model_dependent] %>
29
+
30
+ <% if argument[:type] == "Choice" && !argument[:model_dependent]%>
31
+ **Choice Display Names** <%= argument[:choice_display_names] %>
32
+ <% end %>
33
+
29
34
  <% end %>
30
35
 
31
36
  <% if arguments.size == 0 %>