Windows Installation Instructions

Dependencies

1. Install Ruby 2.5 (x64)

2. Include path to Ruby by adding the following to your environment variables path:

   C:\Ruby25-x64\bin

3. Create a new environment variable HOME and set the variable value to the following:

   C:\Users\<user_name>

   Detailed instructions for creating environment variables can be found online.

4. Install Bundler version 2.1:

    gem install bundler -v 2.1
   

5. Install OpenStudio 3.0.1

6. Create file C:\ruby-2.5.5-1-x64-mingw32\lib\ruby\site_ruby\openstudio.rb and edit it to contain the path to your installed OpenStudio (where X.X.X is the OpenStudio version installed):

    require 'C:\openstudio-X.X.X\Ruby\openstudio.rb'
   

7. Verify your OpenStudio and Ruby configuration:

    ruby -e "require 'openstudio'" -e "puts OpenStudio::Model::Model.new"
   

   Expected output:

    OS:Version,
     {<long-uuid>},                          !- Handle
     3.0.0;                                  !- Version Identifier`
   

Basic Set-up

1. Install the URBANopt™ Command Line Interface (CLI):

    gem install urbanopt-cli
   

2. View available CLI commands with:

    uo --help
   

3. For detailed instructions, see our example instructions

---