honeybee-openstudio 2.34.9 → 2.35.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/honeybee-openstudio.gemspec +1 -1
  3. data/lib/from_openstudio/model.rb +12 -4
  4. data/lib/measures/from_honeybee_model/measure.rb +7 -1
  5. data/lib/measures/from_honeybee_model_to_sdd/LICENSE.md +23 -0
  6. data/lib/measures/from_honeybee_model_to_sdd/README.md +32 -0
  7. data/lib/measures/from_honeybee_model_to_sdd/measure.rb +115 -0
  8. data/lib/measures/from_honeybee_model_to_sdd/measure.xml +88 -0
  9. data/lib/measures/from_honeybee_model_to_sdd/tests/from_honeybee_model_to_sdd_test.rb +105 -0
  10. data/lib/measures/from_sdd_model/LICENSE.md +23 -0
  11. data/lib/measures/from_sdd_model/README.md +32 -0
  12. data/lib/measures/from_sdd_model/measure.rb +114 -0
  13. data/lib/measures/from_sdd_model/measure.xml +131 -0
  14. data/lib/measures/from_sdd_model/tests/from_sdd_model_test.rb +107 -0
  15. metadata +12 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c4d3ae6c224643694b834d77b34a79550d059ad0df9104d90509ae931a844337
4
- data.tar.gz: 1ed909608fb5019d1549d26b3200cf238304edf590f993a59c016941d6c1e6a6
3
+ metadata.gz: f2147c20b722a4999ef4621fc8df7bfdbd6e2048ebeb4bb5fb3b3e308fc1fbd5
4
+ data.tar.gz: f12ee5ebd489fc2d76e51d03b5d4b5eaf21fa0064b165f4e9cdfe5da46746ee8
5
5
  SHA512:
6
- metadata.gz: 4be5fafda6b741381169f7318d713dd34e74ddf22c7bc0c8d49bf4db8f2929e4136d1b861e6fc7eb29474d164e2e11d3157e1b820fc14c2f51e479278475fa71
7
- data.tar.gz: 5e347d2612b3a8fe6fce4a283ee1144759d09e9e7d355b9f36123c8f79dcf223a63d942b5137dafee1cd1cea872535a40a6878a5be307eb1eb370c0b09975fc5
6
+ metadata.gz: d8447c9153732de6310620300af6a13cde9062f06a83c6ef9e3b211054b2b80d8e4e0837a6a739044a265fb43a27a560b1299cbd57924faad26f04f66aa36981
7
+ data.tar.gz: 14323bdd6d2a4cf1f31ea92047ba097ee288dd2b90bc3e39aed0bf64180beab8af27b6143ad152f38301a7d634221e61063dd1875ff94e08274a5284f15b9122
data/honeybee-openstudio.gemspec CHANGED
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'honeybee-openstudio'
7
- spec.version = '2.34.9'
7
+ spec.version = '2.35.1'
8
8
  spec.authors = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
9
9
  spec.email = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
10
10
 
data/lib/from_openstudio/model.rb CHANGED
@@ -36,7 +36,7 @@ require 'openstudio'
36
36
  module Honeybee
37
37
  class Model
38
38
 
39
- # Create Ladybug Energy Model JSON from OpenStudio Model
39
+ # Create Honeybee Model JSON from OpenStudio Model
40
40
  def self.translate_from_openstudio(openstudio_model)
41
41
  hash = {}
42
42
  hash[:type] = 'Model'
@@ -79,7 +79,7 @@ module Honeybee
79
79
  Model.new(hash)
80
80
  end
81
81
 
82
- # Create Ladybug Energy Model JSON from OSM file
82
+ # Create Honeybee Model JSON from OSM file
83
83
  def self.translate_from_osm_file(file)
84
84
  vt = OpenStudio::OSVersion::VersionTranslator.new
85
85
  openstudio_model = vt.loadModel(file)
@@ -87,7 +87,7 @@ module Honeybee
87
87
  self.translate_from_openstudio(openstudio_model.get)
88
88
  end
89
89
 
90
- # Create Ladybug Energy Model JSON from gbXML file
90
+ # Create Honeybee Model JSON from gbXML file
91
91
  def self.translate_from_gbxml_file(file)
92
92
  translator = OpenStudio::GbXML::GbXMLReverseTranslator.new
93
93
  openstudio_model = translator.loadModel(file)
@@ -103,7 +103,7 @@ module Honeybee
103
103
  self.translate_from_openstudio(os_model)
104
104
  end
105
105
 
106
- # Create Ladybug Energy Model JSON from IDF file
106
+ # Create Honeybee Model JSON from IDF file
107
107
  def self.translate_from_idf_file(file)
108
108
  translator = OpenStudio::EnergyPlus::ReverseTranslator.new
109
109
  openstudio_model = translator.loadModel(file)
@@ -111,6 +111,14 @@ module Honeybee
111
111
  self.translate_from_openstudio(openstudio_model.get)
112
112
  end
113
113
 
114
+ # Create Honeybee Model JSON from SDD file
115
+ def self.translate_from_sdd_file(file)
116
+ translator = OpenStudio::SDD::SddReverseTranslator.new
117
+ openstudio_model = translator.loadModel(file)
118
+ raise "Cannot load SDD file at '#{}'" if openstudio_model.empty?
119
+ self.translate_from_openstudio(openstudio_model.get)
120
+ end
121
+
114
122
  def self.properties_from_model(openstudio_model)
115
123
  hash = {}
116
124
  hash[:type] = 'ModelProperties'
data/lib/measures/from_honeybee_model/measure.rb CHANGED
@@ -37,6 +37,7 @@ require 'to_openstudio'
37
37
  require 'fileutils'
38
38
  require 'pathname'
39
39
  require 'json'
40
+ require 'open3'
40
41
 
41
42
  # start the measure
42
43
  class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
@@ -133,7 +134,12 @@ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
133
134
  model.save(osm_path, true)
134
135
  # call the Ironbug console to add the HVAC to the OSM
135
136
  ironbug_exe = '"' + $ironbug_exe + '"'
136
- system(ironbug_exe + ' "' + osm_path + '" "' + hvac_json_path + '"')
137
+ ib_cmd = ironbug_exe + ' "' + osm_path + '" "' + hvac_json_path + '"'
138
+ stdout, stderr, status = Open3.capture3(ib_cmd)
139
+ if status.exitstatus != 0
140
+ runner.registerError('Failed to apply IronBug HVAC:' + stderr)
141
+ return false
142
+ end
137
143
  # load the new model
138
144
  translator = OpenStudio::OSVersion::VersionTranslator.new
139
145
  o_model = translator.loadModel(osm_path)
data/lib/measures/from_honeybee_model_to_sdd/LICENSE.md ADDED
@@ -0,0 +1,23 @@
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.
data/lib/measures/from_honeybee_model_to_sdd/README.md ADDED
@@ -0,0 +1,32 @@
1
+
2
+
3
+ ###### (Automatically generated documentation)
4
+
5
+ # From Honeybee Model To SDD
6
+
7
+ ## Description
8
+ Translate a JSON file of a Honeybee Model into a SDD Model.
9
+
10
+ ## Modeler Description
11
+ Translate a JSON file of a Honeybee Model into a SDD 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
+
data/lib/measures/from_honeybee_model_to_sdd/measure.rb ADDED
@@ -0,0 +1,115 @@
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 'to_openstudio'
36
+ require 'openstudio'
37
+
38
+ # start the measure
39
+ class FromHoneybeeModelToSDD < OpenStudio::Measure::ModelMeasure
40
+ # human readable name
41
+ def name
42
+ return 'From Honeybee Model to SDD'
43
+ end
44
+
45
+ # human readable description
46
+ def description
47
+ return 'Translate a JSON file of a Honeybee Model into a SDD Model.'
48
+ end
49
+
50
+ # human readable description of modeling approach
51
+ def modeler_description
52
+ return 'Translate a JSON file of a Honeybee Model into a SDD Model.'
53
+ end
54
+
55
+ # define the arguments that the user will input
56
+ def arguments(model)
57
+ args = OpenStudio::Measure::OSArgumentVector.new
58
+
59
+ # Make an argument for the honyebee model json
60
+ model_json = OpenStudio::Measure::OSArgument.makeStringArgument('model_json', true)
61
+ model_json.setDisplayName('Path to the Honeybee Model JSON file')
62
+ args << model_json
63
+
64
+ # Make an argument for the output file path
65
+ output_file_path = OpenStudio::Measure::OSArgument.makeStringArgument('output_file_path', false)
66
+ output_file_path.setDisplayName('Output file path')
67
+ output_file_path.setDescription('If set, the output SDD file will be exported to this path. Othervise The file will be exported to the same path as the input model.')
68
+ output_file_path.setDefaultValue('')
69
+ args << output_file_path
70
+
71
+ return args
72
+ end
73
+
74
+ # define what happens when the measure is run
75
+ def run(model, runner, user_arguments)
76
+ super(model, runner, user_arguments)
77
+ STDOUT.flush
78
+ if !runner.validateUserArguments(arguments(model), user_arguments)
79
+ return false
80
+ end
81
+
82
+ # convert the Honeybee model into an OpenStudio Model
83
+ model_json = runner.getStringArgumentValue('model_json', user_arguments)
84
+ if !File.exist?(model_json)
85
+ runner.registerError("Cannot find file '#{model_json}'")
86
+ return false
87
+ end
88
+ honeybee_model = Honeybee::Model.read_from_disk(model_json)
89
+ $simple_window_cons = true
90
+ $orphan_groups = false
91
+ STDOUT.flush
92
+ os_model = honeybee_model.to_openstudio_model(model)
93
+ STDOUT.flush
94
+
95
+ # convert the OpenStudio model into a SDD Model
96
+ output_file_path = runner.getStringArgumentValue('output_file_path', user_arguments)
97
+ if output_file_path && !output_file_path.empty?
98
+ unless File.exist?(output_file_path)
99
+ output_folder = File.split(output_file_path)[0]
100
+ FileUtils.mkdir_p(output_folder)
101
+ end
102
+ else
103
+ model_path, model_name = File.split(model_json)
104
+ sdd_model_name = model_name.split('.')[0] + '.sdd'
105
+ output_file_path = File.join(model_path, sdd_model_name)
106
+ end
107
+ translator = OpenStudio::SDD::SddForwardTranslator.new
108
+ translator.modelToSDD(os_model, output_file_path)
109
+
110
+ return true
111
+ end
112
+ end
113
+
114
+ # register the measure to be used by the application
115
+ FromHoneybeeModelToSDD.new.registerWithApplication
data/lib/measures/from_honeybee_model_to_sdd/measure.xml ADDED
@@ -0,0 +1,88 @@
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>FromHoneybeeModelToSDD</class_name>
10
+ <display_name>From Honeybee Model to SDD</display_name>
11
+ <description>Translate a JSON file of a Honeybee Model into a SDD Model.</description>
12
+ <modeler_description>Translate a JSON file of a Honeybee Model into a SDD 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
+ <argument>
22
+ <name>output_file_path</name>
23
+ <display_name>Output file path</display_name>
24
+ <type>String</type>
25
+ <required>false</required>
26
+ <model_dependent>false</model_dependent>
27
+ <default_value></default_value>
28
+ </argument>
29
+ </arguments>
30
+ <outputs />
31
+ <provenances />
32
+ <tags>
33
+ <tag>Whole Building.Space Types</tag>
34
+ </tags>
35
+ <attributes>
36
+ <attribute>
37
+ <name>Measure Type</name>
38
+ <value>ModelMeasure</value>
39
+ <datatype>string</datatype>
40
+ </attribute>
41
+ <attribute>
42
+ <name>Intended Software Tool</name>
43
+ <value>Apply Measure Now</value>
44
+ <datatype>string</datatype>
45
+ </attribute>
46
+ <attribute>
47
+ <name>Intended Software Tool</name>
48
+ <value>OpenStudio Application</value>
49
+ <datatype>string</datatype>
50
+ </attribute>
51
+ <attribute>
52
+ <name>Intended Software Tool</name>
53
+ <value>Parametric Analysis Tool</value>
54
+ <datatype>string</datatype>
55
+ </attribute>
56
+ </attributes>
57
+ <files>
58
+ <file>
59
+ <filename>LICENSE.md</filename>
60
+ <filetype>md</filetype>
61
+ <usage_type>license</usage_type>
62
+ <checksum>1E0EDDB0</checksum>
63
+ </file>
64
+ <file>
65
+ <filename>README.md</filename>
66
+ <filetype>md</filetype>
67
+ <usage_type>readme</usage_type>
68
+ <checksum>782C496D</checksum>
69
+ </file>
70
+ <file>
71
+ <version>
72
+ <software_program>OpenStudio</software_program>
73
+ <identifier>2.0.0</identifier>
74
+ <min_compatible>2.0.0</min_compatible>
75
+ </version>
76
+ <filename>measure.rb</filename>
77
+ <filetype>rb</filetype>
78
+ <usage_type>script</usage_type>
79
+ <checksum>8B48C43C</checksum>
80
+ </file>
81
+ <file>
82
+ <filename>from_honeybee_model_to_sdd_test.rb</filename>
83
+ <filetype>rb</filetype>
84
+ <usage_type>test</usage_type>
85
+ <checksum>A800695A</checksum>
86
+ </file>
87
+ </files>
88
+ </measure>
data/lib/measures/from_honeybee_model_to_sdd/tests/from_honeybee_model_to_sdd_test.rb ADDED
@@ -0,0 +1,105 @@
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 FromHoneybeeModelToSDD_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 = FromHoneybeeModelToSDD.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
+ end
92
+
93
+ def test_shoe_box
94
+ args = {}
95
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_energy_shoe_box.json")
96
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
97
+ end
98
+
99
+ def test_office_floor
100
+ args = {}
101
+ args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_office_floor.json")
102
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
103
+ end
104
+
105
+ end
data/lib/measures/from_sdd_model/LICENSE.md ADDED
@@ -0,0 +1,23 @@
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.
data/lib/measures/from_sdd_model/README.md ADDED
@@ -0,0 +1,32 @@
1
+
2
+
3
+ ###### (Automatically generated documentation)
4
+
5
+ # From SDD Model
6
+
7
+ ## Description
8
+ Translate a SDD model into a JSON file of a Honeybee Model.
9
+
10
+ ## Modeler Description
11
+ Translate a SDD model into a JSON file of a Honeybee Model.
12
+
13
+ ## Measure Type
14
+ ModelMeasure
15
+
16
+ ## Taxonomy
17
+
18
+
19
+ ## Arguments
20
+
21
+
22
+ ### Path to the SDD Model file
23
+
24
+ **Name:** sdd_model,
25
+ **Type:** String,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+
31
+
32
+
data/lib/measures/from_sdd_model/measure.rb ADDED
@@ -0,0 +1,114 @@
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_openstudio'
36
+
37
+ # start the measure
38
+ class FromSDDModel < OpenStudio::Measure::ModelMeasure
39
+ # human readable name
40
+ def name
41
+ return "From SDD Model"
42
+ end
43
+
44
+ # human readable description
45
+ def description
46
+ return "Translate a SDD into a JSON file of a Honeybee Model."
47
+ end
48
+
49
+ # human readable description of modeling approach
50
+ def modeler_description
51
+ return "Translate a SDD into a JSON file of a Honeybee 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 OpenStudio model
59
+ sdd_model = OpenStudio::Measure::OSArgument.makeStringArgument('sdd_model', true)
60
+ sdd_model.setDisplayName('Path to the SDD Model')
61
+ args << sdd_model
62
+
63
+ # Make an argument for the output file path
64
+ output_file_path = OpenStudio::Measure::OSArgument.makeStringArgument('output_file_path', false)
65
+ output_file_path.setDisplayName('Output file path')
66
+ output_file_path.setDescription('If set, the output Honeybee JSON file will be exported to this path. Othervise The file will be exported to the same path as the SDD model.')
67
+ output_file_path.setDefaultValue('')
68
+ args << output_file_path
69
+
70
+ return args
71
+ end
72
+
73
+ # define what happens when the measure is run
74
+ def run(model, runner, user_arguments)
75
+ super(model, runner, user_arguments)
76
+ STDOUT.flush
77
+ if !runner.validateUserArguments(arguments(model), user_arguments)
78
+ return false
79
+ end
80
+
81
+ sdd_model = runner.getStringArgumentValue('sdd_model', user_arguments)
82
+
83
+ sdd_model_path, sdd_model_name = File.split(sdd_model)
84
+ honeybee_model_name = sdd_model_name.split('.')[0] + '.hbjson'
85
+
86
+ if !File.exist?(sdd_model)
87
+ runner.registerError("Cannot find file '#{sdd_model}'")
88
+ return false
89
+ end
90
+
91
+ honeybee_model = Honeybee::Model.translate_from_sdd_file(sdd_model)
92
+ honeybee_hash = honeybee_model.hash
93
+
94
+ output_file_path = runner.getStringArgumentValue('output_file_path', user_arguments)
95
+
96
+ if output_file_path && !output_file_path.empty?
97
+ unless File.exist?(output_file_path)
98
+ output_folder = File.split(output_file_path)[0]
99
+ FileUtils.mkdir_p(output_folder)
100
+ end
101
+ else
102
+ output_file_path = File.join(sdd_model_path, honeybee_model_name)
103
+ end
104
+
105
+ File.open(output_file_path, 'w') do |f|
106
+ f.puts JSON::pretty_generate(honeybee_hash)
107
+ end
108
+
109
+ return true
110
+ end
111
+ end
112
+
113
+ # register the measure to be used by the application
114
+ FromSDDModel.new.registerWithApplication
data/lib/measures/from_sdd_model/measure.xml ADDED
@@ -0,0 +1,131 @@
1
+ <?xml version="1.0"?>
2
+ <measure>
3
+ <schema_version>3.0</schema_version>
4
+ <name>from_sdd_model</name>
5
+ <uid>e4b3a388-3468-4962-a12e-e2e02bacb0a2</uid>
6
+ <version_id>0261fa70-1322-43ce-ae24-e6e65eb98f03</version_id>
7
+ <version_modified>20210428T160059Z</version_modified>
8
+ <xml_checksum>6BA95EF6</xml_checksum>
9
+ <class_name>FromSDDModel</class_name>
10
+ <display_name>From SDD Model</display_name>
11
+ <description>Translate a SDD into a JSON file of a Honeybee Model.</description>
12
+ <modeler_description>Translate a SDD into a JSON file of a Honeybee 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
+ <description></description>
18
+ <type>String</type>
19
+ <units></units>
20
+ <required>true</required>
21
+ <model_dependent>false</model_dependent>
22
+ <default_value></default_value>
23
+ <min_value></min_value>
24
+ <max_value></max_value>
25
+ </argument>
26
+ </arguments>
27
+ <outputs />
28
+ <provenances />
29
+ <tags>
30
+ <tag>Whole Building.Space Types</tag>
31
+ </tags>
32
+ <attributes>
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
+ <attribute>
49
+ <name>Intended Software Tool</name>
50
+ <value>Apply Measure Now</value>
51
+ <datatype>string</datatype>
52
+ </attribute>
53
+ <attribute>
54
+ <name>Intended Software Tool</name>
55
+ <value>OpenStudio Application</value>
56
+ <datatype>string</datatype>
57
+ </attribute>
58
+ <attribute>
59
+ <name>Intended Software Tool</name>
60
+ <value>Parametric Analysis Tool</value>
61
+ <datatype>string</datatype>
62
+ </attribute>
63
+ <attribute>
64
+ <name>Intended Software Tool</name>
65
+ <value>Apply Measure Now</value>
66
+ <datatype>string</datatype>
67
+ </attribute>
68
+ <attribute>
69
+ <name>Intended Software Tool</name>
70
+ <value>OpenStudio Application</value>
71
+ <datatype>string</datatype>
72
+ </attribute>
73
+ <attribute>
74
+ <name>Intended Software Tool</name>
75
+ <value>Parametric Analysis Tool</value>
76
+ <datatype>string</datatype>
77
+ </attribute>
78
+ <attribute>
79
+ <name>Measure Type</name>
80
+ <value>ModelMeasure</value>
81
+ <datatype>string</datatype>
82
+ </attribute>
83
+ <attribute>
84
+ <name>Intended Software Tool</name>
85
+ <value>Apply Measure Now</value>
86
+ <datatype>string</datatype>
87
+ </attribute>
88
+ <attribute>
89
+ <name>Intended Software Tool</name>
90
+ <value>OpenStudio Application</value>
91
+ <datatype>string</datatype>
92
+ </attribute>
93
+ <attribute>
94
+ <name>Intended Software Tool</name>
95
+ <value>Parametric Analysis Tool</value>
96
+ <datatype>string</datatype>
97
+ </attribute>
98
+ </attributes>
99
+ <files>
100
+ <file>
101
+ <filename>LICENSE.md</filename>
102
+ <filetype>md</filetype>
103
+ <usage_type>license</usage_type>
104
+ <checksum>1E0EDDB0</checksum>
105
+ </file>
106
+ <file>
107
+ <filename>README.md</filename>
108
+ <filetype>md</filetype>
109
+ <usage_type>readme</usage_type>
110
+ <checksum>782C496D</checksum>
111
+ </file>
112
+ <file>
113
+ <version>
114
+ <software_program>OpenStudio</software_program>
115
+ <identifier>2.0.0</identifier>
116
+ <min_compatible>2.0.0</min_compatible>
117
+ </version>
118
+ <filename>measure.rb</filename>
119
+ <filetype>rb</filetype>
120
+ <usage_type>script</usage_type>
121
+ <checksum>D5D8CB66</checksum>
122
+ </file>
123
+ <file>
124
+ <filename>from_sdd_model_test.rb</filename>
125
+ <filetype>rb</filetype>
126
+ <usage_type>test</usage_type>
127
+ <checksum>AE86B654</checksum>
128
+ </file>
129
+ </files>
130
+ </measure>
131
+ <error>cannot load such file -- from_openstudio</error>
data/lib/measures/from_sdd_model/tests/from_sdd_model_test.rb ADDED
@@ -0,0 +1,107 @@
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 FromSDDModel_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 = FromSDDModel.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
+ puts "this is measure #{measure.run(model, runner, argument_map)}"
77
+ # show the output
78
+ puts "measure results for #{test_name}"
79
+ show_output(result)
80
+
81
+ # assert that it ran correctly
82
+ if result_value.nil? then result_value = 'Success' end
83
+ assert_equal(result_value, result.value.valueName)
84
+
85
+ # check count of warning and info messages
86
+ unless info_count.nil? then assert(result.info.size == info_count) end
87
+ unless warnings_count.nil? then assert(result.warnings.size == warnings_count, "warning count (#{result.warnings.size}) did not match expectation (#{warnings_count})") end
88
+
89
+ # if 'Fail' passed in make sure at least one error message (while not typical there may be more than one message)
90
+ if result_value == 'Fail' then assert(result.errors.size >= 1) end
91
+
92
+ end
93
+
94
+ def test_example_model_with_output_path
95
+ args = {}
96
+ args['sdd_model'] = File.join(File.dirname(__FILE__) + '/../../../../spec/samples/sdd/sdd_TRK.xml')
97
+ args['output_file_path'] = File.join(File.dirname(__FILE__) + '/output/sdd_TRK.hbjson')
98
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
99
+ end
100
+
101
+ def test_example_model_without_output_path
102
+ args = {}
103
+ args['sdd_model'] = File.join(File.dirname(__FILE__) + '/../../../../spec/samples/sdd/sdd_TRK.xml')
104
+ apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
105
+ end
106
+
107
+ end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: honeybee-openstudio
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.34.9
4
+ version: 2.35.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
11
11
  autorequire:
12
12
  bindir: exe
13
13
  cert_chain: []
14
- date: 2023-08-02 00:00:00.000000000 Z
14
+ date: 2023-09-19 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: json_pure
@@ -191,6 +191,11 @@ files:
191
191
  - lib/measures/from_honeybee_model_to_gbxml/measure.rb
192
192
  - lib/measures/from_honeybee_model_to_gbxml/measure.xml
193
193
  - lib/measures/from_honeybee_model_to_gbxml/tests/from_honeybee_model_to_gbxml_test.rb
194
+ - lib/measures/from_honeybee_model_to_sdd/LICENSE.md
195
+ - lib/measures/from_honeybee_model_to_sdd/README.md
196
+ - lib/measures/from_honeybee_model_to_sdd/measure.rb
197
+ - lib/measures/from_honeybee_model_to_sdd/measure.xml
198
+ - lib/measures/from_honeybee_model_to_sdd/tests/from_honeybee_model_to_sdd_test.rb
194
199
  - lib/measures/from_honeybee_simulation_parameter/LICENSE.md
195
200
  - lib/measures/from_honeybee_simulation_parameter/README.md
196
201
  - lib/measures/from_honeybee_simulation_parameter/measure.rb
@@ -206,6 +211,11 @@ files:
206
211
  - lib/measures/from_openstudio_model/measure.rb
207
212
  - lib/measures/from_openstudio_model/measure.xml
208
213
  - lib/measures/from_openstudio_model/tests/from_openstudio_model_test.rb
214
+ - lib/measures/from_sdd_model/LICENSE.md
215
+ - lib/measures/from_sdd_model/README.md
216
+ - lib/measures/from_sdd_model/measure.rb
217
+ - lib/measures/from_sdd_model/measure.xml
218
+ - lib/measures/from_sdd_model/tests/from_sdd_model_test.rb
209
219
  - lib/to_openstudio.rb
210
220
  - lib/to_openstudio/construction/air.rb
211
221
  - lib/to_openstudio/construction/dynamic.rb