Link Search Menu Expand Document

Linux Installation Instructions

As of version 0.3.1, an URBANopt installer (Ubuntu 18.04) is available to install the URBANopt CLI, Ruby 2.5.x, and OpenStudio SDK at the same time. If you’d rather install the dependencies manually, view the manual install section below.

For CLI usage examples, see our usage examples page

Install with the URBANopt Installer

  1. Download the desired version of the .deb package.

  2. This will install to /usr/local/ directory. e.g.: /usr/local/urbanopt-cli-0.3.1/

  3. To run the UrbanOpt CLI, first run the script that generates environmental variables and stores these in in your home directory.

. ~/
  1. When launching new shell terminals, run . ~/ to setup the environment.

Manual Install

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.1.0

    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)

  5. Install the URBANopt Command Line Interface (CLI):

     gem install urbanopt-cli

URBANopt CLI Usage

  1. View available CLI commands with:

     uo --help
  2. For detailed instructions, see the usage examples page.

OpenDSS and DiTTo Reader Set-up

As of version 0.4.0, the URBANopt CLI includes DiTTo/OpenDSS support. Since this functionality is implemented in Python, a different set of dependencies must be installed in order to use it.

If you’d like to use this functionality, follow the OpenDSS installation instructions.

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