buildingsync 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5149ec80301b45d4d0c933059ebdfbb18f1ba987d604d3df5cf6c7b8f4d10b8
+  data.tar.gz: e67bd524c2f3386313ea3a0089a8f49cf8b5b4c0eb6cd832014c692b5c8b3f08
+SHA512:
+  metadata.gz: 07db8576a601b662692cb5a10e6386b951acb27788af712ed383e7eae60f4489830e57066bab1b260fc6fa74fe63c27cdc6c0e2b713f96014e88c8682913c5dc
+  data.tar.gz: 481a3639e0aa4437a3fbe6f6e7bf9bde57f530f2a021cd3a10b49393b5360932e5fdf9df3bd14f8614242254d75bd8466aa269f0b561af0f1096a04377e46472

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,146 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  model_articulation_tests:
+    name: Model Articulation Tests
+    container: nrel/openstudio:3.0.1
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+    - name: Setup
+      run: |
+        gem install bundler
+        bundle install
+    - name: Building Section Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/building_section_spec.rb
+      if: always()
+    - name: Building Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/building_spec.rb
+      if: always()
+    - name: Envelope System Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/envelope_system_spec.rb
+      if: always()
+    - name: Facility Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/facility_spec.rb
+      if: always()
+    - name: HVAC System Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/hvac_system_spec.rb
+      if: always()
+    - name: Loads System Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/loads_system_spec.rb
+      if: always()
+    - name: Lighting System Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/lighting_system_type_spec.rb
+      if: always()
+    - name: SHW System Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/service_hot_water_system_spec.rb
+      if: always()
+    - name: Site Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/site_spec.rb
+      if: always()
+    - name: Hospital Occupancy Type Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/hospital_occupancy_type_spec.rb
+      if: always()
+    - name: Occupancy Types Spec
+      run: bundle exec rspec spec/tests/model_articulation_test/occupancy_types_spec.rb
+      if: always()
+#    Fails sometimes due to connection issues, so we exclude it here
+#    - name: Weather File Download
+#      run: bundle exec rspec spec/tests/model_articulation_test/weather_file_download_spec.rb
+#      if: always()
+
+  translator_tests:
+    name: Translator Tests
+    container: nrel/openstudio:3.0.1
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+    - name: Setup
+      run: |
+        gem install bundler
+        bundle install
+    - name: Translator Example Spec
+      run: bundle exec rspec spec/tests/translator_spec.rb
+      if: always()
+    - name: Translator Sizing Run Spec
+      run: bundle exec rspec spec/tests/translator_sizing_run_spec.rb
+      if: always()
+    - name: Translator Scenario Generation Specs
+      run: bundle exec rspec spec/tests/translator_scenario_generation_spec.rb
+      if: always()
+    - name: Translator Scenario Simulation Spec
+      run: bundle exec rspec spec/tests/translator_scenario_simulations_spec.rb
+      if: always()
+
+  report_and_scenario_tests:
+    name: Report and Scenario Tests
+    container: nrel/openstudio:3.0.1
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+    - name: Setup
+      run: |
+        gem install bundler
+        bundle install
+    - name: Report Spec
+      run: bundle exec rspec spec/tests/report_spec.rb
+      if: always()
+    - name: Utility Spec
+      run: bundle exec rspec spec/tests/utility_spec.rb
+      if: always()
+    - name: Scenario Spec
+      run: bundle exec rspec spec/tests/scenario_spec.rb
+      if: always()
+    - name: TimeSeries Spec
+      run: bundle exec rspec spec/tests/time_series_spec.rb
+      if: always()
+    - name: ResourceUse Spec
+      run: bundle exec rspec spec/tests/resource_use_spec.rb
+      if: always()
+    - name: AllResourceTotal Spec
+      run: bundle exec rspec spec/tests/all_resource_total_spec.rb
+      if: always()
+    - name: WorkflowMaker Spec
+      run: bundle exec rspec spec/tests/workflow_maker_spec.rb
+      if: always()
+
+  other_specs:
+    name: Other Tests
+    container: nrel/openstudio:3.0.1
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+    - name: Setup
+      run: |
+        gem install bundler
+        bundle install
+    - name: BuildingSync Spec
+      run: bundle exec rspec spec/tests/building_sync_spec.rb
+      if: always()
+    - name: EPW Test Spec
+      run: bundle exec rspec spec/tests/epw_test_spec.rb
+      if: always()
+    - name: Constants Spec
+      run: bundle exec rspec spec/tests/constants_spec.rb
+      if: always()
+    - name: Generator Spec
+      run: bundle exec rspec spec/tests/generator_spec.rb
+      if: always()
+    - name: Helper Spec
+      run: bundle exec rspec spec/tests/helper_spec.rb
+      if: always()
+    - name: XMLGetSet Spec
+      run: bundle exec rspec spec/tests/xml_get_set_spec.rb
+      if: always()
+#     selection tool is not working with ASHRAE level 1.5 yet
+#    - name: Selection Tool Spec
+#      run: bundle exec rspec spec/tests/selection_tool_spec.rb
+#      if: always()

data/.gitignore

@@ -0,0 +1,33 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/.python-version
+/Gemfile.lock
+/gems
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/output/
+/SR1
+/SRvt
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore IDE files
+/.idea
+*.rubocop-http*
+
+# measures tests
+lib/measures/.rubocop.yml
+lib/measures/test_results/*
+
+spec/files/filecomparison/in.idf
+spec/files/filecomparison/in.osm
+spec/weather/weather_file.json
+
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - gems/**/*
+    - measures/**/*
+    - spec/files/**/measures/**/*
+
+
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+# BuildingSync Gem
+
+## Version 0.2.0
+
+This is released as a minor version since we are so early stage, even though it has many breaking changes.  Most of the 'high-level API' (translator) remains.
+
+- Added many BuildingSync specific classes:
+    - AllResourceTotal
+    - AuditDate
+    - Contact
+    - Report
+    - ResourceUse
+    - Scenario
+    - TimeSeries
+    - Utility
+
+- Major modifications to:
+    - WorkflowMaker
+    - Building
+    - BuildingSection
+    - Facility
+    - HVACSystem
+    - LightingSystem
+    - LoadsSystem
+    - Site
+    - SpatialElement
+    - Translator
+    
+- Added / modified modules / classes:
+    - Generator
+    - Helper
+    - XmlGetSet: many useful functions to get / set XML data given a base_xml
+    - LocationElement
+    
+- Removed Classes:
+    - ModelMakerBase
+    - ModelMaker
+    - MeteredEnergy
+    
+- Added `constants.rb`
+- Renamed `bldg_and_system_types.json1` -> `building_and_system_types.json`
+- Removed redundant / unused XML files
+- Updated files to comply with specific BSync versions (v2.1.0, v2.2.0)
+- Significantly more testing
+
+## Version 0.1.0
+
+* Initial release
+* Support Level 0 (walkthrough), Level 1, and simplified Level 2 energy audits specified by ASHRAE Standard 211-2018. 
+* Support Office, Retail, and Hotel Building Types

data/Gemfile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec
+
+# Local gems are useful when developing and integrating the various dependencies.
+# To favor the use of local gems, set the following environment variable:
+#   Mac: export FAVOR_LOCAL_GEMS=1
+#   Windows: set FAVOR_LOCAL_GEMS=1
+# Note that if allow_local is true, but the gem is not found locally, then it will
+# checkout the latest version (develop) from github.
+allow_local = ENV['FAVOR_LOCAL_GEMS']
+
+if allow_local && File.exist?('../openstudio-common-measures-gem')
+  gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
+else
+  gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', tag: 'v0.2.1'
+end
+
+if allow_local && File.exist?('../openstudio-model-articulation-gem')
+  gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
+else
+  gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', tag: 'v0.2.1'
+end
+
+if allow_local && File.exist?('../openstudio-ee-gem')
+  gem 'openstudio-ee', path: '../openstudio-ee-gem'
+else
+  gem 'openstudio-ee', github: 'NREL/openstudio-ee-gem', tag: 'v0.2.1'
+end

data/Jenkinsfile

@@ -0,0 +1,10 @@
+//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/tijcolem/nrel_cbci_jenkins_libs 
+ 
+@Library('cbci_shared_libs') _
+
+// Build for PR to develop branch only. 
+if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
+
+  building_sync_gems()
+    
+}

data/LICENSE.md

@@ -0,0 +1,29 @@
+OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+BuildingSync(R), Copyright (c) 2015-2020, Alliance for Sustainable Energy, LLC. 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.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" or "BuildingSync" trademarks, "OS", "os", "BSync" or any 
+other confusingly similar designation without specific prior written permission from Alliance for 
+Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS 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,105 @@
+# BuildingSync
+
+The BuildingSync-Gem is a repository of helpers for reading and writing BuildingSync XML files, and for using that data to drive energy simulations of the subject building. See full documentation on [RubyDoc](https://www.rubydoc.info/github/BuildingSync/BuildingSync-gem).
+
+All of the following are supported: 
+
+* convert BuildingSync XML file into: 
+
+    * an OpenStudio Baseline model 
+
+    * an OpenStudio workflow for each scenario defined in the XML file 
+
+* enables simulation of the baseline model and all workflows and 
+
+* insert simulation results back into the Building XML file. 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'buildingsync'
+```
+
+And then execute:
+
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 'buildingsync'
+
+## Usage
+
+All of the features described above are provided by the translator class, as shown in the following sample code: 
+
+```ruby
+building_sync_xml_file_path = 'path/to/bsync.xml'
+out_path = 'path/to/output_dir'
+
+# initializing the translator 
+translator = BuildingSync::Translator.new(building_sync_xml_file_path, out_path)
+
+# generating the OpenStudio Model and writing the osm file.
+# path/to/output_dir/SR and path/to/output_dir/in.osm created
+translator.setup_and_sizing_run
+
+# generating the OpenStudio workflows and writing the osw files
+# auc:Scenario elements with measures are turned into new simulation dirs
+# path/to/output_dir/scenario_name
+translator.write_osws
+
+
+# run all simulations
+translator.run_osws
+
+# gather the results for all scenarios found in out_path,
+# such as annual and monthly data for different energy
+# sources (electricity, natural gas, etc.)
+translator.gather_results(out_path)
+
+# Add in UserDefinedFields, which contain information about the
+# OpenStudio model run 
+translator.prepare_final_xml
+
+# write results to xml
+# default file name is 'results.xml' 
+file_name = 'abc-123.xml' 
+translator.save_xml(file_name)
+```
+## Testing
+
+Check out the repository and then execute:
+
+    $ bundle install
+ 
+    $ bundle exec rake
+    
+## Documentation
+
+The documentation of the BuildingSync-Gem is done with Yard (https://yardoc.org)
+To generate the documentation locally do the following:
+
+     $ gem install yard
+     
+     $ yardoc - README.md 
+     
+## Updating published documentation
+Publish documentation for each release:
+
+1. Tag release on GitHub
+1. Go to [rubydoc.info](https://www.rubydoc.info) and click `Add Project` in the upper right
+1. Input the git address: `git://github/BuildingSync/BuildingSync-gem.git`
+1. Input the release tag for the desired version, eg: `v0.2.0`
+1. Click `Go`
+1. Profit
+    
+# Releasing
+
+1. Update CHANGELOG.md
+1. Run `bundle exec rake rubocop:auto_correct`
+1. Update version in `/lib/buildingsync/version.rb`
+1. Create PR to main, after tests and reviews complete, then merge
+1. Locally - from the main branch, run `bundle exec rake release`
+1. On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the description box.

data/Rakefile

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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.
+# *******************************************************************************
+
+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 extension gem
+require 'openstudio/extension/rake_task'
+require 'openstudio/model_articulation'
+rake_task = OpenStudio::Extension::RakeTask.new
+rake_task.set_extension_class(OpenStudio::ModelArticulation::Extension)
+
+desc 'Convert tabs to spaces'
+task :remove_tabs do
+  Dir['examples/**/*.xml', 'BuildingSync.xsd'].each do |file|
+    puts " Cleaning #{file}"
+    doc = Nokogiri.XML(File.read(file)) do |config|
+      config.default_xml.noblanks
+    end
+
+    doc.xpath('//comment()').each do |node|
+      if node.text.match?(/XMLSpy/)
+        node.remove
+      end
+    end
+
+    File.open(file, 'w') { |f| f << doc.to_xml(indent: 2) }
+  end
+
+  if File.exist? 'BuildingSync.json'
+    f = JSON.parse(File.read('BuildingSync.json'))
+    File.open('BuildingSync.json', 'w') do |file|
+      file << JSON.pretty_generate(f)
+    end
+  end
+end
+
+task default: :spec