Openstudio Metadata Gem
This gem produces semantic data representations for OpenStudio models
Installation
Add this line to your application's Gemfile:
gem 'openstudio-metadata'
And then execute:
$ bundle
Or install it yourself as:
$ gem install 'openstudio-metadata'
Usage
Find documentation at https://www.rubydoc.info/gems/openstudio-metadata
Note
This Gem requires OpenStudio@3.0 or greater
Developing
Environment Setup
- Prereqs: bundle, OpenStudio, ruby, rbenv (not technically required, but it will greately reduce headaches)
-
Install ruby with
rbenv
$ rbenv install 2.5.5
check compatability matrix for which ruby version is supported by your version of OpenStudio
-
Set project project to use specific ruby version:
$ rbenv local 2.5.5
-
Install required gems with
bundle
$ bundle install
Contributing
- Create branch
- Work on feature, add tests
- Make sure tests are passing:
bundle exec rspec
- Add commits
- Run
bundle exec rake rubocop:auto_correct
- Commit and push
- Add PR to feature
Releasing
- Update change log
- Update version in
/lib/openstudio/openstudio-metadata/version.rb
- Run
bundle exec rake rubocop:auto_correct
- Merge develop down to master and confirm tests pass
- Release via github
- run
rake release
from master