Sha256: d62848bead73c38ac9a0f3ff7c79b10760014dadf000a219553348d05c44a0cf
Contents?: true
Size: 1.05 KB
Versions: 7
Compression:
Stored size: 1.05 KB
Contents
# URBANOpt Scenario Gem
### <StaticLink href="rdoc/">Rdocs</StaticLink>
The URBANopt Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'urbanopt-scenario'
```
And then execute:
$ bundle install
$ bundle update
Or install it yourself as:
$ gem install 'urbanopt-scenario'
## Testing
Check out the repository and then execute:
$ bundle install
$ bundle update
$ bundle exec rake
## Releasing
* Update change log
* Update version in `/lib/urbanopt/scenario/version.rb`
* Merge down to master
* run `rake release` from master
Version data entries
7 entries across 7 versions & 1 rubygems