honeybee-openstudio 1.8.1 → 1.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -1
  3. data/.gitignore +32 -32
  4. data/.releaserc.json +7 -7
  5. data/.travis.yml +42 -41
  6. data/Gemfile +18 -18
  7. data/LICENSE.md +23 -23
  8. data/README.md +95 -95
  9. data/Rakefile +20 -20
  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 -35
  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/from_honeybee.rb +86 -86
  19. data/lib/from_honeybee/_openapi/model.json +8126 -8126
  20. data/lib/from_honeybee/_openapi/simulation-parameter.json +842 -842
  21. data/lib/from_honeybee/construction/air.rb +64 -64
  22. data/lib/from_honeybee/construction/opaque.rb +76 -76
  23. data/lib/from_honeybee/construction/shade.rb +107 -107
  24. data/lib/from_honeybee/construction/window.rb +80 -80
  25. data/lib/from_honeybee/construction_set.rb +278 -278
  26. data/lib/from_honeybee/extension.rb +109 -109
  27. data/lib/from_honeybee/geometry/aperture.rb +167 -167
  28. data/lib/from_honeybee/geometry/door.rb +160 -160
  29. data/lib/from_honeybee/geometry/face.rb +163 -163
  30. data/lib/from_honeybee/geometry/room.rb +392 -392
  31. data/lib/from_honeybee/geometry/shade.rb +89 -89
  32. data/lib/from_honeybee/hvac/ideal_air.rb +150 -150
  33. data/lib/from_honeybee/load/electric_equipment.rb +95 -95
  34. data/lib/from_honeybee/load/gas_equipment.rb +97 -97
  35. data/lib/from_honeybee/load/infiltration.rb +94 -94
  36. data/lib/from_honeybee/load/lighting.rb +98 -98
  37. data/lib/from_honeybee/load/people.rb +99 -99
  38. data/lib/from_honeybee/load/setpoint_humidistat.rb +74 -74
  39. data/lib/from_honeybee/load/setpoint_thermostat.rb +71 -71
  40. data/lib/from_honeybee/load/ventilation.rb +95 -95
  41. data/lib/from_honeybee/material/opaque.rb +94 -94
  42. data/lib/from_honeybee/material/opaque_no_mass.rb +94 -94
  43. data/lib/from_honeybee/material/window_blind.rb +238 -238
  44. data/lib/from_honeybee/material/window_gas.rb +76 -76
  45. data/lib/from_honeybee/material/window_gas_custom.rb +118 -118
  46. data/lib/from_honeybee/material/window_gas_mixture.rb +79 -79
  47. data/lib/from_honeybee/material/window_glazing.rb +166 -166
  48. data/lib/from_honeybee/material/window_shade.rb +160 -160
  49. data/lib/from_honeybee/material/window_simpleglazsys.rb +73 -73
  50. data/lib/from_honeybee/model.rb +434 -434
  51. data/lib/from_honeybee/model_object.rb +110 -110
  52. data/lib/from_honeybee/program_type.rb +124 -124
  53. data/lib/from_honeybee/schedule/fixed_interval.rb +115 -115
  54. data/lib/from_honeybee/schedule/ruleset.rb +164 -164
  55. data/lib/from_honeybee/schedule/type_limit.rb +88 -88
  56. data/lib/from_honeybee/simulation/designday.rb +105 -105
  57. data/lib/from_honeybee/simulation/extension.rb +46 -46
  58. data/lib/from_honeybee/simulation/parameter.rb +277 -277
  59. data/lib/from_honeybee/version.rb +34 -34
  60. data/lib/measures/from_honeybee_model/LICENSE.md +26 -26
  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 -103
  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 +26 -26
  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 -91
  69. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
  70. metadata +2 -2
@@ -1,34 +1,34 @@
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
- module FromHoneybee
33
- VERSION = '0.1.0'.freeze
34
- 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
+ module FromHoneybee
33
+ VERSION = '1.8.2'.freeze
34
+ end
@@ -1,27 +1,27 @@
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
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
27
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -1,32 +1,32 @@
1
-
2
-
3
- ###### (Automatically generated documentation)
4
-
5
- # From Energy Model
6
-
7
- ## Description
8
- Translate a JSON file of a Honeybee Model into an OpenStudio Model.
9
-
10
- ## Modeler Description
11
- Translate a JSON file of a Honeybee Model into an OpenStudio Model.
12
-
13
- ## Measure Type
14
- ModelMeasure
15
-
16
- ## Taxonomy
17
-
18
-
19
- ## Arguments
20
-
21
-
22
- ### Path to the Honeybee Model JSON file
23
-
24
- **Name:** model_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 Energy Model
6
+
7
+ ## Description
8
+ Translate a JSON file of a Honeybee Model into an OpenStudio Model.
9
+
10
+ ## Modeler Description
11
+ Translate a JSON file of a Honeybee Model into an OpenStudio Model.
12
+
13
+ ## Measure Type
14
+ ModelMeasure
15
+
16
+ ## Taxonomy
17
+
18
+
19
+ ## Arguments
20
+
21
+
22
+ ### Path to the Honeybee Model JSON file
23
+
24
+ **Name:** model_json,
25
+ **Type:** String,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+
31
+
32
+
@@ -1,91 +1,91 @@
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
- # see the URL below for information on how to write OpenStudio measures
33
- # http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
34
-
35
- require 'from_honeybee/model'
36
-
37
- # start the measure
38
- class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
39
- # human readable name
40
- def name
41
- return 'From Honeybee Model'
42
- end
43
-
44
- # human readable description
45
- def description
46
- return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
47
- end
48
-
49
- # human readable description of modeling approach
50
- def modeler_description
51
- return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
52
- end
53
-
54
- # define the arguments that the user will input
55
- def arguments(model)
56
- args = OpenStudio::Measure::OSArgumentVector.new
57
-
58
- # Make an argument for the honyebee model json
59
- model_json = OpenStudio::Measure::OSArgument.makeStringArgument('model_json', true)
60
- model_json.setDisplayName('Path to the Honeybee Model JSON file')
61
- args << model_json
62
-
63
- return args
64
- end
65
-
66
- # define what happens when the measure is run
67
- def run(model, runner, user_arguments)
68
- super(model, runner, user_arguments)
69
- STDOUT.flush
70
- if !runner.validateUserArguments(arguments(model), user_arguments)
71
- return false
72
- end
73
-
74
- model_json = runner.getStringArgumentValue('model_json', user_arguments)
75
-
76
- if !File.exist?(model_json)
77
- runner.registerError("Cannot find file '#{model_json}'")
78
- return false
79
- end
80
-
81
- honeybee_model = FromHoneybee::Model.read_from_disk(model_json)
82
-
83
- STDOUT.flush
84
- honeybee_model.to_openstudio_model(model)
85
- STDOUT.flush
86
- return true
87
- end
88
- end
89
-
90
- # register the measure to be used by the application
91
- FromHoneybeeModel.new.registerWithApplication
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
+ # see the URL below for information on how to write OpenStudio measures
33
+ # http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
34
+
35
+ require 'from_honeybee/model'
36
+
37
+ # start the measure
38
+ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
39
+ # human readable name
40
+ def name
41
+ return 'From Honeybee Model'
42
+ end
43
+
44
+ # human readable description
45
+ def description
46
+ return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
47
+ end
48
+
49
+ # human readable description of modeling approach
50
+ def modeler_description
51
+ return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
52
+ end
53
+
54
+ # define the arguments that the user will input
55
+ def arguments(model)
56
+ args = OpenStudio::Measure::OSArgumentVector.new
57
+
58
+ # Make an argument for the honyebee model json
59
+ model_json = OpenStudio::Measure::OSArgument.makeStringArgument('model_json', true)
60
+ model_json.setDisplayName('Path to the Honeybee Model JSON file')
61
+ args << model_json
62
+
63
+ return args
64
+ end
65
+
66
+ # define what happens when the measure is run
67
+ def run(model, runner, user_arguments)
68
+ super(model, runner, user_arguments)
69
+ STDOUT.flush
70
+ if !runner.validateUserArguments(arguments(model), user_arguments)
71
+ return false
72
+ end
73
+
74
+ model_json = runner.getStringArgumentValue('model_json', user_arguments)
75
+
76
+ if !File.exist?(model_json)
77
+ runner.registerError("Cannot find file '#{model_json}'")
78
+ return false
79
+ end
80
+
81
+ honeybee_model = FromHoneybee::Model.read_from_disk(model_json)
82
+
83
+ STDOUT.flush
84
+ honeybee_model.to_openstudio_model(model)
85
+ STDOUT.flush
86
+ return true
87
+ end
88
+ end
89
+
90
+ # register the measure to be used by the application
91
+ FromHoneybeeModel.new.registerWithApplication
@@ -1,103 +1,103 @@
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
+ <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>