Skip to content

NREL/openstudio-aedg-gem

Repository files navigation

OpenStudio AEDG Measures

AEDG measures used by OpenStudio.

Installation

Add this line to your application's Gemfile:

gem 'openstudio-aedg-measures'

And then execute:

$ bundle

Or install it yourself as:

$ gem install 'openstudio-aedg-measures'

Compatibility Matrix

OpenStudio AEDG Gem OpenStudio Ruby
0.8.0 3.7 2.7
0.7.0 3.5 2.7
0.6.0 3.4 2.7
0.5.0 3.3 2.7
0.4.0 3.2 2.7
0.3.0 3.1 2.5
0.2.0 3.0 2.5
0.1.1 2.9 2.2.4

Contributing

Please review the OpenStudio Contribution Policy if you would like to contribute code to this gem.

TODO

  • Remove measures from OpenStudio-Measures to standardize on this location

Releasing

  • Update CHANGELOG.md
  • Run rake openstudio:rubocop:auto_correct
  • Run rake openstudio:update_copyright
  • Run rake openstudio:update_measures (this has to be done last since prior tasks alter measure files)
  • Update version in readme.md
  • Update version in openstudio-aedg.gemspec
  • Update version in /lib/openstudio/aedg_measures/version.rb
  • Create PR to master, after tests and reviews complete, then merge
  • Locally - from the master branch, run rake release
  • 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.