openstudio-model-articulation 0.3.1 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (203) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +2 -1
  3. data/CHANGELOG.md +28 -0
  4. data/Gemfile +6 -0
  5. data/Jenkinsfile +1 -0
  6. data/LICENSE.md +1 -1
  7. data/README.md +22 -3
  8. data/doc_templates/LICENSE.md +1 -1
  9. data/doc_templates/copyright_erb.txt +1 -1
  10. data/doc_templates/copyright_js.txt +1 -1
  11. data/doc_templates/copyright_ruby.txt +1 -1
  12. data/lib/measures/AssignConstructionSetToBuilding/LICENSE.md +1 -1
  13. data/lib/measures/AssignConstructionSetToBuilding/measure.rb +1 -1
  14. data/lib/measures/AssignConstructionSetToBuilding/measure.xml +16 -15
  15. data/lib/measures/AssignSpaceTypeBySpaceName/LICENSE.md +1 -1
  16. data/lib/measures/AssignSpaceTypeBySpaceName/measure.rb +1 -1
  17. data/lib/measures/AssignSpaceTypeBySpaceName/measure.xml +32 -13
  18. data/lib/measures/AssignSpaceTypeToBuilding/LICENSE.md +1 -1
  19. data/lib/measures/AssignSpaceTypeToBuilding/measure.rb +1 -1
  20. data/lib/measures/AssignSpaceTypeToBuilding/measure.xml +16 -15
  21. data/lib/measures/AssignSpacesToStories/LICENSE.md +1 -1
  22. data/lib/measures/AssignSpacesToStories/measure.rb +3 -5
  23. data/lib/measures/AssignSpacesToStories/measure.xml +14 -13
  24. data/lib/measures/BarAspectRatioStudy/LICENSE.md +1 -1
  25. data/lib/measures/BarAspectRatioStudy/measure.rb +3 -2
  26. data/lib/measures/BarAspectRatioStudy/measure.xml +8 -7
  27. data/lib/measures/CleanupSpaceOrigins/LICENSE.md +1 -1
  28. data/lib/measures/CleanupSpaceOrigins/measure.rb +4 -1
  29. data/lib/measures/CleanupSpaceOrigins/measure.xml +14 -13
  30. data/lib/measures/FindAndReplaceObjectNames/LICENSE.md +1 -1
  31. data/lib/measures/FindAndReplaceObjectNames/measure.rb +1 -1
  32. data/lib/measures/FindAndReplaceObjectNames/measure.xml +13 -12
  33. data/lib/measures/InjectOsmGeometryIntoAnExternalIdf/LICENSE.md +1 -1
  34. data/lib/measures/InjectOsmGeometryIntoAnExternalIdf/measure.rb +3 -3
  35. data/lib/measures/InjectOsmGeometryIntoAnExternalIdf/measure.xml +28 -10
  36. data/lib/measures/RemoveHardAssignedConstructions/LICENSE.md +1 -1
  37. data/lib/measures/RemoveHardAssignedConstructions/measure.rb +1 -1
  38. data/lib/measures/RemoveHardAssignedConstructions/measure.xml +13 -12
  39. data/lib/measures/RenameSpaceSurfacesBasedonParentSpaceandOrientation/LICENSE.md +1 -1
  40. data/lib/measures/RenameSpaceSurfacesBasedonParentSpaceandOrientation/measure.rb +1 -1
  41. data/lib/measures/RenameSpaceSurfacesBasedonParentSpaceandOrientation/measure.xml +42 -11
  42. data/lib/measures/RotateBuilding/LICENSE.md +1 -1
  43. data/lib/measures/RotateBuilding/measure.rb +1 -1
  44. data/lib/measures/RotateBuilding/measure.xml +13 -12
  45. data/lib/measures/SetExtWallToGroundBoundaryConditionByStory/LICENSE.md +1 -1
  46. data/lib/measures/SetExtWallToGroundBoundaryConditionByStory/measure.rb +1 -1
  47. data/lib/measures/SetExtWallToGroundBoundaryConditionByStory/measure.xml +17 -10
  48. data/lib/measures/SetInteriorWallsAndFloorsToAdiabatic/LICENSE.md +1 -1
  49. data/lib/measures/SetInteriorWallsAndFloorsToAdiabatic/measure.rb +2 -2
  50. data/lib/measures/SetInteriorWallsAndFloorsToAdiabatic/measure.xml +13 -12
  51. data/lib/measures/SetInteriorWallsToSelectedConstruction/LICENSE.md +1 -1
  52. data/lib/measures/SetInteriorWallsToSelectedConstruction/measure.rb +2 -2
  53. data/lib/measures/SetInteriorWallsToSelectedConstruction/measure.xml +13 -12
  54. data/lib/measures/SetWindowToWallRatioByFacade/LICENSE.md +1 -1
  55. data/lib/measures/SetWindowToWallRatioByFacade/README.md +11 -0
  56. data/lib/measures/SetWindowToWallRatioByFacade/measure.rb +91 -143
  57. data/lib/measures/SetWindowToWallRatioByFacade/measure.xml +32 -11
  58. data/lib/measures/SetWindowToWallRatioByFacade/resources/functions.rb +176 -0
  59. data/lib/measures/SimplifyGeometryToSlicedBar/LICENSE.md +1 -1
  60. data/lib/measures/SimplifyGeometryToSlicedBar/measure.rb +9 -5
  61. data/lib/measures/SimplifyGeometryToSlicedBar/measure.xml +31 -13
  62. data/lib/measures/SimplifyGeometryToSlicedBar/resources/os_lib_cofee.rb +7 -5
  63. data/lib/measures/SimplifyGeometryToSlicedBar/resources/os_lib_geometry.rb +14 -9
  64. data/lib/measures/SimplifyGeometryToSlicedBar/resources/os_lib_helper_methods.rb +3 -5
  65. data/lib/measures/SpaceTypeAndConstructionSetWizard/LICENSE.md +1 -1
  66. data/lib/measures/SpaceTypeAndConstructionSetWizard/measure.rb +2 -2
  67. data/lib/measures/SpaceTypeAndConstructionSetWizard/measure.xml +63 -11
  68. data/lib/measures/SurfaceMatching/LICENSE.md +1 -1
  69. data/lib/measures/SurfaceMatching/measure.rb +2 -1
  70. data/lib/measures/SurfaceMatching/measure.xml +13 -12
  71. data/lib/measures/{BarAspectRatioSlicedBySpaceType → add_empd_material_properties}/LICENSE.md +1 -1
  72. data/lib/measures/add_empd_material_properties/README.md +116 -0
  73. data/lib/measures/{BarAspectRatioSlicedBySpaceType → add_empd_material_properties}/README.md.erb +0 -0
  74. data/lib/measures/add_empd_material_properties/docs/.gitkeep +0 -0
  75. data/lib/measures/add_empd_material_properties/measure.rb +247 -0
  76. data/lib/measures/add_empd_material_properties/measure.xml +201 -0
  77. data/lib/measures/blended_space_type_from_floor_area_ratios/LICENSE.md +1 -1
  78. data/lib/measures/blended_space_type_from_floor_area_ratios/measure.rb +5 -4
  79. data/lib/measures/blended_space_type_from_floor_area_ratios/measure.xml +5 -5
  80. data/lib/measures/blended_space_type_from_model/LICENSE.md +1 -1
  81. data/lib/measures/blended_space_type_from_model/{resources → docs}/replace_occupied_spaces_with_blended_space_type_design_doc.txt +0 -0
  82. data/lib/measures/blended_space_type_from_model/measure.rb +16 -4
  83. data/lib/measures/blended_space_type_from_model/measure.xml +16 -22
  84. data/lib/measures/clone_building_from_external_model/LICENSE.md +1 -1
  85. data/lib/measures/clone_building_from_external_model/measure.rb +1 -1
  86. data/lib/measures/clone_building_from_external_model/measure.xml +5 -5
  87. data/lib/measures/create_DOE_prototype_building/LICENSE.md +1 -1
  88. data/lib/measures/create_DOE_prototype_building/measure.rb +4 -3
  89. data/lib/measures/create_DOE_prototype_building/measure.xml +163 -27
  90. data/lib/measures/create_and_assign_thermal_zones_for_unassigned_spaces/LICENSE.md +1 -1
  91. data/lib/measures/create_and_assign_thermal_zones_for_unassigned_spaces/measure.rb +1 -1
  92. data/lib/measures/create_and_assign_thermal_zones_for_unassigned_spaces/measure.xml +5 -5
  93. data/lib/measures/create_bar_from_building_type_ratios/LICENSE.md +1 -1
  94. data/lib/measures/create_bar_from_building_type_ratios/README.md +109 -35
  95. data/lib/measures/create_bar_from_building_type_ratios/README.md.erb +54 -35
  96. data/lib/measures/create_bar_from_building_type_ratios/measure.rb +9 -4
  97. data/lib/measures/create_bar_from_building_type_ratios/measure.xml +124 -12
  98. data/lib/measures/create_bar_from_deer_building_type_ratios/LICENSE.md +1 -1
  99. data/lib/measures/create_bar_from_deer_building_type_ratios/README.md +301 -79
  100. data/lib/measures/create_bar_from_deer_building_type_ratios/README.md.erb +62 -79
  101. data/lib/measures/create_bar_from_deer_building_type_ratios/measure.rb +10 -5
  102. data/lib/measures/create_bar_from_deer_building_type_ratios/measure.xml +15 -59
  103. data/lib/measures/create_bar_from_doe_building_type_ratios/LICENSE.md +1 -1
  104. data/lib/measures/create_bar_from_doe_building_type_ratios/README.md +298 -57
  105. data/lib/measures/create_bar_from_doe_building_type_ratios/README.md.erb +54 -57
  106. data/lib/measures/create_bar_from_doe_building_type_ratios/measure.rb +10 -5
  107. data/lib/measures/create_bar_from_doe_building_type_ratios/measure.xml +122 -14
  108. data/lib/measures/create_bar_from_model/LICENSE.md +1 -1
  109. data/lib/measures/create_bar_from_model/measure.rb +11 -7
  110. data/lib/measures/create_bar_from_model/measure.xml +5 -5
  111. data/lib/measures/create_bar_from_space_type_ratios/LICENSE.md +27 -0
  112. data/lib/measures/create_bar_from_space_type_ratios/README.md +556 -0
  113. data/lib/measures/create_bar_from_space_type_ratios/README.md.erb +324 -0
  114. data/lib/measures/create_bar_from_space_type_ratios/docs/ar_05.png +0 -0
  115. data/lib/measures/create_bar_from_space_type_ratios/docs/ar_1.png +0 -0
  116. data/lib/measures/create_bar_from_space_type_ratios/docs/ar_2.png +0 -0
  117. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_double_loaded.png +0 -0
  118. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_single_core_perim.png +0 -0
  119. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_sliced_indiv.png +0 -0
  120. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_sliced_simple.png +0 -0
  121. data/lib/measures/create_bar_from_space_type_ratios/docs/basement.png +0 -0
  122. data/lib/measures/create_bar_from_space_type_ratios/docs/custom_height_false.png +0 -0
  123. data/lib/measures/create_bar_from_space_type_ratios/docs/custom_height_true.png +0 -0
  124. data/lib/measures/create_bar_from_space_type_ratios/docs/no_party_mult.png +0 -0
  125. data/lib/measures/create_bar_from_space_type_ratios/docs/party.png +0 -0
  126. data/lib/measures/create_bar_from_space_type_ratios/docs/party_multi.png +0 -0
  127. data/lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2010.png +0 -0
  128. data/lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2012.png +0 -0
  129. data/lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2020.png +0 -0
  130. data/lib/measures/create_bar_from_space_type_ratios/docs/sep_05.png +0 -0
  131. data/lib/measures/create_bar_from_space_type_ratios/docs/sep_10.png +0 -0
  132. data/lib/measures/create_bar_from_space_type_ratios/docs/sep_3.png +0 -0
  133. data/lib/measures/create_bar_from_space_type_ratios/docs/story_sort.png +0 -0
  134. data/lib/measures/create_bar_from_space_type_ratios/docs/wwr_custom.png +0 -0
  135. data/lib/measures/create_bar_from_space_type_ratios/measure.rb +314 -0
  136. data/lib/measures/create_bar_from_space_type_ratios/measure.xml +687 -0
  137. data/lib/measures/create_baseline_building/LICENSE.md +1 -1
  138. data/lib/measures/create_baseline_building/measure.rb +4 -3
  139. data/lib/measures/create_baseline_building/measure.xml +5 -5
  140. data/lib/measures/create_deer_prototype_building/LICENSE.md +1 -1
  141. data/lib/measures/create_deer_prototype_building/measure.rb +1 -1
  142. data/lib/measures/create_deer_prototype_building/measure.xml +6 -6
  143. data/lib/measures/create_deer_prototype_building/resources/deer_building_types.rb +1 -1
  144. data/lib/measures/create_parametric_schedules/LICENSE.md +1 -1
  145. data/lib/measures/create_parametric_schedules/measure.rb +16 -11
  146. data/lib/measures/create_parametric_schedules/measure.xml +5 -5
  147. data/lib/measures/create_typical_building_from_model/LICENSE.md +1 -1
  148. data/lib/measures/create_typical_building_from_model/README.md +82 -17
  149. data/lib/measures/create_typical_building_from_model/README.md.erb +36 -16
  150. data/lib/measures/create_typical_building_from_model/measure.rb +8 -6
  151. data/lib/measures/create_typical_building_from_model/measure.xml +59 -27
  152. data/lib/measures/create_typical_building_from_model/resources/Model.hvac.rb +8 -5
  153. data/lib/measures/create_typical_deer_building_from_model/LICENSE.md +1 -1
  154. data/lib/measures/create_typical_deer_building_from_model/README.md +173 -53
  155. data/lib/measures/create_typical_deer_building_from_model/README.md.erb +57 -53
  156. data/lib/measures/create_typical_deer_building_from_model/measure.rb +8 -3
  157. data/lib/measures/create_typical_deer_building_from_model/measure.xml +26 -26
  158. data/lib/measures/create_typical_deer_building_from_model/resources/Model.hvac.rb +8 -5
  159. data/lib/measures/create_typical_doe_building_from_model/LICENSE.md +1 -1
  160. data/lib/measures/create_typical_doe_building_from_model/README.md +182 -44
  161. data/lib/measures/create_typical_doe_building_from_model/README.md.erb +58 -44
  162. data/lib/measures/create_typical_doe_building_from_model/measure.rb +8 -3
  163. data/lib/measures/create_typical_doe_building_from_model/measure.xml +60 -28
  164. data/lib/measures/create_typical_doe_building_from_model/resources/Model.hvac.rb +8 -5
  165. data/lib/measures/deer_space_type_and_construction_set_wizard/LICENSE.md +1 -1
  166. data/lib/measures/deer_space_type_and_construction_set_wizard/measure.rb +2 -2
  167. data/lib/measures/deer_space_type_and_construction_set_wizard/measure.xml +17 -17
  168. data/lib/measures/find_and_replace_in_all_thermal_zone_names/LICENSE.md +1 -1
  169. data/lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb +1 -1
  170. data/lib/measures/find_and_replace_in_all_thermal_zone_names/measure.xml +8 -7
  171. data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/LICENSE.md +1 -1
  172. data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.rb +3 -1
  173. data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.xml +5 -5
  174. data/lib/measures/merge_floorspace_js_with_model/LICENSE.md +1 -1
  175. data/lib/measures/merge_floorspace_js_with_model/measure.rb +5 -2
  176. data/lib/measures/merge_floorspace_js_with_model/measure.xml +5 -5
  177. data/lib/measures/merge_spaces_from_external_file/LICENSE.md +1 -1
  178. data/lib/measures/merge_spaces_from_external_file/measure.rb +1 -1
  179. data/lib/measures/merge_spaces_from_external_file/measure.xml +6 -6
  180. data/lib/measures/merge_spaces_from_external_file/resources/ScheduleTranslator.rb +1 -1
  181. data/lib/measures/radiance_measure/LICENSE.md +1 -1
  182. data/lib/measures/radiance_measure/measure.rb +63 -57
  183. data/lib/measures/radiance_measure/measure.xml +11 -11
  184. data/lib/measures/radiant_slab_with_doas/LICENSE.md +1 -1
  185. data/lib/measures/radiant_slab_with_doas/measure.rb +9 -2
  186. data/lib/measures/radiant_slab_with_doas/measure.xml +10 -10
  187. data/lib/measures/replace_geometry_by_story/LICENSE.md +1 -1
  188. data/lib/measures/replace_geometry_by_story/measure.rb +5 -1
  189. data/lib/measures/replace_geometry_by_story/measure.xml +5 -5
  190. data/lib/measures/scale_geometry/LICENSE.md +1 -1
  191. data/lib/measures/scale_geometry/measure.rb +1 -1
  192. data/lib/measures/scale_geometry/measure.xml +5 -5
  193. data/lib/openstudio/model_articulation/extension.rb +1 -1
  194. data/lib/openstudio/model_articulation/version.rb +2 -2
  195. data/lib/openstudio/model_articulation.rb +1 -1
  196. data/lib/openstudio-model-articulation.rb +1 -1
  197. data/openstudio-model-articulation.gemspec +3 -3
  198. metadata +42 -16
  199. data/lib/measures/BarAspectRatioSlicedBySpaceType/README.md +0 -64
  200. data/lib/measures/BarAspectRatioSlicedBySpaceType/measure.rb +0 -184
  201. data/lib/measures/BarAspectRatioSlicedBySpaceType/measure.xml +0 -130
  202. data/lib/measures/BarAspectRatioSlicedBySpaceType/resources/os_lib_cofee.rb +0 -252
  203. data/lib/measures/blended_space_type_from_model/resources/os_lib_model_simplification.rb +0 -1049
@@ -1,5 +1,5 @@
1
1
  # *******************************************************************************
2
- # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
2
+ # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
3
3
  # All rights reserved.
4
4
  # Redistribution and use in source and binary forms, with or without
5
5
  # modification, are permitted provided that the following conditions are met:
@@ -35,6 +35,6 @@
35
35
 
36
36
  module OpenStudio
37
37
  module ModelArticulation
38
- VERSION = '0.3.1'.freeze
38
+ VERSION = '0.6.0'.freeze
39
39
  end
40
40
  end
@@ -1,5 +1,5 @@
1
1
  # *******************************************************************************
2
- # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
2
+ # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
3
3
  # All rights reserved.
4
4
  # Redistribution and use in source and binary forms, with or without
5
5
  # modification, are permitted provided that the following conditions are met:
@@ -1,5 +1,5 @@
1
1
  # *******************************************************************************
2
- # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
2
+ # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
3
3
  # All rights reserved.
4
4
  # Redistribution and use in source and binary forms, with or without
5
5
  # modification, are permitted provided that the following conditions are met:
@@ -26,11 +26,11 @@ Gem::Specification.new do |spec|
26
26
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
27
27
  spec.require_paths = ['lib']
28
28
 
29
- spec.required_ruby_version = '~> 2.5.0'
29
+ spec.required_ruby_version = '~> 2.7.0'
30
30
 
31
31
  spec.add_dependency 'bundler', '~> 2.1'
32
- spec.add_dependency 'openstudio-extension', '~> 0.3.2'
33
- spec.add_dependency 'openstudio-standards', '~> 0.2.12'
32
+ spec.add_dependency 'openstudio-extension', '~> 0.5.1'
33
+ spec.add_dependency 'openstudio-standards', '~> 0.2.16'
34
34
 
35
35
  spec.add_development_dependency 'rake', '~> 13.0'
36
36
  spec.add_development_dependency 'rspec', '~> 3.9'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: openstudio-model-articulation
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Goldwasser
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-12-09 00:00:00.000000000 Z
11
+ date: 2022-05-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -30,28 +30,28 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 0.3.2
33
+ version: 0.5.1
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 0.3.2
40
+ version: 0.5.1
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: openstudio-standards
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: 0.2.12
47
+ version: 0.2.16
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: 0.2.12
54
+ version: 0.2.16
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: rake
57
57
  requirement: !ruby/object:Gem::Requirement
@@ -128,12 +128,6 @@ files:
128
128
  - lib/measures/AssignSpacesToStories/README.md.erb
129
129
  - lib/measures/AssignSpacesToStories/measure.rb
130
130
  - lib/measures/AssignSpacesToStories/measure.xml
131
- - lib/measures/BarAspectRatioSlicedBySpaceType/LICENSE.md
132
- - lib/measures/BarAspectRatioSlicedBySpaceType/README.md
133
- - lib/measures/BarAspectRatioSlicedBySpaceType/README.md.erb
134
- - lib/measures/BarAspectRatioSlicedBySpaceType/measure.rb
135
- - lib/measures/BarAspectRatioSlicedBySpaceType/measure.xml
136
- - lib/measures/BarAspectRatioSlicedBySpaceType/resources/os_lib_cofee.rb
137
131
  - lib/measures/BarAspectRatioStudy/LICENSE.md
138
132
  - lib/measures/BarAspectRatioStudy/README.md
139
133
  - lib/measures/BarAspectRatioStudy/README.md.erb
@@ -190,6 +184,7 @@ files:
190
184
  - lib/measures/SetWindowToWallRatioByFacade/README.md.erb
191
185
  - lib/measures/SetWindowToWallRatioByFacade/measure.rb
192
186
  - lib/measures/SetWindowToWallRatioByFacade/measure.xml
187
+ - lib/measures/SetWindowToWallRatioByFacade/resources/functions.rb
193
188
  - lib/measures/SimplifyGeometryToSlicedBar/LICENSE.md
194
189
  - lib/measures/SimplifyGeometryToSlicedBar/README.md
195
190
  - lib/measures/SimplifyGeometryToSlicedBar/README.md.erb
@@ -210,6 +205,12 @@ files:
210
205
  - lib/measures/SurfaceMatching/README.md.erb
211
206
  - lib/measures/SurfaceMatching/measure.rb
212
207
  - lib/measures/SurfaceMatching/measure.xml
208
+ - lib/measures/add_empd_material_properties/LICENSE.md
209
+ - lib/measures/add_empd_material_properties/README.md
210
+ - lib/measures/add_empd_material_properties/README.md.erb
211
+ - lib/measures/add_empd_material_properties/docs/.gitkeep
212
+ - lib/measures/add_empd_material_properties/measure.rb
213
+ - lib/measures/add_empd_material_properties/measure.xml
213
214
  - lib/measures/blended_space_type_from_floor_area_ratios/LICENSE.md
214
215
  - lib/measures/blended_space_type_from_floor_area_ratios/README.md
215
216
  - lib/measures/blended_space_type_from_floor_area_ratios/README.md.erb
@@ -219,10 +220,9 @@ files:
219
220
  - lib/measures/blended_space_type_from_model/LICENSE.md
220
221
  - lib/measures/blended_space_type_from_model/README.md
221
222
  - lib/measures/blended_space_type_from_model/README.md.erb
223
+ - lib/measures/blended_space_type_from_model/docs/replace_occupied_spaces_with_blended_space_type_design_doc.txt
222
224
  - lib/measures/blended_space_type_from_model/measure.rb
223
225
  - lib/measures/blended_space_type_from_model/measure.xml
224
- - lib/measures/blended_space_type_from_model/resources/os_lib_model_simplification.rb
225
- - lib/measures/blended_space_type_from_model/resources/replace_occupied_spaces_with_blended_space_type_design_doc.txt
226
226
  - lib/measures/clone_building_from_external_model/LICENSE.md
227
227
  - lib/measures/clone_building_from_external_model/README.md
228
228
  - lib/measures/clone_building_from_external_model/README.md.erb
@@ -321,6 +321,32 @@ files:
321
321
  - lib/measures/create_bar_from_model/README.md.erb
322
322
  - lib/measures/create_bar_from_model/measure.rb
323
323
  - lib/measures/create_bar_from_model/measure.xml
324
+ - lib/measures/create_bar_from_space_type_ratios/LICENSE.md
325
+ - lib/measures/create_bar_from_space_type_ratios/README.md
326
+ - lib/measures/create_bar_from_space_type_ratios/README.md.erb
327
+ - lib/measures/create_bar_from_space_type_ratios/docs/ar_05.png
328
+ - lib/measures/create_bar_from_space_type_ratios/docs/ar_1.png
329
+ - lib/measures/create_bar_from_space_type_ratios/docs/ar_2.png
330
+ - lib/measures/create_bar_from_space_type_ratios/docs/bar_double_loaded.png
331
+ - lib/measures/create_bar_from_space_type_ratios/docs/bar_single_core_perim.png
332
+ - lib/measures/create_bar_from_space_type_ratios/docs/bar_sliced_indiv.png
333
+ - lib/measures/create_bar_from_space_type_ratios/docs/bar_sliced_simple.png
334
+ - lib/measures/create_bar_from_space_type_ratios/docs/basement.png
335
+ - lib/measures/create_bar_from_space_type_ratios/docs/custom_height_false.png
336
+ - lib/measures/create_bar_from_space_type_ratios/docs/custom_height_true.png
337
+ - lib/measures/create_bar_from_space_type_ratios/docs/no_party_mult.png
338
+ - lib/measures/create_bar_from_space_type_ratios/docs/party.png
339
+ - lib/measures/create_bar_from_space_type_ratios/docs/party_multi.png
340
+ - lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2010.png
341
+ - lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2012.png
342
+ - lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2020.png
343
+ - lib/measures/create_bar_from_space_type_ratios/docs/sep_05.png
344
+ - lib/measures/create_bar_from_space_type_ratios/docs/sep_10.png
345
+ - lib/measures/create_bar_from_space_type_ratios/docs/sep_3.png
346
+ - lib/measures/create_bar_from_space_type_ratios/docs/story_sort.png
347
+ - lib/measures/create_bar_from_space_type_ratios/docs/wwr_custom.png
348
+ - lib/measures/create_bar_from_space_type_ratios/measure.rb
349
+ - lib/measures/create_bar_from_space_type_ratios/measure.xml
324
350
  - lib/measures/create_baseline_building/LICENSE.md
325
351
  - lib/measures/create_baseline_building/README.md
326
352
  - lib/measures/create_baseline_building/README.md.erb
@@ -412,7 +438,7 @@ licenses: []
412
438
  metadata:
413
439
  bug_tracker_uri: https://github.com/NREL/openstudio-model-articulation-gem/issues
414
440
  changelog_uri: https://github.com/NREL/openstudio-model-articulation-gem/blob/develop/CHANGELOG.md
415
- source_code_uri: https://github.com/NREL/openstudio-model-articulation-gem/tree/v0.3.1
441
+ source_code_uri: https://github.com/NREL/openstudio-model-articulation-gem/tree/v0.6.0
416
442
  post_install_message:
417
443
  rdoc_options: []
418
444
  require_paths:
@@ -421,7 +447,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
421
447
  requirements:
422
448
  - - "~>"
423
449
  - !ruby/object:Gem::Version
424
- version: 2.5.0
450
+ version: 2.7.0
425
451
  required_rubygems_version: !ruby/object:Gem::Requirement
426
452
  requirements:
427
453
  - - ">="
@@ -1,64 +0,0 @@
1
-
2
-
3
- ###### (Automatically generated documentation)
4
-
5
- # BarAspectRatioSlicedBySpaceType
6
-
7
- ## Description
8
-
9
-
10
- ## Modeler Description
11
-
12
-
13
- ## Measure Type
14
- ModelMeasure
15
-
16
- ## Taxonomy
17
-
18
-
19
- ## Arguments
20
-
21
-
22
- ### Total Building Floor Area (ft^2).
23
-
24
- **Name:** total_bldg_area_ip,
25
- **Type:** Double,
26
- **Units:** ,
27
- **Required:** true,
28
- **Model Dependent:** false
29
-
30
- ### Ratio of North/South Facade Length Relative to East/West Facade Length.
31
-
32
- **Name:** ns_to_ew_ratio,
33
- **Type:** Double,
34
- **Units:** ,
35
- **Required:** true,
36
- **Model Dependent:** false
37
-
38
- ### Number of Floors.
39
-
40
- **Name:** num_floors,
41
- **Type:** Integer,
42
- **Units:** ,
43
- **Required:** true,
44
- **Model Dependent:** false
45
-
46
- ### Floor to Floor Height (ft).
47
-
48
- **Name:** floor_to_floor_height_ip,
49
- **Type:** Double,
50
- **Units:** ,
51
- **Required:** true,
52
- **Model Dependent:** false
53
-
54
- ### Hash of Space Types with Name as Key and Fraction as value.
55
-
56
- **Name:** spaceTypeHashString,
57
- **Type:** String,
58
- **Units:** ,
59
- **Required:** true,
60
- **Model Dependent:** false
61
-
62
-
63
-
64
-
@@ -1,184 +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
- # see the URL below for information on how to write OpenStudio measures
37
- # http://openstudio.nrel.gov/openstudio-measure-writing-guide
38
-
39
- # see the URL below for information on using life cycle cost objects in OpenStudio
40
- # http://openstudio.nrel.gov/openstudio-life-cycle-examples
41
-
42
- # see the URL below for access to C++ documentation on model objects (click on "model" in the main window to view model objects)
43
- # http://openstudio.nrel.gov/sites/openstudio.nrel.gov/files/nv_data/cpp_documentation_it/model/html/namespaces.html
44
-
45
- # load OpenStudio measure libraries from openstudio-extension gem
46
- require 'openstudio-extension'
47
- require 'openstudio/extension/core/os_lib_helper_methods'
48
- require 'openstudio/extension/core/os_lib_geometry.rb'
49
-
50
- # load OpenStudio measure libraries
51
- require "#{File.dirname(__FILE__)}/resources/os_lib_cofee"
52
-
53
- # start the measure
54
- class BarAspectRatioSlicedBySpaceType < OpenStudio::Measure::ModelMeasure
55
- # define the name that a user will see, this method may be deprecated as
56
- # the display name in PAT comes from the name field in measure.xml
57
- def name
58
- return 'BarAspectRatioSlicedBySpaceType'
59
- end
60
-
61
- # define the arguments that the user will input
62
- def arguments(model)
63
- args = OpenStudio::Measure::OSArgumentVector.new
64
-
65
- # make an argument for total floor area
66
- total_bldg_area_ip = OpenStudio::Measure::OSArgument.makeDoubleArgument('total_bldg_area_ip', true)
67
- total_bldg_area_ip.setDisplayName('Total Building Floor Area (ft^2).')
68
- total_bldg_area_ip.setDefaultValue(10000.0)
69
- args << total_bldg_area_ip
70
-
71
- # make an argument for aspect ratio
72
- ns_to_ew_ratio = OpenStudio::Measure::OSArgument.makeDoubleArgument('ns_to_ew_ratio', true)
73
- ns_to_ew_ratio.setDisplayName('Ratio of North/South Facade Length Relative to East/West Facade Length.')
74
- ns_to_ew_ratio.setDefaultValue(2.0)
75
- args << ns_to_ew_ratio
76
-
77
- # make an argument for number of floors
78
- num_floors = OpenStudio::Measure::OSArgument.makeIntegerArgument('num_floors', true)
79
- num_floors.setDisplayName('Number of Floors.')
80
- num_floors.setDefaultValue(2)
81
- args << num_floors
82
-
83
- # make an argument for floor height
84
- floor_to_floor_height_ip = OpenStudio::Measure::OSArgument.makeDoubleArgument('floor_to_floor_height_ip', true)
85
- floor_to_floor_height_ip.setDisplayName('Floor to Floor Height (ft).')
86
- floor_to_floor_height_ip.setDefaultValue(10.0)
87
- args << floor_to_floor_height_ip
88
-
89
- # make an argument for the meter name
90
- spaceTypeHashString = OpenStudio::Measure::OSArgument.makeStringArgument('spaceTypeHashString', true)
91
- spaceTypeHashString.setDisplayName('Hash of Space Types with Name as Key and Fraction as value.')
92
- args << spaceTypeHashString
93
-
94
- return args
95
- end
96
-
97
- # define what happens when the measure is run
98
- def run(model, runner, user_arguments)
99
- super(model, runner, user_arguments)
100
-
101
- # use the built-in error checking
102
- if !runner.validateUserArguments(arguments(model), user_arguments)
103
- return false
104
- end
105
-
106
- # assign the user inputs to variables
107
- total_bldg_area_ip = runner.getDoubleArgumentValue('total_bldg_area_ip', user_arguments)
108
- ns_to_ew_ratio = runner.getDoubleArgumentValue('ns_to_ew_ratio', user_arguments)
109
- num_floors = runner.getIntegerArgumentValue('num_floors', user_arguments)
110
- floor_to_floor_height_ip = runner.getDoubleArgumentValue('floor_to_floor_height_ip', user_arguments)
111
- spaceTypeHashString = runner.getStringArgumentValue('spaceTypeHashString', user_arguments)
112
-
113
- # test for positive inputs
114
- if total_bldg_area_ip <= 0
115
- runner.registerError('Enter a total building area greater than 0.')
116
- end
117
- if ns_to_ew_ratio <= 0
118
- runner.registerError('Enter ratio grater than 0.')
119
- end
120
- if num_floors <= 0
121
- runner.registerError('Enter a number of stories 1 or greater.')
122
- end
123
- if floor_to_floor_height_ip <= 0
124
- runner.registerError('Enter a positive floor height.')
125
- end
126
- if 1 == 1
127
- # TODO: - add test for spaceTypeHashString argument
128
- end
129
-
130
- # calculate needed variables
131
- total_bldg_area_si = OpenStudio.convert(total_bldg_area_ip, 'ft^2', 'm^2').get
132
- footprint_ip = total_bldg_area_ip / num_floors
133
- footprint_si = OpenStudio.convert(footprint_ip, 'ft^2', 'm^2').get
134
- floor_to_floor_height = OpenStudio.convert(floor_to_floor_height_ip, 'ft', 'm').get
135
-
136
- # variables from original rectangle script not exposed in this measure
137
- width = Math.sqrt(footprint_si / ns_to_ew_ratio)
138
- length = footprint_si / width
139
-
140
- # reporting initial condition of model
141
- starting_spaces = model.getSpaces
142
- runner.registerInitialCondition("The building started with #{starting_spaces.size} spaces.")
143
-
144
- # convert string argument to hash
145
- spaceTypeHashName = {}
146
- spaceTypeHashString[1..-2].split(/, /).each { |entry| entryMap = entry.split(/=>/); value_str = entryMap[1]; spaceTypeHashName[entryMap[0].strip[1..-1].to_s] = value_str.nil? ? '' : value_str.strip[1..-2].to_f }
147
-
148
- # sum of hash values
149
- hashValues = 0
150
-
151
- spaceTypeHash = {}
152
- model.getSpaceTypes.each do |spaceType|
153
- if spaceTypeHashName.include?(spaceType.name.to_s)
154
- spaceTypeHash[spaceType] = spaceTypeHashName[spaceType.name.to_s] * total_bldg_area_si # converting fractional value to area value to pass into method
155
- hashValues += spaceTypeHashName[spaceType.name.to_s]
156
- end
157
- end
158
-
159
- if hashValues != 1.0
160
- runner.registerWarning('Fractional hash values do not add up to one. Resulting geometry may not have expected area.')
161
- end
162
-
163
- # see which path to take
164
- midFloorMultiplier = 1 # show as 1 even on 1 and 2 story buildings where there is no mid floor, in addition to 3 story building
165
- if num_floors > 3
166
- # use floor multiplier version. Set mid floor multiplier, use adibatic floors/ceilings and set constructions, raise up building
167
- midFloorMultiplier = num_floors - 2
168
- end
169
-
170
- # run method to create envelope
171
- bar_AspectRatio = OsLib_Cofee.createBar(model, spaceTypeHash, length, width, total_bldg_area_si, num_floors, midFloorMultiplier, 0.0, 0.0, length, width, 0.0, floor_to_floor_height * num_floors, true)
172
-
173
- puts "building area #{model.getBuilding.floorArea}"
174
-
175
- # reporting final condition of model
176
- finishing_spaces = model.getSpaces
177
- runner.registerFinalCondition("The building finished with #{finishing_spaces.size} spaces.")
178
-
179
- return true
180
- end
181
- end
182
-
183
- # this allows the measure to be use by the application
184
- BarAspectRatioSlicedBySpaceType.new.registerWithApplication
@@ -1,130 +0,0 @@
1
- <?xml version="1.0"?>
2
- <measure>
3
- <schema_version>3.0</schema_version>
4
- <name>bar_aspect_ratio_sliced_by_space_type</name>
5
- <uid>3e988765-9673-46f8-9b65-99d5b86c2b22</uid>
6
- <version_id>ae664185-7251-4abb-b2e0-5a7c1893e519</version_id>
7
- <version_modified>20200509T155942Z</version_modified>
8
- <xml_checksum>49BEF039</xml_checksum>
9
- <class_name>BarAspectRatioSlicedBySpaceType</class_name>
10
- <display_name>BarAspectRatioSlicedBySpaceType</display_name>
11
- <description>This measure will create a building envelope based on a target floor area, aspect ratio, floor to floor height, and a collectin of space types and fraction of building using that space type.</description>
12
- <modeler_description>This is based on the SketchUp Plugin user script to create a rectangular building, but just uses different inputs. The resulting building will have a core and perimeter zoning, unless it is too small, in which case eac floor will have a single zone. This uses a floor multiplier for buildings taller than three stories. Below is an example of what the space tyep hash might look like. Sum of hash values should equal 1.0. "{:189.1-2009 - Office - Corridor - CZ1-3 =&gt; '0.3', :189.1-2009 - Office - Conference - CZ1-3 =&gt; '0.2', :189.1-2009 - Office - ClosedOffice - CZ1-3 =&gt; '0.5' }"</modeler_description>
13
- <arguments>
14
- <argument>
15
- <name>total_bldg_area_ip</name>
16
- <display_name>Total Building Floor Area (ft^2).</display_name>
17
- <type>Double</type>
18
- <required>true</required>
19
- <model_dependent>false</model_dependent>
20
- <default_value>10000</default_value>
21
- </argument>
22
- <argument>
23
- <name>ns_to_ew_ratio</name>
24
- <display_name>Ratio of North/South Facade Length Relative to East/West Facade Length.</display_name>
25
- <type>Double</type>
26
- <required>true</required>
27
- <model_dependent>false</model_dependent>
28
- <default_value>2</default_value>
29
- </argument>
30
- <argument>
31
- <name>num_floors</name>
32
- <display_name>Number of Floors.</display_name>
33
- <type>Integer</type>
34
- <required>true</required>
35
- <model_dependent>false</model_dependent>
36
- <default_value>2</default_value>
37
- </argument>
38
- <argument>
39
- <name>floor_to_floor_height_ip</name>
40
- <display_name>Floor to Floor Height (ft).</display_name>
41
- <type>Double</type>
42
- <required>true</required>
43
- <model_dependent>false</model_dependent>
44
- <default_value>10</default_value>
45
- </argument>
46
- <argument>
47
- <name>spaceTypeHashString</name>
48
- <display_name>Hash of Space Types with Name as Key and Fraction as value.</display_name>
49
- <type>String</type>
50
- <required>true</required>
51
- <model_dependent>false</model_dependent>
52
- </argument>
53
- </arguments>
54
- <outputs />
55
- <provenances />
56
- <tags>
57
- <tag>Envelope.Form</tag>
58
- </tags>
59
- <attributes>
60
- <attribute>
61
- <name>Measure Type</name>
62
- <value>ModelMeasure</value>
63
- <datatype>string</datatype>
64
- </attribute>
65
- <attribute>
66
- <name>Measure Function</name>
67
- <value>Measure</value>
68
- <datatype>string</datatype>
69
- </attribute>
70
- <attribute>
71
- <name>Requires EnergyPlus Results</name>
72
- <value>false</value>
73
- <datatype>boolean</datatype>
74
- </attribute>
75
- <attribute>
76
- <name>Uses SketchUp API</name>
77
- <value>false</value>
78
- <datatype>boolean</datatype>
79
- </attribute>
80
- </attributes>
81
- <files>
82
- <file>
83
- <filename>Untitled.osm</filename>
84
- <filetype>osm</filetype>
85
- <usage_type>test</usage_type>
86
- <checksum>3FDFD18A</checksum>
87
- </file>
88
- <file>
89
- <filename>README.md</filename>
90
- <filetype>md</filetype>
91
- <usage_type>readme</usage_type>
92
- <checksum>C0E5A870</checksum>
93
- </file>
94
- <file>
95
- <filename>README.md.erb</filename>
96
- <filetype>erb</filetype>
97
- <usage_type>readmeerb</usage_type>
98
- <checksum>703C9964</checksum>
99
- </file>
100
- <file>
101
- <filename>os_lib_cofee.rb</filename>
102
- <filetype>rb</filetype>
103
- <usage_type>resource</usage_type>
104
- <checksum>3C10BF38</checksum>
105
- </file>
106
- <file>
107
- <filename>LICENSE.md</filename>
108
- <filetype>md</filetype>
109
- <usage_type>license</usage_type>
110
- <checksum>E0468DD6</checksum>
111
- </file>
112
- <file>
113
- <filename>BarAspectRatioSlicedBySpaceType_Test.rb</filename>
114
- <filetype>rb</filetype>
115
- <usage_type>test</usage_type>
116
- <checksum>9F6868DA</checksum>
117
- </file>
118
- <file>
119
- <version>
120
- <software_program>OpenStudio</software_program>
121
- <identifier>2.0.0</identifier>
122
- <min_compatible>2.8.0</min_compatible>
123
- </version>
124
- <filename>measure.rb</filename>
125
- <filetype>rb</filetype>
126
- <usage_type>script</usage_type>
127
- <checksum>11E11D57</checksum>
128
- </file>
129
- </files>
130
- </measure>