This page walks you through installing OpenStudio and the basic workflow.
OpenStudio SDK is supported on 64-bit versions of Windows 10, OS X 10.14 – 10.15, Ubuntu 18.04 and Ubuntu 20.04. OpenStudio SDK supports the latest EnergyPlus release which is bundled with the OpenStudio SDK installer. The version compatibility matrix lists specific versions of EnergyPlus and other dependencies for each version of OpenStudio SDK.
Download and install OpenStudio SDK
- Login to the OpenStudio SDK website. Create an account if you don't have one. EnergyPlus and OpenStudio SDK now share a password.
- Click "Downloads" at the top of the page.
- Choose the installer that matches your operating system. The OpenStudio SDK package contains the following components:
- Ruby API
- C# API
- Command Line Interface
Optional - Command Line Installation
The OpenStudio SDK installer is built using the Qt Installer Framework. Installation of OpenStudio SDK packages can be automated by passing the path to a customizable script to the installer using the
OpenStudio-3.2.0+e11f0a08b2-Windows.exe --script install.qs
An example installation script can be modified to support custom installation.
Optional - Setup a Building Component Library (BCL) Account
The BCL contains many useful measures that can be incorporated into OpenStudio SDK workflows or Parametric Analsysis Tool (PAT) projects. To access the content you will need to create an account:
- Navigate to Building Component Library (BCL). Create an account if you don't have one. Follow the instructions from the email sent to you upon registration and then login.
BCL content can also be accessed from within PAT. To take advantage of this integration, you will need to follow the steps outlined here to request a BCL key.
- Login to Building Component Library (BCL).
- Click on the
My Dashboardnear the top right of the website.
- Copy the text after
API v1.1 key: then paste the key into the PAT. You only need to configure the key in one place and it will be used globally throughout the OpenStudio SDK tools. Additionally, this key will be maintained when you install updates to OpenStudio SDK.
Optional - Install Ruby If you plan to use the OpenStudio SDK Ruby bindings via command prompt, you must install Ruby. Check the version compatibility matrix to see which version of Ruby is compatible.
- Download the Ruby installer. If you have the Windows (x64) version of OpenStudio SDK (Help>About>Compiler shows Visual Studio 12 2013 Win64), you'll need the x64 Ruby installer.
C:\ruby-2.7.2-x64-mingw32\bin(or wherever you installed Ruby) to the PATH environment variable. Detailed instructions.
Create a text file with the following text inside (modify
C:\openstudio-3.2.0based on where your version of OpenStudio SDK is installed):
Save the file as
C:\ruby-2.7.2-x64-mingw32\lib\ruby\site_ruby\openstudio.rb(or wherever you installed Ruby).
- Test your installation by opening a command prompt and typing:
irbENTER. Then, type
RUBY_VERSIONENTER. Ensure that the Ruby correct version is shown. Then, type
require 'openstudio'ENTER. If you see
=> true, it's working.
Quick Start Guide to the Parametric Analysis Tool (PAT)
The Parametric Analysis Tool Quick Start Guide (PDF) and the Parametric Analysis Tool Interface Guide provide an introduction to the interface and workflow for creating multiple design alternatives from a seed model.