honeybee-openstudio 0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yaml +88 -0
- data/.gitignore +33 -0
- data/.releaserc.json +7 -0
- data/Gemfile +14 -0
- data/LICENSE.md +23 -0
- data/README.md +95 -0
- data/Rakefile +16 -0
- data/doc_templates/LICENSE.md +23 -0
- data/doc_templates/README.md.erb +42 -0
- data/doc_templates/copyright_erb.txt +32 -0
- data/doc_templates/copyright_js.txt +5 -0
- data/doc_templates/copyright_ruby.txt +30 -0
- data/honeybee-openstudio.gemspec +38 -0
- data/lib/files/Honeybee.rb +113 -0
- data/lib/files/honeybee_workflow.osw +48 -0
- data/lib/files/urbanopt_Gemfile +32 -0
- data/lib/from_openstudio.rb +49 -0
- data/lib/from_openstudio/geometry/aperture.rb +136 -0
- data/lib/from_openstudio/geometry/door.rb +136 -0
- data/lib/from_openstudio/geometry/face.rb +174 -0
- data/lib/from_openstudio/geometry/room.rb +121 -0
- data/lib/from_openstudio/geometry/shade.rb +87 -0
- data/lib/from_openstudio/model.rb +123 -0
- data/lib/from_openstudio/model_object.rb +43 -0
- data/lib/from_openstudio/simulation/design_day.rb +123 -0
- data/lib/from_openstudio/simulation/parameter_model.rb +93 -0
- data/lib/from_openstudio/simulation/simulation_output.rb +67 -0
- data/lib/honeybee.rb +93 -0
- data/lib/honeybee/_defaults/energy_default.json +1682 -0
- data/lib/honeybee/_defaults/model.json +11311 -0
- data/lib/honeybee/_defaults/simulation-parameter.json +973 -0
- data/lib/honeybee/construction/air.rb +42 -0
- data/lib/honeybee/construction/opaque.rb +42 -0
- data/lib/honeybee/construction/shade.rb +42 -0
- data/lib/honeybee/construction/window.rb +51 -0
- data/lib/honeybee/construction/windowshade.rb +43 -0
- data/lib/honeybee/construction_set.rb +42 -0
- data/lib/honeybee/extension.rb +129 -0
- data/lib/honeybee/geometry/aperture.rb +42 -0
- data/lib/honeybee/geometry/door.rb +42 -0
- data/lib/honeybee/geometry/face.rb +48 -0
- data/lib/honeybee/geometry/room.rb +56 -0
- data/lib/honeybee/geometry/shade.rb +42 -0
- data/lib/honeybee/hvac/ideal_air.rb +42 -0
- data/lib/honeybee/hvac/template.rb +73 -0
- data/lib/honeybee/load/electric_equipment.rb +42 -0
- data/lib/honeybee/load/gas_equipment.rb +42 -0
- data/lib/honeybee/load/infiltration.rb +42 -0
- data/lib/honeybee/load/lighting.rb +43 -0
- data/lib/honeybee/load/people.rb +42 -0
- data/lib/honeybee/load/setpoint_humidistat.rb +46 -0
- data/lib/honeybee/load/setpoint_thermostat.rb +46 -0
- data/lib/honeybee/load/ventilation.rb +42 -0
- data/lib/honeybee/material/opaque.rb +42 -0
- data/lib/honeybee/material/opaque_no_mass.rb +42 -0
- data/lib/honeybee/material/window_blind.rb +42 -0
- data/lib/honeybee/material/window_gas.rb +42 -0
- data/lib/honeybee/material/window_gas_custom.rb +42 -0
- data/lib/honeybee/material/window_gas_mixture.rb +42 -0
- data/lib/honeybee/material/window_glazing.rb +42 -0
- data/lib/honeybee/material/window_shade.rb +42 -0
- data/lib/honeybee/material/window_simpleglazsys.rb +42 -0
- data/lib/honeybee/model.rb +87 -0
- data/lib/honeybee/model_object.rb +108 -0
- data/lib/honeybee/program_type.rb +56 -0
- data/lib/honeybee/schedule/fixed_interval.rb +42 -0
- data/lib/honeybee/schedule/ruleset.rb +42 -0
- data/lib/honeybee/schedule/type_limit.rb +42 -0
- data/lib/honeybee/simulation/design_day.rb +42 -0
- data/lib/honeybee/simulation/parameter_model.rb +86 -0
- data/lib/honeybee/simulation/simulation_output.rb +42 -0
- data/lib/honeybee/ventcool/control.rb +42 -0
- data/lib/honeybee/ventcool/opening.rb +46 -0
- data/lib/honeybee/ventcool/simulation.rb +42 -0
- data/lib/measures/.gitkeep +0 -0
- data/lib/measures/from_honeybee_model/LICENSE.md +23 -0
- data/lib/measures/from_honeybee_model/README.md +32 -0
- data/lib/measures/from_honeybee_model/measure.rb +91 -0
- data/lib/measures/from_honeybee_model/measure.xml +80 -0
- data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -0
- data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +23 -0
- data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -0
- data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -0
- data/lib/measures/from_honeybee_simulation_parameter/measure.xml +86 -0
- data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -0
- data/lib/to_openstudio.rb +92 -0
- data/lib/to_openstudio/construction/air.rb +56 -0
- data/lib/to_openstudio/construction/opaque.rb +67 -0
- data/lib/to_openstudio/construction/shade.rb +99 -0
- data/lib/to_openstudio/construction/window.rb +70 -0
- data/lib/to_openstudio/construction/windowshade.rb +196 -0
- data/lib/to_openstudio/construction_set.rb +266 -0
- data/lib/to_openstudio/geometry/aperture.rb +157 -0
- data/lib/to_openstudio/geometry/door.rb +150 -0
- data/lib/to_openstudio/geometry/face.rb +178 -0
- data/lib/to_openstudio/geometry/room.rb +442 -0
- data/lib/to_openstudio/geometry/shade.rb +79 -0
- data/lib/to_openstudio/hvac/Model.hvac.rb +641 -0
- data/lib/to_openstudio/hvac/ideal_air.rb +141 -0
- data/lib/to_openstudio/hvac/template.rb +169 -0
- data/lib/to_openstudio/load/electric_equipment.rb +87 -0
- data/lib/to_openstudio/load/gas_equipment.rb +88 -0
- data/lib/to_openstudio/load/infiltration.rb +86 -0
- data/lib/to_openstudio/load/lighting.rb +89 -0
- data/lib/to_openstudio/load/people.rb +91 -0
- data/lib/to_openstudio/load/setpoint_humidistat.rb +66 -0
- data/lib/to_openstudio/load/setpoint_thermostat.rb +62 -0
- data/lib/to_openstudio/load/ventilation.rb +87 -0
- data/lib/to_openstudio/material/opaque.rb +85 -0
- data/lib/to_openstudio/material/opaque_no_mass.rb +85 -0
- data/lib/to_openstudio/material/window_blind.rb +229 -0
- data/lib/to_openstudio/material/window_gas.rb +67 -0
- data/lib/to_openstudio/material/window_gas_custom.rb +108 -0
- data/lib/to_openstudio/material/window_gas_mixture.rb +70 -0
- data/lib/to_openstudio/material/window_glazing.rb +157 -0
- data/lib/to_openstudio/material/window_shade.rb +151 -0
- data/lib/to_openstudio/material/window_simpleglazsys.rb +64 -0
- data/lib/to_openstudio/model.rb +497 -0
- data/lib/to_openstudio/model_object.rb +52 -0
- data/lib/to_openstudio/program_type.rb +104 -0
- data/lib/to_openstudio/schedule/fixed_interval.rb +105 -0
- data/lib/to_openstudio/schedule/ruleset.rb +164 -0
- data/lib/to_openstudio/schedule/type_limit.rb +76 -0
- data/lib/to_openstudio/simulation/design_day.rb +96 -0
- data/lib/to_openstudio/simulation/parameter_model.rb +243 -0
- data/lib/to_openstudio/ventcool/control.rb +185 -0
- data/lib/to_openstudio/ventcool/opening.rb +189 -0
- data/lib/to_openstudio/ventcool/simulation.rb +101 -0
- metadata +301 -0
@@ -0,0 +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
|
@@ -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.
|
@@ -0,0 +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
|
+
|
@@ -0,0 +1,95 @@
|
|
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
|
+
|
37
|
+
# start the measure
|
38
|
+
class FromHoneybeeSimulationParameter < OpenStudio::Measure::ModelMeasure
|
39
|
+
# human readable name
|
40
|
+
def name
|
41
|
+
return 'From Honeybee Simulation Parameter'
|
42
|
+
end
|
43
|
+
|
44
|
+
# human readable description
|
45
|
+
def description
|
46
|
+
return 'Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.'
|
47
|
+
end
|
48
|
+
|
49
|
+
# human readable description of modeling approach
|
50
|
+
def modeler_description
|
51
|
+
return 'Add a JSON file of Honeybee Simulationtion Parameters to 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 ladybug json
|
59
|
+
simulation_parameter_json = OpenStudio::Measure::OSArgument.makeStringArgument('simulation_parameter_json', true)
|
60
|
+
simulation_parameter_json.setDisplayName('Path to the Honeybee SimulationParameter JSON file')
|
61
|
+
args << simulation_parameter_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
|
+
simulation_parameter_json = runner.getStringArgumentValue('simulation_parameter_json', user_arguments)
|
75
|
+
|
76
|
+
if !File.exist?(simulation_parameter_json)
|
77
|
+
runner.registerError("Cannot find file '#{simulation_parameter_json}'")
|
78
|
+
return false
|
79
|
+
end
|
80
|
+
|
81
|
+
sim_par_object = Honeybee::SimulationParameter.read_from_disk(simulation_parameter_json)
|
82
|
+
|
83
|
+
if !sim_par_object.valid?
|
84
|
+
# runner.registerError("File '#{simulation_parameter_json}' is not valid")
|
85
|
+
# return false
|
86
|
+
end
|
87
|
+
STDOUT.flush
|
88
|
+
sim_par_object.to_openstudio_model(model)
|
89
|
+
STDOUT.flush
|
90
|
+
return true
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
# register the measure to be used by the application
|
95
|
+
FromHoneybeeSimulationParameter.new.registerWithApplication
|
@@ -0,0 +1,86 @@
|
|
1
|
+
<?xml version="1.0"?>
|
2
|
+
<measure>
|
3
|
+
<schema_version>3.0</schema_version>
|
4
|
+
<name>from_honeybee_simulation_parameter</name>
|
5
|
+
<uid>a5f500d5-97ff-4048-a6f4-6b0b0a92d0f0</uid>
|
6
|
+
<version_id>2c88c158-3edc-4ac0-a816-6f5e094f2897</version_id>
|
7
|
+
<version_modified>20201124T031956Z</version_modified>
|
8
|
+
<xml_checksum>D8922A73</xml_checksum>
|
9
|
+
<class_name>FromHoneybeeSimulationParameter</class_name>
|
10
|
+
<display_name>From Honeybee Simulation Parameter</display_name>
|
11
|
+
<description>Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.</description>
|
12
|
+
<modeler_description>Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.</modeler_description>
|
13
|
+
<arguments>
|
14
|
+
<argument>
|
15
|
+
<name>simulation_parameter_json</name>
|
16
|
+
<display_name>Path to the Honeybee SimulationParameter 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>Measure Type</name>
|
35
|
+
<value>ModelMeasure</value>
|
36
|
+
<datatype>string</datatype>
|
37
|
+
</attribute>
|
38
|
+
<attribute>
|
39
|
+
<name>Intended Software Tool</name>
|
40
|
+
<value>Apply Measure Now</value>
|
41
|
+
<datatype>string</datatype>
|
42
|
+
</attribute>
|
43
|
+
<attribute>
|
44
|
+
<name>Intended Software Tool</name>
|
45
|
+
<value>OpenStudio Application</value>
|
46
|
+
<datatype>string</datatype>
|
47
|
+
</attribute>
|
48
|
+
<attribute>
|
49
|
+
<name>Intended Software Tool</name>
|
50
|
+
<value>Parametric Analysis Tool</value>
|
51
|
+
<datatype>string</datatype>
|
52
|
+
</attribute>
|
53
|
+
</attributes>
|
54
|
+
<files>
|
55
|
+
<file>
|
56
|
+
<filename>LICENSE.md</filename>
|
57
|
+
<filetype>md</filetype>
|
58
|
+
<usage_type>license</usage_type>
|
59
|
+
<checksum>1E0EDDB0</checksum>
|
60
|
+
</file>
|
61
|
+
<file>
|
62
|
+
<filename>README.md</filename>
|
63
|
+
<filetype>md</filetype>
|
64
|
+
<usage_type>readme</usage_type>
|
65
|
+
<checksum>481CF6D7</checksum>
|
66
|
+
</file>
|
67
|
+
<file>
|
68
|
+
<version>
|
69
|
+
<software_program>OpenStudio</software_program>
|
70
|
+
<identifier>2.0.0</identifier>
|
71
|
+
<min_compatible>2.0.0</min_compatible>
|
72
|
+
</version>
|
73
|
+
<filename>measure.rb</filename>
|
74
|
+
<filetype>rb</filetype>
|
75
|
+
<usage_type>script</usage_type>
|
76
|
+
<checksum>10CC1F28</checksum>
|
77
|
+
</file>
|
78
|
+
<file>
|
79
|
+
<filename>from_honeybee_simulation_parameter_test.rb</filename>
|
80
|
+
<filetype>rb</filetype>
|
81
|
+
<usage_type>test</usage_type>
|
82
|
+
<checksum>D75503B1</checksum>
|
83
|
+
</file>
|
84
|
+
</files>
|
85
|
+
</measure>
|
86
|
+
<error>cannot load such file -- honeybee/simulation/parameter</error>
|
@@ -0,0 +1,109 @@
|
|
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 FromHoneybeeSimulationParameter_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 = FromHoneybeeSimulationParameter.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_simulation_par_simple
|
97
|
+
args = {}
|
98
|
+
args['simulation_parameter_json'] = File.join(File.dirname(__FILE__) +
|
99
|
+
"/../../../../spec/samples/simulation_parameter/simulation_par_simple.json")
|
100
|
+
apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
|
101
|
+
end
|
102
|
+
|
103
|
+
def test_simulation_par_detailed
|
104
|
+
args = {}
|
105
|
+
args['simulation_parameter_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/simulation_parameter/simulation_par_detailed.json")
|
106
|
+
apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
|
107
|
+
end
|
108
|
+
|
109
|
+
end
|