honeybee-openstudio 0 → 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +32 -33
  4. data/.releaserc.json +7 -7
  5. data/.travis.yml +41 -0
  6. data/Gemfile +18 -14
  7. data/LICENSE.md +23 -23
  8. data/README.md +95 -95
  9. data/Rakefile +21 -16
  10. data/doc_templates/LICENSE.md +23 -23
  11. data/doc_templates/copyright_erb.txt +31 -31
  12. data/doc_templates/copyright_js.txt +4 -4
  13. data/doc_templates/copyright_ruby.txt +29 -29
  14. data/honeybee-openstudio.gemspec +35 -38
  15. data/lib/files/Honeybee.rb +112 -112
  16. data/lib/files/honeybee_workflow.osw +47 -47
  17. data/lib/files/urbanopt_Gemfile +32 -32
  18. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/model.json +8126 -11310
  19. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/simulation-parameter.json +842 -972
  20. data/lib/{to_openstudio → from_honeybee}/construction/air.rb +65 -56
  21. data/lib/{to_openstudio → from_honeybee}/construction/opaque.rb +77 -67
  22. data/lib/{to_openstudio → from_honeybee}/construction/shade.rb +108 -99
  23. data/lib/{to_openstudio → from_honeybee}/construction/window.rb +80 -70
  24. data/lib/{to_openstudio → from_honeybee}/construction_set.rb +278 -266
  25. data/lib/{honeybee → from_honeybee}/extension.rb +109 -129
  26. data/lib/{to_openstudio → from_honeybee}/geometry/aperture.rb +167 -157
  27. data/lib/{to_openstudio → from_honeybee}/geometry/door.rb +160 -150
  28. data/lib/{to_openstudio → from_honeybee}/geometry/face.rb +163 -178
  29. data/lib/{to_openstudio → from_honeybee}/geometry/room.rb +392 -442
  30. data/lib/{to_openstudio → from_honeybee}/geometry/shade.rb +89 -79
  31. data/lib/{to_openstudio → from_honeybee}/hvac/ideal_air.rb +150 -141
  32. data/lib/{to_openstudio → from_honeybee}/load/electric_equipment.rb +96 -87
  33. data/lib/{to_openstudio → from_honeybee}/load/gas_equipment.rb +97 -88
  34. data/lib/{to_openstudio → from_honeybee}/load/infiltration.rb +94 -85
  35. data/lib/{to_openstudio → from_honeybee}/load/lighting.rb +98 -89
  36. data/lib/{to_openstudio → from_honeybee}/load/people.rb +100 -91
  37. data/lib/{to_openstudio → from_honeybee}/load/setpoint_humidistat.rb +75 -66
  38. data/lib/{to_openstudio → from_honeybee}/load/setpoint_thermostat.rb +71 -62
  39. data/lib/{to_openstudio → from_honeybee}/load/ventilation.rb +96 -87
  40. data/lib/{to_openstudio → from_honeybee}/material/opaque.rb +94 -85
  41. data/lib/{to_openstudio → from_honeybee}/material/opaque_no_mass.rb +94 -85
  42. data/lib/{to_openstudio → from_honeybee}/material/window_blind.rb +238 -229
  43. data/lib/{to_openstudio → from_honeybee}/material/window_gas.rb +76 -67
  44. data/lib/{to_openstudio → from_honeybee}/material/window_gas_custom.rb +118 -108
  45. data/lib/{to_openstudio → from_honeybee}/material/window_gas_mixture.rb +79 -70
  46. data/lib/{to_openstudio → from_honeybee}/material/window_glazing.rb +166 -157
  47. data/lib/{to_openstudio → from_honeybee}/material/window_shade.rb +160 -151
  48. data/lib/{to_openstudio → from_honeybee}/material/window_simpleglazsys.rb +73 -64
  49. data/lib/from_honeybee/model.rb +434 -0
  50. data/lib/{honeybee → from_honeybee}/model_object.rb +110 -108
  51. data/lib/{to_openstudio → from_honeybee}/program_type.rb +124 -104
  52. data/lib/{to_openstudio → from_honeybee}/schedule/fixed_interval.rb +115 -105
  53. data/lib/{to_openstudio → from_honeybee}/schedule/ruleset.rb +164 -164
  54. data/lib/{to_openstudio → from_honeybee}/schedule/type_limit.rb +88 -76
  55. data/lib/{to_openstudio/simulation/design_day.rb → from_honeybee/simulation/designday.rb} +105 -96
  56. data/lib/{honeybee/load/lighting.rb → from_honeybee/simulation/extension.rb} +46 -43
  57. data/lib/{to_openstudio/simulation/parameter_model.rb → from_honeybee/simulation/parameter.rb} +277 -243
  58. data/lib/{honeybee/simulation/design_day.rb → from_honeybee/version.rb} +34 -42
  59. data/lib/{honeybee.rb → from_honeybee.rb} +86 -93
  60. data/lib/measures/from_honeybee_model/LICENSE.md +27 -23
  61. data/lib/measures/from_honeybee_model/README.md +32 -32
  62. data/lib/measures/from_honeybee_model/measure.rb +91 -91
  63. data/lib/measures/from_honeybee_model/measure.xml +103 -80
  64. data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -126
  65. data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +27 -23
  66. data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -32
  67. data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -95
  68. data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -86
  69. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
  70. metadata +89 -147
  71. data/.github/workflows/ci.yaml +0 -88
  72. data/doc_templates/README.md.erb +0 -42
  73. data/lib/from_openstudio/geometry/aperture.rb +0 -136
  74. data/lib/from_openstudio/geometry/door.rb +0 -136
  75. data/lib/from_openstudio/geometry/face.rb +0 -174
  76. data/lib/from_openstudio/geometry/room.rb +0 -121
  77. data/lib/from_openstudio/geometry/shade.rb +0 -87
  78. data/lib/from_openstudio/model.rb +0 -123
  79. data/lib/from_openstudio/model_object.rb +0 -43
  80. data/lib/from_openstudio/simulation/design_day.rb +0 -123
  81. data/lib/from_openstudio/simulation/parameter_model.rb +0 -93
  82. data/lib/from_openstudio/simulation/simulation_output.rb +0 -67
  83. data/lib/from_openstudio.rb +0 -49
  84. data/lib/honeybee/_defaults/energy_default.json +0 -1682
  85. data/lib/honeybee/construction/air.rb +0 -42
  86. data/lib/honeybee/construction/opaque.rb +0 -42
  87. data/lib/honeybee/construction/shade.rb +0 -42
  88. data/lib/honeybee/construction/window.rb +0 -51
  89. data/lib/honeybee/construction/windowshade.rb +0 -43
  90. data/lib/honeybee/construction_set.rb +0 -42
  91. data/lib/honeybee/geometry/aperture.rb +0 -42
  92. data/lib/honeybee/geometry/door.rb +0 -42
  93. data/lib/honeybee/geometry/face.rb +0 -48
  94. data/lib/honeybee/geometry/room.rb +0 -56
  95. data/lib/honeybee/geometry/shade.rb +0 -42
  96. data/lib/honeybee/hvac/ideal_air.rb +0 -42
  97. data/lib/honeybee/hvac/template.rb +0 -73
  98. data/lib/honeybee/load/electric_equipment.rb +0 -42
  99. data/lib/honeybee/load/gas_equipment.rb +0 -42
  100. data/lib/honeybee/load/infiltration.rb +0 -42
  101. data/lib/honeybee/load/people.rb +0 -42
  102. data/lib/honeybee/load/setpoint_humidistat.rb +0 -46
  103. data/lib/honeybee/load/setpoint_thermostat.rb +0 -46
  104. data/lib/honeybee/load/ventilation.rb +0 -42
  105. data/lib/honeybee/material/opaque.rb +0 -42
  106. data/lib/honeybee/material/opaque_no_mass.rb +0 -42
  107. data/lib/honeybee/material/window_blind.rb +0 -42
  108. data/lib/honeybee/material/window_gas.rb +0 -42
  109. data/lib/honeybee/material/window_gas_custom.rb +0 -42
  110. data/lib/honeybee/material/window_gas_mixture.rb +0 -42
  111. data/lib/honeybee/material/window_glazing.rb +0 -42
  112. data/lib/honeybee/material/window_shade.rb +0 -42
  113. data/lib/honeybee/material/window_simpleglazsys.rb +0 -42
  114. data/lib/honeybee/model.rb +0 -87
  115. data/lib/honeybee/program_type.rb +0 -56
  116. data/lib/honeybee/schedule/fixed_interval.rb +0 -42
  117. data/lib/honeybee/schedule/ruleset.rb +0 -42
  118. data/lib/honeybee/schedule/type_limit.rb +0 -42
  119. data/lib/honeybee/simulation/parameter_model.rb +0 -86
  120. data/lib/honeybee/simulation/simulation_output.rb +0 -42
  121. data/lib/honeybee/ventcool/control.rb +0 -42
  122. data/lib/honeybee/ventcool/opening.rb +0 -46
  123. data/lib/honeybee/ventcool/simulation.rb +0 -42
  124. data/lib/to_openstudio/construction/windowshade.rb +0 -196
  125. data/lib/to_openstudio/hvac/Model.hvac.rb +0 -641
  126. data/lib/to_openstudio/hvac/template.rb +0 -169
  127. data/lib/to_openstudio/model.rb +0 -497
  128. data/lib/to_openstudio/model_object.rb +0 -52
  129. data/lib/to_openstudio/ventcool/control.rb +0 -185
  130. data/lib/to_openstudio/ventcool/opening.rb +0 -189
  131. data/lib/to_openstudio/ventcool/simulation.rb +0 -101
  132. data/lib/to_openstudio.rb +0 -92
@@ -1,80 +1,103 @@
1
- <?xml version="1.0"?>
2
- <measure>
3
- <schema_version>3.0</schema_version>
4
- <name>from_honeybee_model</name>
5
- <uid>a5f500d5-97ff-4048-a6f4-6b0b0a92d0f0</uid>
6
- <version_id>1171d409-32be-4b94-baae-56d59a7e3b1d</version_id>
7
- <version_modified>20201124T031956Z</version_modified>
8
- <xml_checksum>D8922A73</xml_checksum>
9
- <class_name>FromHoneybeeModel</class_name>
10
- <display_name>From Honeybee Model</display_name>
11
- <description>Translate a JSON file of a Honeybee Model into an OpenStudio Model.</description>
12
- <modeler_description>Translate a JSON file of a Honeybee Model into an OpenStudio Model.</modeler_description>
13
- <arguments>
14
- <argument>
15
- <name>model_json</name>
16
- <display_name>Path to the Honeybee Model JSON file</display_name>
17
- <type>String</type>
18
- <required>true</required>
19
- <model_dependent>false</model_dependent>
20
- </argument>
21
- </arguments>
22
- <outputs />
23
- <provenances />
24
- <tags>
25
- <tag>Whole Building.Space Types</tag>
26
- </tags>
27
- <attributes>
28
- <attribute>
29
- <name>Measure Type</name>
30
- <value>ModelMeasure</value>
31
- <datatype>string</datatype>
32
- </attribute>
33
- <attribute>
34
- <name>Intended Software Tool</name>
35
- <value>Apply Measure Now</value>
36
- <datatype>string</datatype>
37
- </attribute>
38
- <attribute>
39
- <name>Intended Software Tool</name>
40
- <value>OpenStudio Application</value>
41
- <datatype>string</datatype>
42
- </attribute>
43
- <attribute>
44
- <name>Intended Software Tool</name>
45
- <value>Parametric Analysis Tool</value>
46
- <datatype>string</datatype>
47
- </attribute>
48
- </attributes>
49
- <files>
50
- <file>
51
- <filename>LICENSE.md</filename>
52
- <filetype>md</filetype>
53
- <usage_type>license</usage_type>
54
- <checksum>1E0EDDB0</checksum>
55
- </file>
56
- <file>
57
- <filename>README.md</filename>
58
- <filetype>md</filetype>
59
- <usage_type>readme</usage_type>
60
- <checksum>782C496D</checksum>
61
- </file>
62
- <file>
63
- <version>
64
- <software_program>OpenStudio</software_program>
65
- <identifier>2.0.0</identifier>
66
- <min_compatible>2.0.0</min_compatible>
67
- </version>
68
- <filename>measure.rb</filename>
69
- <filetype>rb</filetype>
70
- <usage_type>script</usage_type>
71
- <checksum>8B48C43C</checksum>
72
- </file>
73
- <file>
74
- <filename>from_honeybee_model_test.rb</filename>
75
- <filetype>rb</filetype>
76
- <usage_type>test</usage_type>
77
- <checksum>A800695A</checksum>
78
- </file>
79
- </files>
80
- </measure>
1
+ <measure>
2
+ <schema_version>3.0</schema_version>
3
+ <name>from_honeybee_model</name>
4
+ <uid>a5f500d5-97ff-4048-a6f4-6b0b0a92d0f0</uid>
5
+ <version_id>ad76277e-d175-4f0d-a667-936d3aa65420</version_id>
6
+ <version_modified>20190315T212648Z</version_modified>
7
+ <xml_checksum>D8922A73</xml_checksum>
8
+ <class_name>FromHoneybeeModel</class_name>
9
+ <display_name>From Honeybee Model</display_name>
10
+ <description>Translate a JSON file of a Honeybee Model into an OpenStudio Model.</description>
11
+ <modeler_description>Translate a JSON file of a Honeybee Model into an OpenStudio Model.</modeler_description>
12
+ <arguments>
13
+ <argument>
14
+ <name>model_json</name>
15
+ <display_name>Path to the Honeybee Model JSON file</display_name>
16
+ <type>String</type>
17
+ <required>true</required>
18
+ <model_dependent>false</model_dependent>
19
+ </argument>
20
+ </arguments>
21
+ <outputs/>
22
+ <provenances/>
23
+ <tags>
24
+ <tag>Whole Building.Space Types</tag>
25
+ </tags>
26
+ <attributes>
27
+ <attribute>
28
+ <name>Measure Type</name>
29
+ <value>ModelMeasure</value>
30
+ <datatype>string</datatype>
31
+ </attribute>
32
+ <attribute>
33
+ <name>Intended Software Tool</name>
34
+ <value>Apply Measure Now</value>
35
+ <datatype>string</datatype>
36
+ </attribute>
37
+ <attribute>
38
+ <name>Intended Software Tool</name>
39
+ <value>OpenStudio Application</value>
40
+ <datatype>string</datatype>
41
+ </attribute>
42
+ <attribute>
43
+ <name>Intended Software Tool</name>
44
+ <value>Parametric Analysis Tool</value>
45
+ <datatype>string</datatype>
46
+ </attribute>
47
+ </attributes>
48
+ <files>
49
+ <file>
50
+ <filename>LICENSE.md</filename>
51
+ <filetype>md</filetype>
52
+ <usage_type>license</usage_type>
53
+ <checksum>9640B6CB</checksum>
54
+ </file>
55
+ <file>
56
+ <filename>README.md</filename>
57
+ <filetype>md</filetype>
58
+ <usage_type>readme</usage_type>
59
+ <checksum>0004EA60</checksum>
60
+ </file>
61
+ <file>
62
+ <filename>from_honeybee_model_test.rb</filename>
63
+ <filetype>rb</filetype>
64
+ <usage_type>test</usage_type>
65
+ <checksum>F6C13DE7</checksum>
66
+ </file>
67
+ <file>
68
+ <filename>model_complete_lab_building.json</filename>
69
+ <filetype>json</filetype>
70
+ <usage_type>test</usage_type>
71
+ <checksum>E2C31DBD</checksum>
72
+ </file>
73
+ <file>
74
+ <filename>model_complete_multi_zone_office.json</filename>
75
+ <filetype>json</filetype>
76
+ <usage_type>test</usage_type>
77
+ <checksum>E2C31DBD</checksum>
78
+ </file>
79
+ <file>
80
+ <filename>model_complete_single_zone_office_fixed_interval.json</filename>
81
+ <filetype>json</filetype>
82
+ <usage_type>test</usage_type>
83
+ <checksum>E2C31DBD</checksum>
84
+ </file>
85
+ <file>
86
+ <filename>model_shoe_box.json</filename>
87
+ <filetype>json</filetype>
88
+ <usage_type>test</usage_type>
89
+ <checksum>E2C31DBD</checksum>
90
+ </file>
91
+ <file>
92
+ <version>
93
+ <software_program>OpenStudio</software_program>
94
+ <identifier>2.0.0</identifier>
95
+ <min_compatible>2.0.0</min_compatible>
96
+ </version>
97
+ <filename>measure.rb</filename>
98
+ <filetype>rb</filetype>
99
+ <usage_type>script</usage_type>
100
+ <checksum>DA3FA7E2</checksum>
101
+ </file>
102
+ </files>
103
+ </measure>
@@ -1,126 +1,126 @@
1
- # *******************************************************************************
2
- # Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
3
- # Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
4
- #
5
- # Redistribution and use in source and binary forms, with or without
6
- # modification, are permitted provided that the following conditions are met:
7
- #
8
- # (1) Redistributions of source code must retain the above copyright notice,
9
- # this list of conditions and the following disclaimer.
10
- #
11
- # (2) Redistributions in binary form must reproduce the above copyright notice,
12
- # this list of conditions and the following disclaimer in the documentation
13
- # and/or other materials provided with the distribution.
14
- #
15
- # (3) Neither the name of the copyright holder nor the names of any contributors
16
- # may be used to endorse or promote products derived from this software without
17
- # specific prior written permission from the respective party.
18
- #
19
- # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
20
- # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21
- # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
- # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
23
- # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
24
- # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25
- # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26
- # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27
- # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28
- # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29
- # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
- # *******************************************************************************
31
-
32
- require 'openstudio'
33
- require 'openstudio/ruleset/ShowRunnerOutput'
34
- require 'minitest/autorun'
35
- require_relative '../measure.rb'
36
- require 'fileutils'
37
-
38
- class FromHoneybeeModel_Test < Minitest::Test
39
- # method to apply arguments, run measure, and assert results (only populate args hash with non-default argument values)
40
- def apply_measure_to_model(test_name, args, model_name = nil, result_value = 'Success', warnings_count = 0, info_count = nil)
41
- # create an instance of the measure
42
- measure = FromHoneybeeModel.new
43
-
44
- # create an instance of a runner
45
- runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
46
-
47
- if model_name.nil?
48
- # make an empty model
49
- model = OpenStudio::Model::Model.new
50
- else
51
- # load the test model
52
- translator = OpenStudio::OSVersion::VersionTranslator.new
53
- path = OpenStudio::Path.new(File.dirname(__FILE__) + '/' + model_name)
54
- model = translator.loadModel(path)
55
- assert(!model.empty?)
56
- model = model.get
57
- end
58
-
59
- # get arguments
60
- arguments = measure.arguments(model)
61
- argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
62
-
63
- # populate argument with specified hash value if specified
64
- arguments.each do |arg|
65
- temp_arg_var = arg.clone
66
- if args.key?(arg.name)
67
- assert(temp_arg_var.setValue(args[arg.name]), "could not set #{arg.name} to #{args[arg.name]}.")
68
- end
69
- argument_map[arg.name] = temp_arg_var
70
- end
71
-
72
- # run the measure
73
- measure.run(model, runner, argument_map)
74
- result = runner.result
75
-
76
- # show the output
77
- puts "measure results for #{test_name}"
78
- show_output(result)
79
-
80
- # assert that it ran correctly
81
- if result_value.nil? then result_value = 'Success' end
82
- assert_equal(result_value, result.value.valueName)
83
-
84
- # check count of warning and info messages
85
- unless info_count.nil? then assert(result.info.size == info_count) end
86
- unless warnings_count.nil? then assert(result.warnings.size == warnings_count, "warning count (#{result.warnings.size}) did not match expectation (#{warnings_count})") end
87
-
88
- # if 'Fail' passed in make sure at least one error message (while not typical there may be more than one message)
89
- if result_value == 'Fail' then assert(result.errors.size >= 1) end
90
-
91
- # save the model to test output directory
92
- output_file_path = OpenStudio::Path.new(File.dirname(__FILE__) + "/output/#{test_name}_test_output.osm")
93
- model.save(output_file_path, true)
94
- end
95
-
96
- def test_shoe_box
97
- args = {}
98
- args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_energy_shoe_box.json")
99
- apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
100
- end
101
-
102
- def test_multi_zone_office
103
- args = {}
104
- args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_multi_zone_office.json")
105
- apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
106
- end
107
-
108
- def test_single_zone_office
109
- args = {}
110
- args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_single_zone_office.json")
111
- apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
112
- end
113
-
114
- def test_detailed_loads
115
- args = {}
116
- args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_energy_detailed_loads.json")
117
- apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
118
- end
119
-
120
- def test_office_floor
121
- args = {}
122
- args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_office_floor.json")
123
- apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
124
- end
125
-
126
- end
1
+ # *******************************************************************************
2
+ # Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
3
+ # Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
4
+ #
5
+ # Redistribution and use in source and binary forms, with or without
6
+ # modification, are permitted provided that the following conditions are met:
7
+ #
8
+ # (1) Redistributions of source code must retain the above copyright notice,
9
+ # this list of conditions and the following disclaimer.
10
+ #
11
+ # (2) Redistributions in binary form must reproduce the above copyright notice,
12
+ # this list of conditions and the following disclaimer in the documentation
13
+ # and/or other materials provided with the distribution.
14
+ #
15
+ # (3) Neither the name of the copyright holder nor the names of any contributors
16
+ # may be used to endorse or promote products derived from this software without
17
+ # specific prior written permission from the respective party.
18
+ #
19
+ # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
20
+ # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21
+ # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
+ # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
23
+ # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
24
+ # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25
+ # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26
+ # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27
+ # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28
+ # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29
+ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+ # *******************************************************************************
31
+
32
+ require 'openstudio'
33
+ require 'openstudio/ruleset/ShowRunnerOutput'
34
+ require 'minitest/autorun'
35
+ require_relative '../measure.rb'
36
+ require 'fileutils'
37
+
38
+ class FromHoneybeeModel_Test < Minitest::Test
39
+ # method to apply arguments, run measure, and assert results (only populate args hash with non-default argument values)
40
+ def apply_measure_to_model(test_name, args, model_name = nil, result_value = 'Success', warnings_count = 0, info_count = nil)
41
+ # create an instance of the measure
42
+ measure = FromHoneybeeModel.new
43
+
44
+ # create an instance of a runner
45
+ runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
46
+
47
+ if model_name.nil?
48
+ # make an empty model
49
+ model = OpenStudio::Model::Model.new
50
+ else
51
+ # load the test model
52
+ translator = OpenStudio::OSVersion::VersionTranslator.new
53
+ path = OpenStudio::Path.new(File.dirname(__FILE__) + '/' + model_name)
54
+ model = translator.loadModel(path)
55
+ assert(!model.empty?)
56
+ model = model.get
57
+ end
58
+
59
+ # get arguments
60
+ arguments = measure.arguments(model)
61
+ argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
62
+
63
+ # populate argument with specified hash value if specified
64
+ arguments.each do |arg|
65
+ temp_arg_var = arg.clone
66
+ if args.key?(arg.name)
67
+ assert(temp_arg_var.setValue(args[arg.name]), "could not set #{arg.name} to #{args[arg.name]}.")
68
+ end
69
+ argument_map[arg.name] = temp_arg_var
70
+ end
71
+
72
+ # run the measure
73
+ measure.run(model, runner, argument_map)
74
+ result = runner.result
75
+
76
+ # show the output
77
+ puts "measure results for #{test_name}"
78
+ show_output(result)
79
+
80
+ # assert that it ran correctly
81
+ if result_value.nil? then result_value = 'Success' end
82
+ assert_equal(result_value, result.value.valueName)
83
+
84
+ # check count of warning and info messages
85
+ unless info_count.nil? then assert(result.info.size == info_count) end
86
+ unless warnings_count.nil? then assert(result.warnings.size == warnings_count, "warning count (#{result.warnings.size}) did not match expectation (#{warnings_count})") end
87
+
88
+ # if 'Fail' passed in make sure at least one error message (while not typical there may be more than one message)
89
+ if result_value == 'Fail' then assert(result.errors.size >= 1) end
90
+
91
+ # save the model to test output directory
92
+ output_file_path = OpenStudio::Path.new(File.dirname(__FILE__) + "/output/#{test_name}_test_output.osm")
93
+ model.save(output_file_path, true)
94
+ end
95
+
96
+ def test_shoe_box
97
+ args = {}
98
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_energy_shoe_box.json")
99
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
100
+ end
101
+
102
+ def test_multi_zone_office
103
+ args = {}
104
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_multi_zone_office.json")
105
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
106
+ end
107
+
108
+ def test_single_zone_office
109
+ args = {}
110
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_single_zone_office.json")
111
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
112
+ end
113
+
114
+ def test_detailed_loads
115
+ args = {}
116
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_energy_detailed_loads.json")
117
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
118
+ end
119
+
120
+ def test_office_floor
121
+ args = {}
122
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_office_floor.json")
123
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
124
+ end
125
+
126
+ end
@@ -1,23 +1,27 @@
1
- Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable Energy, LLC,
2
- Ladybug Tools LLC and other contributors. All rights reserved.
3
-
4
- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
5
- following conditions are met:
6
-
7
- (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
8
- disclaimer.
9
-
10
- (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
11
- disclaimer in the documentation and/or other materials provided with the distribution.
12
-
13
- (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products
14
- derived from this software without specific prior written permission from the respective party.
15
-
16
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
17
- INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
19
- STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20
- EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
21
- USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23
- ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1
+ OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC. All rights reserved.
2
+
3
+ Redistribution and use in source and binary forms, with or without modification, are permitted
4
+ provided that the following conditions are met:
5
+
6
+ (1) Redistributions of source code must retain the above copyright notice, this list of conditions
7
+ and the following disclaimer.
8
+
9
+ (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
10
+ and the following disclaimer in the documentation and/or other materials provided with the distribution.
11
+
12
+ (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse
13
+ or promote products derived from this software without specific prior written permission from the
14
+ respective party.
15
+
16
+ (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other
17
+ derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar
18
+ designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
21
+ WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT,
23
+ OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
25
+ OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -1,32 +1,32 @@
1
-
2
-
3
- ###### (Automatically generated documentation)
4
-
5
- # From Honeybee Simulation Parameter
6
-
7
- ## Description
8
- Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.
9
-
10
- ## Modeler Description
11
- Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.
12
-
13
- ## Measure Type
14
- ModelMeasure
15
-
16
- ## Taxonomy
17
-
18
-
19
- ## Arguments
20
-
21
-
22
- ### Path to the Honeybee SimulationParameter JSON file
23
-
24
- **Name:** simulation_parameter_json,
25
- **Type:** String,
26
- **Units:** ,
27
- **Required:** true,
28
- **Model Dependent:** false
29
-
30
-
31
-
32
-
1
+
2
+
3
+ ###### (Automatically generated documentation)
4
+
5
+ # From Honeybee Simulation Parameter
6
+
7
+ ## Description
8
+ Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.
9
+
10
+ ## Modeler Description
11
+ Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.
12
+
13
+ ## Measure Type
14
+ ModelMeasure
15
+
16
+ ## Taxonomy
17
+
18
+
19
+ ## Arguments
20
+
21
+
22
+ ### Path to the Honeybee SimulationParameter JSON file
23
+
24
+ **Name:** simulation_parameter_json,
25
+ **Type:** String,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+
31
+
32
+