Mac Installation Instructions


  1. Install Ruby 2.5 (anything in the 2.5.x range will work). We recommend using rbenv to manage and install Ruby 2.5
    • brew install rbenv
    • rbenv install 2.5.x
    • Do not forget the rbenv init step of rbenv installation
    • Once installed, you may check which versions of Ruby have been installed and which one is active with: rbenv versions
    • Set your current directory to use Ruby 2.5.x with: rbenv local 2.5.x
    • Full documentation for rbenv can be found at the rbenv github site
  2. Install Bundler version 2.1:

     gem install bundler -v 2.1
  3. Install OpenStudio 3.0.0
  4. Add the RUBYLIB path as an “environment variable”, pointing to the OpenStudio Ruby location you just installed. You can use a text editor such as TextEdit, Sublime Text, vi or nano to open .bash_profile (or .zshenv if using zsh, the default since MacOS 10.15 Catalina). The following is an example using nano:

    1. Type the following in the terminal: nano ~/.bash_profile (or nano ~/.zshenv)
    2. Copy and paste export RUBYLIB=/Applications/OpenStudio-X.X.X/Ruby (where X.X.X is the OpenStudio version installed) at the top of the file
    3. Press control-x to exit, then y to save the changes, and the return key to go back to the terminal

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