Link Search Menu Expand Document

Linux Installation Instructions


Linux installation has not been tested exhaustively. Please submit a bug report via the Github issue page if you run into installation errors

  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
    • Install rbenv on your system
    • Install your desired Ruby version
    • 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.1
    OpenStudio is designed to be used on Ubuntu 18.04. For other Ubuntu versions, see the troubleshooting page.

  4. Add the RUBYLIB environment variable path pointing to OpenStudio Ruby location by pasting the following line into your .bash_profile, .zshenv or similar file:

         export RUBYLIB=/usr/local/openstudio-X.X.X/Ruby

    (where X.X.X is the OpenStudio version installed)

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

URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.