Sha256: 8c78323a0976ee30c75a8ef8189c591b6a5c32eadbe520e423678173c06fb122
Contents?: true
Size: 1.66 KB
Versions: 5
Compression:
Stored size: 1.66 KB
Contents
# Openstudio Load Flexibility Measures Gem
This gem contains measures for thermal energy storage for building cooling and domestic hot water heating.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'openstudio-load-flexibility-measures'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install 'openstudio-load-flexibility-measures'
## Usage
The openstudio-load-flexibility-measures gem contains measures to apply thermal load flexibility to a building model. The current version contains the following:
* Add [HPHW](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_hpwh) (Heat Pump Hot Water Heater)
* Add [Central Ice Storage](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_central_ice_storage) (for plant loops)
* Add [Packaged Ice Storage](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_packaged_ice_storage) (for rooftop units)
Detailed instructions for usage are included in each measure's respective README.md and docs folder.
# Releasing
* Update CHANGELOG.md
* Run rake rubocop:auto_correct
* Update version in `/lib/openstudio/openstudio-load-flexibility-measures/version.rb`
* Create PR to master, after tests and reviews complete, then merge
* Locally - from the master branch, run rake release
* Release via github
* 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.
## TODO
- [ ] Update documentation pdf's to reflect revised measure names
Version data entries
5 entries across 5 versions & 1 rubygems