honeybee-openstudio 0 → 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +32 -33
  4. data/.releaserc.json +7 -7
  5. data/.travis.yml +41 -0
  6. data/Gemfile +18 -14
  7. data/LICENSE.md +23 -23
  8. data/README.md +95 -95
  9. data/Rakefile +21 -16
  10. data/doc_templates/LICENSE.md +23 -23
  11. data/doc_templates/copyright_erb.txt +31 -31
  12. data/doc_templates/copyright_js.txt +4 -4
  13. data/doc_templates/copyright_ruby.txt +29 -29
  14. data/honeybee-openstudio.gemspec +35 -38
  15. data/lib/files/Honeybee.rb +112 -112
  16. data/lib/files/honeybee_workflow.osw +47 -47
  17. data/lib/files/urbanopt_Gemfile +32 -32
  18. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/model.json +8126 -11310
  19. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/simulation-parameter.json +842 -972
  20. data/lib/{to_openstudio → from_honeybee}/construction/air.rb +65 -56
  21. data/lib/{to_openstudio → from_honeybee}/construction/opaque.rb +77 -67
  22. data/lib/{to_openstudio → from_honeybee}/construction/shade.rb +108 -99
  23. data/lib/{to_openstudio → from_honeybee}/construction/window.rb +80 -70
  24. data/lib/{to_openstudio → from_honeybee}/construction_set.rb +278 -266
  25. data/lib/{honeybee → from_honeybee}/extension.rb +109 -129
  26. data/lib/{to_openstudio → from_honeybee}/geometry/aperture.rb +167 -157
  27. data/lib/{to_openstudio → from_honeybee}/geometry/door.rb +160 -150
  28. data/lib/{to_openstudio → from_honeybee}/geometry/face.rb +163 -178
  29. data/lib/{to_openstudio → from_honeybee}/geometry/room.rb +392 -442
  30. data/lib/{to_openstudio → from_honeybee}/geometry/shade.rb +89 -79
  31. data/lib/{to_openstudio → from_honeybee}/hvac/ideal_air.rb +150 -141
  32. data/lib/{to_openstudio → from_honeybee}/load/electric_equipment.rb +96 -87
  33. data/lib/{to_openstudio → from_honeybee}/load/gas_equipment.rb +97 -88
  34. data/lib/{to_openstudio → from_honeybee}/load/infiltration.rb +94 -85
  35. data/lib/{to_openstudio → from_honeybee}/load/lighting.rb +98 -89
  36. data/lib/{to_openstudio → from_honeybee}/load/people.rb +100 -91
  37. data/lib/{to_openstudio → from_honeybee}/load/setpoint_humidistat.rb +75 -66
  38. data/lib/{to_openstudio → from_honeybee}/load/setpoint_thermostat.rb +71 -62
  39. data/lib/{to_openstudio → from_honeybee}/load/ventilation.rb +96 -87
  40. data/lib/{to_openstudio → from_honeybee}/material/opaque.rb +94 -85
  41. data/lib/{to_openstudio → from_honeybee}/material/opaque_no_mass.rb +94 -85
  42. data/lib/{to_openstudio → from_honeybee}/material/window_blind.rb +238 -229
  43. data/lib/{to_openstudio → from_honeybee}/material/window_gas.rb +76 -67
  44. data/lib/{to_openstudio → from_honeybee}/material/window_gas_custom.rb +118 -108
  45. data/lib/{to_openstudio → from_honeybee}/material/window_gas_mixture.rb +79 -70
  46. data/lib/{to_openstudio → from_honeybee}/material/window_glazing.rb +166 -157
  47. data/lib/{to_openstudio → from_honeybee}/material/window_shade.rb +160 -151
  48. data/lib/{to_openstudio → from_honeybee}/material/window_simpleglazsys.rb +73 -64
  49. data/lib/from_honeybee/model.rb +434 -0
  50. data/lib/{honeybee → from_honeybee}/model_object.rb +110 -108
  51. data/lib/{to_openstudio → from_honeybee}/program_type.rb +124 -104
  52. data/lib/{to_openstudio → from_honeybee}/schedule/fixed_interval.rb +115 -105
  53. data/lib/{to_openstudio → from_honeybee}/schedule/ruleset.rb +164 -164
  54. data/lib/{to_openstudio → from_honeybee}/schedule/type_limit.rb +88 -76
  55. data/lib/{to_openstudio/simulation/design_day.rb → from_honeybee/simulation/designday.rb} +105 -96
  56. data/lib/{honeybee/load/lighting.rb → from_honeybee/simulation/extension.rb} +46 -43
  57. data/lib/{to_openstudio/simulation/parameter_model.rb → from_honeybee/simulation/parameter.rb} +277 -243
  58. data/lib/{honeybee/simulation/design_day.rb → from_honeybee/version.rb} +34 -42
  59. data/lib/{honeybee.rb → from_honeybee.rb} +86 -93
  60. data/lib/measures/from_honeybee_model/LICENSE.md +27 -23
  61. data/lib/measures/from_honeybee_model/README.md +32 -32
  62. data/lib/measures/from_honeybee_model/measure.rb +91 -91
  63. data/lib/measures/from_honeybee_model/measure.xml +103 -80
  64. data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -126
  65. data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +27 -23
  66. data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -32
  67. data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -95
  68. data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -86
  69. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
  70. metadata +89 -147
  71. data/.github/workflows/ci.yaml +0 -88
  72. data/doc_templates/README.md.erb +0 -42
  73. data/lib/from_openstudio/geometry/aperture.rb +0 -136
  74. data/lib/from_openstudio/geometry/door.rb +0 -136
  75. data/lib/from_openstudio/geometry/face.rb +0 -174
  76. data/lib/from_openstudio/geometry/room.rb +0 -121
  77. data/lib/from_openstudio/geometry/shade.rb +0 -87
  78. data/lib/from_openstudio/model.rb +0 -123
  79. data/lib/from_openstudio/model_object.rb +0 -43
  80. data/lib/from_openstudio/simulation/design_day.rb +0 -123
  81. data/lib/from_openstudio/simulation/parameter_model.rb +0 -93
  82. data/lib/from_openstudio/simulation/simulation_output.rb +0 -67
  83. data/lib/from_openstudio.rb +0 -49
  84. data/lib/honeybee/_defaults/energy_default.json +0 -1682
  85. data/lib/honeybee/construction/air.rb +0 -42
  86. data/lib/honeybee/construction/opaque.rb +0 -42
  87. data/lib/honeybee/construction/shade.rb +0 -42
  88. data/lib/honeybee/construction/window.rb +0 -51
  89. data/lib/honeybee/construction/windowshade.rb +0 -43
  90. data/lib/honeybee/construction_set.rb +0 -42
  91. data/lib/honeybee/geometry/aperture.rb +0 -42
  92. data/lib/honeybee/geometry/door.rb +0 -42
  93. data/lib/honeybee/geometry/face.rb +0 -48
  94. data/lib/honeybee/geometry/room.rb +0 -56
  95. data/lib/honeybee/geometry/shade.rb +0 -42
  96. data/lib/honeybee/hvac/ideal_air.rb +0 -42
  97. data/lib/honeybee/hvac/template.rb +0 -73
  98. data/lib/honeybee/load/electric_equipment.rb +0 -42
  99. data/lib/honeybee/load/gas_equipment.rb +0 -42
  100. data/lib/honeybee/load/infiltration.rb +0 -42
  101. data/lib/honeybee/load/people.rb +0 -42
  102. data/lib/honeybee/load/setpoint_humidistat.rb +0 -46
  103. data/lib/honeybee/load/setpoint_thermostat.rb +0 -46
  104. data/lib/honeybee/load/ventilation.rb +0 -42
  105. data/lib/honeybee/material/opaque.rb +0 -42
  106. data/lib/honeybee/material/opaque_no_mass.rb +0 -42
  107. data/lib/honeybee/material/window_blind.rb +0 -42
  108. data/lib/honeybee/material/window_gas.rb +0 -42
  109. data/lib/honeybee/material/window_gas_custom.rb +0 -42
  110. data/lib/honeybee/material/window_gas_mixture.rb +0 -42
  111. data/lib/honeybee/material/window_glazing.rb +0 -42
  112. data/lib/honeybee/material/window_shade.rb +0 -42
  113. data/lib/honeybee/material/window_simpleglazsys.rb +0 -42
  114. data/lib/honeybee/model.rb +0 -87
  115. data/lib/honeybee/program_type.rb +0 -56
  116. data/lib/honeybee/schedule/fixed_interval.rb +0 -42
  117. data/lib/honeybee/schedule/ruleset.rb +0 -42
  118. data/lib/honeybee/schedule/type_limit.rb +0 -42
  119. data/lib/honeybee/simulation/parameter_model.rb +0 -86
  120. data/lib/honeybee/simulation/simulation_output.rb +0 -42
  121. data/lib/honeybee/ventcool/control.rb +0 -42
  122. data/lib/honeybee/ventcool/opening.rb +0 -46
  123. data/lib/honeybee/ventcool/simulation.rb +0 -42
  124. data/lib/to_openstudio/construction/windowshade.rb +0 -196
  125. data/lib/to_openstudio/hvac/Model.hvac.rb +0 -641
  126. data/lib/to_openstudio/hvac/template.rb +0 -169
  127. data/lib/to_openstudio/model.rb +0 -497
  128. data/lib/to_openstudio/model_object.rb +0 -52
  129. data/lib/to_openstudio/ventcool/control.rb +0 -185
  130. data/lib/to_openstudio/ventcool/opening.rb +0 -189
  131. data/lib/to_openstudio/ventcool/simulation.rb +0 -101
  132. data/lib/to_openstudio.rb +0 -92
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA256:
3
- metadata.gz: 216430c5628ea722c0197ff3477739ac84246710e97968c651aa450bc0f2b87d
4
- data.tar.gz: 16edc5b366b2d43987f4a6092647f9f83caaca94033bd4d529abadd171cfb07f
2
+ SHA1:
3
+ metadata.gz: a869918b67dca52d683ba3d0b2b88d63018abc41
4
+ data.tar.gz: 9c2816bfe47c3fdb46c6187f3d34dbcb8bdfc494
5
5
  SHA512:
6
- metadata.gz: 8c68e4d78c76278088ce64bab960fcacbc9147fa559887fc4476f6d2b7511f62902a7bd01dd77241fb49ecb3dbe524270a32e0af396b5713b211591574ad35bf
7
- data.tar.gz: f7764c5076949ce9935957a43e5f56d020fb25bb90b7e14cf8decd2451f38a9e00624b396e80b27ef0393b43e2ba7d58d14f0caf1fd2a827d5e2d9fa3f169073
6
+ metadata.gz: 006bfdc2d1e0827e9b9d61d598c721275869af05efdd2ebe4c38e05527718540fa902a475cb46108238d253551faa0432648b94946b89e2cd350fad0a728b110
7
+ data.tar.gz: f5e9980234d83bd0d0038b176524e7a3e6dfccc3ec1370ff21121d9fb48dff447ffcb02ea92f7440f16176da03bff1c43b0dbf8abea9a8ad26cea1bd69d89325
data/.coveralls.yml ADDED
@@ -0,0 +1 @@
1
+ service_name: travis-ci
data/.gitignore CHANGED
@@ -1,33 +1,32 @@
1
- /.bundle/
2
- /.yardoc
3
- /.ruby-version
4
- /Gemfile.lock
5
- /gems
6
- /_yardoc/
7
- /coverage/
8
- /doc/
9
- /pkg/
10
- /spec/output/
11
- /spec/reports/
12
- /spec/test/
13
- /tmp/
14
- /test/
15
- /lib/measures/test_results
16
- /lib/measures/.rubocop*
17
- /.vscode
18
- /.vs
19
-
20
- # rspec failure tracking
21
- .rspec_status
22
- .rakeTasks
23
-
24
- # Ignore IDE files
25
- /.idea
26
- *.rubocop-http*
27
-
28
- # measures tests
29
- lib/measures/.rubocop.yml
30
- lib/measures/test_results/*
31
- lib/measures/*/tests/output
32
-
33
- out.txt
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
data/.releaserc.json CHANGED
@@ -1,7 +1,7 @@
1
- {
2
- "plugins": [
3
- "@semantic-release/commit-analyzer",
4
- "@semantic-release/release-notes-generator",
5
- "@semantic-release/github"
6
- ]
7
- }
1
+ {
2
+ "plugins": [
3
+ "@semantic-release/commit-analyzer",
4
+ "@semantic-release/release-notes-generator",
5
+ "@semantic-release/github"
6
+ ]
7
+ }
data/.travis.yml ADDED
@@ -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 CHANGED
@@ -1,14 +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.2.5'
11
- end
12
-
13
- # coveralls gem is used to generate coverage reports through CI
14
- gem 'coveralls_reborn', require: false
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'
data/LICENSE.md CHANGED
@@ -1,23 +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.
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/README.md CHANGED
@@ -1,95 +1,95 @@
1
- [![Build Status](https://github.com/ladybug-tools/honeybee-openstudio-gem/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-openstudio-gem/actions)
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.5](https://img.shields.io/badge/ruby-2.5-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 repository 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
- ```
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
+ ```
data/Rakefile CHANGED
@@ -1,16 +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 'honeybee/extension'
12
-
13
- os_extension = OpenStudio::Extension::RakeTask.new
14
- os_extension.set_extension_class(Honeybee::Extension)
15
-
16
- task default: :spec
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
+
@@ -1,23 +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.
1
+ Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable Energy, LLC,
2
+ Ladybug Tools LLC and other contributors. All rights reserved.
3
+
4
+ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
5
+ following conditions are met:
6
+
7
+ (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
8
+ disclaimer.
9
+
10
+ (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
11
+ disclaimer in the documentation and/or other materials provided with the distribution.
12
+
13
+ (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products
14
+ derived from this software without specific prior written permission from the respective party.
15
+
16
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
17
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
19
+ STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
21
+ USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -1,32 +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
- # *******************************************************************************
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
32
  %>
@@ -1,5 +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.
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
5
  */
@@ -1,30 +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.
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
30
  # *******************************************************************************