Sha256: a0658242197dd109928292219c24fb081ed0a2518c5499f74cc5901119ca4c89
Contents?: true
Size: 1.7 KB
Versions: 5
Compression:
Stored size: 1.7 KB
Contents
# OpenStudio ModelArticulation
Library and measures for OpenStudio Model Articulation.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'openstudio-model-articulation'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install 'openstudio-model-articulation'
## Tests
To run the tests similar to how Jenkins run:
```
bundle install
bundle exec rake
bundle exec rake openstudio:list_measures
bundle exec rake openstudio:update_measures
bundle exec rake openstudio:test_with_openstudio
```
To run the tests the same way Jenkins run:
```
docker run -it -v $(pwd):/var/simdata/openstudio -u root -e "LANG=en_US.UTF-8" nrel/openstudio:3.0.0-beta-ruby-slim bash
# inside the container
gem install bundler -v '~> 2.1'
bundle update
# Run all the tests
bundle exec rake openstudio:test_with_openstudio
# or a sinlge measure's test, e.g.,
/usr/local/openstudio-3.0.0-beta/bin/openstudio-3.0.0-beta --verbose --bundle '/var/simdata/openstudio/Gemfile' --bundle_path '/var/simdata/openstudio/.bundle/install/' measure -r '/var/simdata/openstudio/lib/measures/radiance_measure/'
```
## TODO
- [ ] Move articulation measures from openstudio-measures
- [ ] Move articulation measure lib files to openstudio-extension lib
- [ ] Update measures to correct naming conventions
# Releasing
* Update CHANGELOG.md
* Run `rake rubocop:auto_correct`
* Update version in `/lib/openstudio/model_articulation/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.
Version data entries
5 entries across 5 versions & 1 rubygems