honeybee-openstudio 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +7 -0
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +32 -0
  4. data/.releaserc.json +7 -0
  5. data/.travis.yml +41 -0
  6. data/Gemfile +18 -0
  7. data/LICENSE.md +23 -0
  8. data/README.md +95 -0
  9. data/Rakefile +21 -0
  10. data/doc_templates/LICENSE.md +23 -0
  11. data/doc_templates/copyright_erb.txt +32 -0
  12. data/doc_templates/copyright_js.txt +5 -0
  13. data/doc_templates/copyright_ruby.txt +30 -0
  14. data/honeybee-openstudio.gemspec +35 -0
  15. data/lib/files/Honeybee.rb +113 -0
  16. data/lib/files/honeybee_workflow.osw +48 -0
  17. data/lib/files/urbanopt_Gemfile +32 -0
  18. data/lib/from_honeybee.rb +86 -0
  19. data/lib/from_honeybee/_openapi/model.json +8127 -0
  20. data/lib/from_honeybee/_openapi/simulation-parameter.json +843 -0
  21. data/lib/from_honeybee/construction/air.rb +65 -0
  22. data/lib/from_honeybee/construction/opaque.rb +77 -0
  23. data/lib/from_honeybee/construction/shade.rb +108 -0
  24. data/lib/from_honeybee/construction/window.rb +80 -0
  25. data/lib/from_honeybee/construction_set.rb +278 -0
  26. data/lib/from_honeybee/extension.rb +109 -0
  27. data/lib/from_honeybee/geometry/aperture.rb +167 -0
  28. data/lib/from_honeybee/geometry/door.rb +160 -0
  29. data/lib/from_honeybee/geometry/face.rb +163 -0
  30. data/lib/from_honeybee/geometry/room.rb +392 -0
  31. data/lib/from_honeybee/geometry/shade.rb +89 -0
  32. data/lib/from_honeybee/hvac/ideal_air.rb +150 -0
  33. data/lib/from_honeybee/load/electric_equipment.rb +96 -0
  34. data/lib/from_honeybee/load/gas_equipment.rb +97 -0
  35. data/lib/from_honeybee/load/infiltration.rb +95 -0
  36. data/lib/from_honeybee/load/lighting.rb +98 -0
  37. data/lib/from_honeybee/load/people.rb +100 -0
  38. data/lib/from_honeybee/load/setpoint_humidistat.rb +75 -0
  39. data/lib/from_honeybee/load/setpoint_thermostat.rb +71 -0
  40. data/lib/from_honeybee/load/ventilation.rb +96 -0
  41. data/lib/from_honeybee/material/opaque.rb +94 -0
  42. data/lib/from_honeybee/material/opaque_no_mass.rb +94 -0
  43. data/lib/from_honeybee/material/window_blind.rb +238 -0
  44. data/lib/from_honeybee/material/window_gas.rb +76 -0
  45. data/lib/from_honeybee/material/window_gas_custom.rb +118 -0
  46. data/lib/from_honeybee/material/window_gas_mixture.rb +79 -0
  47. data/lib/from_honeybee/material/window_glazing.rb +166 -0
  48. data/lib/from_honeybee/material/window_shade.rb +160 -0
  49. data/lib/from_honeybee/material/window_simpleglazsys.rb +73 -0
  50. data/lib/from_honeybee/model.rb +434 -0
  51. data/lib/from_honeybee/model_object.rb +110 -0
  52. data/lib/from_honeybee/program_type.rb +124 -0
  53. data/lib/from_honeybee/schedule/fixed_interval.rb +115 -0
  54. data/lib/from_honeybee/schedule/ruleset.rb +164 -0
  55. data/lib/from_honeybee/schedule/type_limit.rb +88 -0
  56. data/lib/from_honeybee/simulation/designday.rb +105 -0
  57. data/lib/from_honeybee/simulation/extension.rb +46 -0
  58. data/lib/from_honeybee/simulation/parameter.rb +277 -0
  59. data/lib/from_honeybee/version.rb +34 -0
  60. data/lib/measures/.gitkeep +0 -0
  61. data/lib/measures/from_honeybee_model/LICENSE.md +27 -0
  62. data/lib/measures/from_honeybee_model/README.md +32 -0
  63. data/lib/measures/from_honeybee_model/measure.rb +91 -0
  64. data/lib/measures/from_honeybee_model/measure.xml +103 -0
  65. data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -0
  66. data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +27 -0
  67. data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -0
  68. data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -0
  69. data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -0
  70. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -0
  71. metadata +243 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a869918b67dca52d683ba3d0b2b88d63018abc41
4
+ data.tar.gz: 9c2816bfe47c3fdb46c6187f3d34dbcb8bdfc494
5
+ SHA512:
6
+ metadata.gz: 006bfdc2d1e0827e9b9d61d598c721275869af05efdd2ebe4c38e05527718540fa902a475cb46108238d253551faa0432648b94946b89e2cd350fad0a728b110
7
+ data.tar.gz: f5e9980234d83bd0d0038b176524e7a3e6dfccc3ec1370ff21121d9fb48dff447ffcb02ea92f7440f16176da03bff1c43b0dbf8abea9a8ad26cea1bd69d89325
@@ -0,0 +1 @@
1
+ service_name: travis-ci
@@ -0,0 +1,32 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /.ruby-version
4
+ /Gemfile.lock
5
+ /gems
6
+ /_yardoc/
7
+ /coverage/
8
+ /doc/
9
+ /pkg/
10
+ /spec/reports/
11
+ /spec/test/
12
+ /tmp/
13
+ /test/
14
+ /lib/measures/test_results
15
+ /lib/measures/.rubocop*
16
+ /.vscode
17
+ /.vs
18
+
19
+ # rspec failure tracking
20
+ .rspec_status
21
+ .rakeTasks
22
+
23
+ # Ignore IDE files
24
+ /.idea
25
+ *.rubocop-http*
26
+
27
+ # measures tests
28
+ lib/measures/.rubocop.yml
29
+ lib/measures/test_results/*
30
+ lib/measures/*/tests/output
31
+
32
+ out.txt
@@ -0,0 +1,7 @@
1
+ {
2
+ "plugins": [
3
+ "@semantic-release/commit-analyzer",
4
+ "@semantic-release/release-notes-generator",
5
+ "@semantic-release/github"
6
+ ]
7
+ }
@@ -0,0 +1,41 @@
1
+ language: ruby
2
+
3
+ rvm:
4
+ - 2.2
5
+
6
+ before_install:
7
+ # install openstudio
8
+ - wget http://security.ubuntu.com/ubuntu/pool/universe/w/wxwidgets3.0/libwxbase3.0-0_3.0.0-2_amd64.deb
9
+ - sudo apt install ./libwxbase3.0-0_3.0.0-2_amd64.deb
10
+ - wget http://security.ubuntu.com/ubuntu/pool/universe/w/wxwidgets3.0/libwxgtk3.0-0_3.0.0-2_amd64.deb
11
+ - sudo apt install ./libwxgtk3.0-0_3.0.0-2_amd64.deb
12
+ - wget https://github.com/NREL/OpenStudio/releases/download/v2.9.1/OpenStudio-2.9.1.3472e8b799-Linux.deb
13
+ - sudo dpkg -i ./OpenStudio-2.9.1.3472e8b799-Linux.deb
14
+ # install the openstudio extension gem
15
+ - export RUBYLIB=/usr/local/openstudio-2.9.1/Ruby
16
+ - gem install openstudio-extension -v 0.1.6
17
+
18
+ install:
19
+ - bundle install
20
+
21
+ jobs:
22
+ include:
23
+ - stage: test
24
+ script:
25
+ - rake
26
+ - stage: deploy
27
+ if: branch = master AND (NOT type IN (pull_request))
28
+ before_install:
29
+ - nvm install lts/* --latest-npm
30
+ install:
31
+ - npm install @semantic-release/exec
32
+ script:
33
+ - git config --global user.email "releases@ladybug.tools"
34
+ - git config --global user.name "ladybugbot"
35
+ - npx semantic-release
36
+ - stage: docs
37
+ if: branch = master AND (NOT type IN (pull_request))
38
+ deploy:
39
+ provider: rubygems
40
+ skip_cleanup: true
41
+ api_key: $API_KEY
data/Gemfile ADDED
@@ -0,0 +1,18 @@
1
+ source 'http://rubygems.org'
2
+
3
+ # Specify your gem's dependencies
4
+ gemspec
5
+
6
+ # get the openstudio-extension gem
7
+ if File.exist?('../OpenStudio-extension-gem') # local development copy
8
+ gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
9
+ else # get it from rubygems.org
10
+ gem 'openstudio-extension', '0.1.6'
11
+ end
12
+
13
+ # coveralls gem is used to generate coverage reports through CI
14
+ gem 'coveralls', require: false
15
+
16
+ # uncomment the following to run tests locally using `bundle exec rake`.
17
+ # simplecov has an unneccesary dependency on native json gem, use fork that does not require this
18
+ #gem 'simplecov', github: 'NREL/simplecov'
@@ -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,95 @@
1
+ [![Build Status](https://travis-ci.org/ladybug-tools/honeybee-openstudio-gem.svg?branch=master)](https://travis-ci.org/ladybug-tools/honeybee-openstudio-gem)
2
+ [![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-openstudio-gem/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-openstudio-gem)
3
+
4
+ ![Ruby 2.2](https://img.shields.io/badge/ruby-2.2-blue.svg)
5
+
6
+ # honeybee-openstudio-gem
7
+
8
+ Library and measures for translating between Honeybee JSON schema and OpenStudio Model schema (OSM).
9
+
10
+
11
+ ## Run the measures of this repo using OpenStudio CLI
12
+
13
+ Running the measures using OpenStudio CLI requires no installation other than cloning
14
+ this repo and installing OpenStudio.
15
+
16
+ 1. Write an OpenStudio Workflow (osw) JSON that passes honeybee model and simulation
17
+ parameter JSON files to the measures. Here is a sample where the items in parentheses
18
+ should be replaced with specific file paths:
19
+
20
+ ```
21
+ {
22
+ "measure_paths": [(PATH TO THIS REPOSITORY)/lib/measures"],
23
+ "steps": [
24
+ {
25
+ "arguments": {"model_json": (PATH TO MODEL JSON)},
26
+ "measure_dir_name": "from_honeybee_model"
27
+ },
28
+ {
29
+ "arguments": {"simulation_parameter_json": (PATH TO SIMULATION PARAMETER JSON)},
30
+ "measure_dir_name": "from_honeybee_simulation_parameter"
31
+ }
32
+ ]
33
+ }
34
+ ```
35
+
36
+ 2. Call the OpenStudio CLI from command line, making sure to pass this repository's
37
+ lib folder to the CLI using the `-I` (or `--include`) option. Here is a sample
38
+ where the items in parentheses should be replaced with specific file paths:
39
+
40
+ ```
41
+ "(OPENSTUDIO INSTALLATION PATH)/bin/openstudio.exe" -I (PATH TO THIS REPOSITORY)/lib run -m -w (PATH TO OSW FILE)
42
+
43
+ ```
44
+
45
+
46
+ ## Local Development
47
+ 1. Clone this repo locally
48
+ ```
49
+ git clone git@github.com:ladybug-tools/honeybee-openstudio-gem
50
+
51
+ # or
52
+
53
+ git clone https://github.com/ladybug-tools/honeybee-openstudio-gem
54
+ ```
55
+
56
+ 2. Install dependencies:
57
+ First install the OpenStudio Extension Gem following the
58
+ [installation instructions on the gem's github](https://github.com/NREL/openstudio-extension-gem#installation)
59
+ This will involve both the installation of OpenStudio and Ruby.
60
+ Then, you must install the OpenStudio Extension Gem itself with:
61
+ ```
62
+ gem install openstudio-extension
63
+ ```
64
+ Then, the specific dependencies of this measure can be installed by running:
65
+ ```
66
+ cd honeybee-openstudio-gem
67
+ bundle update
68
+ ```
69
+
70
+ 3. Run Core Library Tests:
71
+ ```
72
+ cd honeybee-openstudio-gem
73
+ bundle exec rake
74
+ ```
75
+
76
+ 4. Run Measure Tests:
77
+ ```
78
+ cd honeybee-openstudio-gem/lib/measures/from_honeybee_model/tests/
79
+ bundle exec ruby from_honeybee_model_test.rb
80
+
81
+ cd honeybee-openstudio-gem/lib/measures/from_honeybee_simulation_parameter/tests/
82
+ bundle exec ruby from_honeybee_simulation_parameter_test.rb
83
+ ```
84
+
85
+ 5. Update doc_templates:
86
+ ```
87
+ cd honeybee-openstudio-gem
88
+ bundle exec rake openstudio:update_copyright
89
+ ```
90
+
91
+ 6. See all available rake tasks:
92
+ ```
93
+ cd honeybee-openstudio-gem
94
+ bundle exec rake -T
95
+ ```
@@ -0,0 +1,21 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ require 'rubocop/rake_task'
7
+ RuboCop::RakeTask.new
8
+
9
+ # Load in the rake tasks from the base openstudio-extension gem
10
+ require 'openstudio/extension/rake_task'
11
+ require 'from_honeybee/extension'
12
+ #require 'from_honeybee/simulation/extension'
13
+
14
+ os_extension = OpenStudio::Extension::RakeTask.new
15
+ os_extension.set_extension_class(FromHoneybee::Extension)
16
+
17
+ #TODO: Does this need to be implemented?
18
+ #os_extension.set_extension_class(FromHoneybee::ExtensionSimulationParameter)
19
+
20
+ task default: :spec
21
+
@@ -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
+ # Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
4
+ # Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
5
+ #
6
+ # Redistribution and use in source and binary forms, with or without
7
+ # modification, are permitted provided that the following conditions are met:
8
+ #
9
+ # (1) Redistributions of source code must retain the above copyright notice,
10
+ # this list of conditions and the following disclaimer.
11
+ #
12
+ # (2) Redistributions in binary form must reproduce the above copyright notice,
13
+ # this list of conditions and the following disclaimer in the documentation
14
+ # and/or other materials provided with the distribution.
15
+ #
16
+ # (3) Neither the name of the copyright holder nor the names of any contributors
17
+ # may be used to endorse or promote products derived from this software without
18
+ # specific prior written permission from the respective party.
19
+ #
20
+ # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
21
+ # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22
+ # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23
+ # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
24
+ # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
25
+ # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26
+ # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27
+ # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28
+ # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29
+ # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30
+ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
+ # *******************************************************************************
32
+ %>
@@ -0,0 +1,5 @@
1
+ /* @preserve
2
+ * Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable Energy, LLC,
3
+ Ladybug Tools LLC and other contributors. All rights reserved.
4
+ * Use of this source code is governed by the BSD license.
5
+ */
@@ -0,0 +1,30 @@
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
+ # *******************************************************************************
@@ -0,0 +1,35 @@
1
+
2
+ lib = File.expand_path('lib', __dir__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'from_honeybee/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'honeybee-openstudio'
8
+ spec.version = '1.8.1'
9
+ spec.authors = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
10
+ spec.email = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
11
+
12
+ spec.summary = 'Gem for translating between Honeybee JSON and OpenStudio Model.'
13
+ spec.description = 'Library and measures for translating between Honeybee JSON schema and OpenStudio Model schema (OSM).'
14
+ spec.homepage = 'https://github.com/ladybug-tools/honeybee-openstudio-gem'
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = 'exe'
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.add_development_dependency 'bundler', '~> 1.14'
26
+ spec.add_development_dependency 'rake', '12.3.1'
27
+ spec.add_development_dependency 'rspec', '3.7.0'
28
+ spec.add_development_dependency 'rubocop', '~> 0.54.0'
29
+
30
+ spec.add_dependency 'json-schema'
31
+ spec.add_dependency 'json_pure'
32
+ spec.add_dependency 'openstudio-extension', '0.1.6'
33
+ spec.add_dependency 'openstudio-standards', '~> 0.2.7'
34
+ spec.add_dependency 'public_suffix', '~> 3.1.1'
35
+ end
@@ -0,0 +1,113 @@
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 'urbanopt/scenario'
33
+ require 'openstudio/common_measures'
34
+ require 'openstudio/model_articulation'
35
+
36
+ require 'json'
37
+
38
+ module URBANopt
39
+ module Scenario
40
+ class HoneybeeMapper < SimulationMapperBase
41
+
42
+ # class level variables
43
+ @@instance_lock = Mutex.new
44
+ @@osw = nil
45
+ @@geometry = nil
46
+
47
+ def initialize()
48
+
49
+ # do initialization of class variables in thread safe way
50
+ @@instance_lock.synchronize do
51
+ if @@osw.nil?
52
+
53
+ # load the OSW for this class
54
+ osw_path = File.join(File.dirname(__FILE__), 'honeybee_workflow.osw')
55
+ File.open(osw_path, 'r') do |file|
56
+ @@osw = JSON.parse(file.read, symbolize_names: true)
57
+ end
58
+
59
+ # configure OSW with extension gem paths for measures and files
60
+ # all extension gems must be required before this line
61
+ @@osw = OpenStudio::Extension.configure_osw(@@osw)
62
+ end
63
+ end
64
+ end
65
+
66
+ def create_osw(scenario, features, feature_names)
67
+
68
+ if features.size != 1
69
+ raise "Mapper currently cannot simulate more than one feature at a time."
70
+ end
71
+ feature = features[0]
72
+ feature_id = feature.id
73
+ feature_type = feature.type
74
+ feature_name = feature.name
75
+ if feature_names.size == 1
76
+ feature_name = feature_names[0]
77
+ end
78
+
79
+ # deep clone of @@osw before we configure it
80
+ osw = Marshal.load(Marshal.dump(@@osw))
81
+
82
+ # set the name and description of the OSW to reference this particular feature
83
+ osw[:name] = feature_name
84
+ osw[:description] = feature_name
85
+
86
+ if feature_type == 'Building'
87
+ # set the honeybee JSON key to the from_honeybee_model measure
88
+ OpenStudio::Extension.set_measure_argument(
89
+ osw, 'from_honeybee_model', 'model_json', feature.detailed_model_filename)
90
+
91
+ # check if there is a HVAC key in the feature JSON properties
92
+ building_hash = feature.to_hash
93
+ if building_hash.key?(:system_type)
94
+ # assume the typical building measure is in the OSW and add the system type
95
+ OpenStudio::Extension.set_measure_argument(
96
+ osw, 'create_typical_building_from_model', 'system_type', system_type)
97
+ end
98
+
99
+ # add the feature id and name to the reporting measure
100
+ OpenStudio::Extension.set_measure_argument(
101
+ osw, 'default_feature_reports', 'feature_id', feature_id)
102
+ OpenStudio::Extension.set_measure_argument(
103
+ osw, 'default_feature_reports', 'feature_name', feature_name)
104
+ OpenStudio::Extension.set_measure_argument(
105
+ osw, 'default_feature_reports', 'feature_type', feature_type)
106
+
107
+ end
108
+ return osw
109
+ end
110
+
111
+ end #HoneybeeMapper
112
+ end #Scenario
113
+ end #URBANopt