This branch is the development branch for the OpenStudio workflow gem.
The OpenStudio Workflow Gem has the following dependencies:
- Ruby 2.7.2
- OpenStudio 3.x
OpenStudio needs to be installed and in your path. On Mac/Linux it is easiest to add the following to your .bash_profile or /etc/profile.d/.sh to ensure OpenStudio loads. Assuming OpenStudio 3.0.0 installed:
export RUBYLIB=/usr/local/openstudio-3.0.0/Ruby
Add this line to your application's Gemfile:
gem 'OpenStudio-workflow'
And then execute:
bundle install
Or install it yourself as:
$ gem install openstudio-workflow
There are currently two adapters to run OpenStudio workflow. The first is a simple Local adapter allowing the user to pass in the directory to simulation. The directory must have an analysis/problem JSON file and a datapoint JSON file.
The workflow manager will use these data (and the measures, seed model, and weather data) to assemble and execute the standard workflow of (preflight->openstudio measures->energyplus->postprocess).
r = OpenStudio::Workflow.load 'Local', '/home/user/a_directory', options
r.run
There are also socket and web-based adapters that have yet to be documented.
The preferred way for testing is to run rspec either natively or via docker.
rspec spec/
export OPENSTUDIO_VERSION=3.0.0
docker run -v $(pwd):/var/simdata/openstudio \
nrel/openstudio:$OPENSTUDIO_VERSION \
/var/simdata/openstudio/test/bin/docker-run.sh
- Fork it ( https://github.com/NREL/OpenStudio-workflow/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request