BuildingSync

Repository to store helpers for reading and writing BuildingSync as well as measures for converting a BuildingSync XML to OpenStudio models.

Installation

Add this line to your application's Gemfile:

gem 'buildingsync'

And then execute:

$ bundle

Or install it yourself as:

$ gem install 'buildingsync'

Usage

To be filled out later.

TODO

  • [ ] Add initial BuildingSync class (can use BRICR class as example). Use REXML for reading and writing BSync.
  • [ ] Add ForwardTranslator class (following other OpenStudio conventions) that translates BuildingSync to OpenStudio (using pure Ruby)
  • [ ] Move BuildingSync specific measures into this gem. See list from here
  • [ ] Add example on how to use some code from openstudio-standards or openstudio-model-articulation during the translation
  • [ ] Add unit test for BuildingSync -> OSM translation
  • [ ] Add ability to perform validation using https://selectiontool.buildingsync.net. Return which use cases existing BuildingSync XML is valid for.

Releasing

  • Update change log
  • Update version in /lib/buildingsync/version.rb
  • Merge down to master
  • Release via github
  • run rake release from master