honeybee-openstudio 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 216430c5628ea722c0197ff3477739ac84246710e97968c651aa450bc0f2b87d
+  data.tar.gz: 16edc5b366b2d43987f4a6092647f9f83caaca94033bd4d529abadd171cfb07f
+SHA512:
+  metadata.gz: 8c68e4d78c76278088ce64bab960fcacbc9147fa559887fc4476f6d2b7511f62902a7bd01dd77241fb49ecb3dbe524270a32e0af396b5713b211591574ad35bf
+  data.tar.gz: f7764c5076949ce9935957a43e5f56d020fb25bb90b7e14cf8decd2451f38a9e00624b396e80b27ef0393b43e2ba7d58d14f0caf1fd2a827d5e2d9fa3f169073

data/.github/workflows/ci.yaml

@@ -0,0 +1,88 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+
+  test:
+    name: Unit tests
+    runs-on: ubuntu-18.04
+
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.1.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.1.0
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test
+
+  deploy_github:
+    name: Deploy to GitHub
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.ref == 'refs/heads/master' && github.repository_owner == 'ladybug-tools'
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up node  # we need node for for semantic release
+        uses: actions/setup-node@v2.1.2
+        with:
+          node-version: 14.2.0
+      - name: install semantic-release
+        run:
+          npm install @semantic-release/exec
+      - name: run semantic release
+        run: |
+          git config --global user.email "releases@ladybug.tools"
+          git config --global user.name "ladybugbot"
+          npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  deploy_rubygems:
+    name: Deploy to Rubygems.org
+    runs-on: ubuntu-latest
+    needs: deploy_github
+    steps:
+      - uses: actions/checkout@v2
+      - name: Update gemspec
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          export CLEAN_TAG=$(echo $RELEASE_TAG | sed 's/v//g')
+          sed -i 's/"0.0.0"/'"'$CLEAN_TAG'"'/g' honeybee-openstudio.gemspec
+      - name: Release Gem
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}
+
+  dispatch_schema:
+    name: Dispatch Schema to Clients
+    runs-on: ubuntu-latest
+    needs: deploy_github
+    strategy:
+      matrix:
+        client_repo:
+          - ladybug-tools/lbt-grasshopper
+    steps:
+    - name: Send repo dispatch to lbt-grasshopper
+      env:
+        RELEASE_TAG: ${{ github.event.release.tag_name }}
+        DISPATCH_URL: https://api.github.com/repos/${{ matrix.client_repo }}/dispatches
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      run: |
+        curl -X POST $DISPATCH_URL \
+          -H "Accept: application/vnd.github.everest-preview+json" \
+          -d '{
+            "event_type": "honeybee_openstudio_gem_release",
+            "client_payload": {
+              "version" : "'$RELEASE_TAG'"
+            }
+          }' \
+          -u ladybugbot:$GH_TOKEN

data/.gitignore

@@ -0,0 +1,33 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/gems
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/output/
+/spec/reports/
+/spec/test/
+/tmp/
+/test/
+/lib/measures/test_results
+/lib/measures/.rubocop*
+/.vscode
+/.vs
+
+# rspec failure tracking
+.rspec_status
+.rakeTasks
+
+# Ignore IDE files
+/.idea
+*.rubocop-http*
+
+# measures tests
+lib/measures/.rubocop.yml
+lib/measures/test_results/*
+lib/measures/*/tests/output
+
+out.txt

data/.releaserc.json

@@ -0,0 +1,7 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github"
+    ]
+}

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies
+gemspec
+
+# get the openstudio-extension gem
+if File.exist?('../OpenStudio-extension-gem')  # local development copy
+  gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
+else  # get it from rubygems.org
+  gem 'openstudio-extension', '0.2.5'
+end
+
+# coveralls gem is used to generate coverage reports through CI
+gem 'coveralls_reborn', require: false

data/LICENSE.md

@@ -0,0 +1,23 @@
+Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable Energy, LLC,
+Ladybug Tools LLC and other contributors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.
+
+(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products
+derived from this software without specific prior written permission from the respective party.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
+STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,95 @@
+[![Build Status](https://github.com/ladybug-tools/honeybee-openstudio-gem/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-openstudio-gem/actions)
+[![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)
+
+![Ruby 2.5](https://img.shields.io/badge/ruby-2.5-blue.svg)
+
+# honeybee-openstudio-gem
+
+Library and measures for translating between Honeybee JSON schema and OpenStudio Model schema (OSM).
+
+
+## Run the measures of this repo using OpenStudio CLI
+
+Running the measures using OpenStudio CLI requires no installation other than cloning
+this repo and installing OpenStudio.
+
+1. Write an OpenStudio Workflow (osw) JSON that passes honeybee model and simulation
+parameter JSON files to the measures. Here is a sample where the items in parentheses
+should be replaced with specific file paths:
+
+```
+{
+    "measure_paths": [(PATH TO THIS REPOSITORY)/lib/measures"],
+    "steps": [
+        {
+            "arguments": {"model_json": (PATH TO MODEL JSON)},
+            "measure_dir_name": "from_honeybee_model"
+        },
+        {
+            "arguments": {"simulation_parameter_json": (PATH TO SIMULATION PARAMETER JSON)},
+            "measure_dir_name": "from_honeybee_simulation_parameter"
+        }
+    ]
+}
+```
+
+2. Call the OpenStudio CLI from command line, making sure to pass this repository's
+lib folder to the CLI using the `-I` (or `--include`) option. Here is a sample
+where the items in parentheses should be replaced with specific file paths:
+
+```
+"(OPENSTUDIO INSTALLATION PATH)/bin/openstudio.exe" -I (PATH TO THIS REPOSITORY)/lib run -m -w (PATH TO OSW FILE)
+
+```
+
+
+## Local Development
+1. Clone this repo locally
+```
+git clone git@github.com:ladybug-tools/honeybee-openstudio-gem
+
+# or
+
+git clone https://github.com/ladybug-tools/honeybee-openstudio-gem
+```
+
+2. Install dependencies:
+First install the OpenStudio Extension Gem following the
+[installation instructions on the gem's github](https://github.com/NREL/openstudio-extension-gem#installation)
+This will involve both the installation of OpenStudio and Ruby.
+Then, you must install the OpenStudio Extension Gem itself with:
+```
+gem install openstudio-extension
+```
+Then, the specific dependencies of this repository can be installed by running:
+```
+cd honeybee-openstudio-gem
+bundle update
+```
+
+3. Run Core Library Tests:
+```
+cd honeybee-openstudio-gem
+bundle exec rake
+```
+
+4. Run Measure Tests:
+```
+cd honeybee-openstudio-gem/lib/measures/from_honeybee_model/tests/
+bundle exec ruby from_honeybee_model_test.rb
+
+cd honeybee-openstudio-gem/lib/measures/from_honeybee_simulation_parameter/tests/
+bundle exec ruby from_honeybee_simulation_parameter_test.rb
+```
+
+5. Update doc_templates:
+```
+cd honeybee-openstudio-gem
+bundle exec rake openstudio:update_copyright
+```
+
+6. See all available rake tasks:
+```
+cd honeybee-openstudio-gem
+bundle exec rake -T
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+# Load in the rake tasks from the base openstudio-extension gem
+require 'openstudio/extension/rake_task'
+require 'honeybee/extension'
+
+os_extension = OpenStudio::Extension::RakeTask.new
+os_extension.set_extension_class(Honeybee::Extension)
+
+task default: :spec

data/doc_templates/LICENSE.md

@@ -0,0 +1,23 @@
+Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable Energy, LLC,
+Ladybug Tools LLC and other contributors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.
+
+(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products
+derived from this software without specific prior written permission from the respective party.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
+STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/doc_templates/README.md.erb

@@ -0,0 +1,42 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+###### (Automatically generated documentation)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>

data/doc_templates/copyright_erb.txt

@@ -0,0 +1,32 @@
+<%
+  # *******************************************************************************
+  # Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+  # Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+  #
+  # Redistribution and use in source and binary forms, with or without
+  # modification, are permitted provided that the following conditions are met:
+  #
+  # (1) Redistributions of source code must retain the above copyright notice,
+  # this list of conditions and the following disclaimer.
+  #
+  # (2) Redistributions in binary form must reproduce the above copyright notice,
+  # this list of conditions and the following disclaimer in the documentation
+  # and/or other materials provided with the distribution.
+  #
+  # (3) Neither the name of the copyright holder nor the names of any contributors
+  # may be used to endorse or promote products derived from this software without
+  # specific prior written permission from the respective party.
+  #
+  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+  # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+  # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+  # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+  # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+  # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+  # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+  # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+  # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+  # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  # *******************************************************************************
+%>

data/doc_templates/copyright_js.txt

@@ -0,0 +1,5 @@
+/* @preserve
+ * Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable Energy, LLC,
+Ladybug Tools LLC and other contributors. All rights reserved.
+ * Use of this source code is governed by the BSD license.
+*/

data/doc_templates/copyright_ruby.txt

@@ -0,0 +1,30 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************

data/honeybee-openstudio.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'honeybee-openstudio'
+  spec.version       = ''
+  spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
+  spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
+
+  spec.summary       = 'Gem for translating between Honeybee JSON and OpenStudio Model.'
+  spec.description   = 'Library and measures for translating between Honeybee JSON schema and OpenStudio Model schema (OSM).'
+  spec.homepage      = 'https://github.com/ladybug-tools/honeybee-openstudio-gem'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  if /^2.5/.match(RUBY_VERSION)
+    spec.required_ruby_version = "~> 2.5.0"
+
+    spec.add_development_dependency "bundler",        "~> 2.1"
+    spec.add_development_dependency "public_suffix",  "~> 3.1.1"
+    spec.add_development_dependency "json-schema",    "~> 2.8.1"
+    spec.add_development_dependency "rake",           "~> 13.0"
+    spec.add_development_dependency "rspec",          "~> 3.9"
+    spec.add_development_dependency "rubocop",        "~> 0.54.0"
+  end
+
+  spec.add_dependency 'json_pure'
+  spec.add_dependency 'openstudio-extension', '0.2.5'
+  spec.add_dependency 'openstudio-standards', '~> 0.2.12'
+end