| Build Status | |
|---|---|
| master |  |
| develop |  |
After the v1.0.0 final NREL software distribution (04/27/2020), the OpenStudio Application is now independently supported and maintained with open source contributions by The OpenStudio Coalition and members of the software community at the GitHub repository https://github.com/openstudiocoalition/OpenStudioApplication. The NREL OpenStudio Application repository no longer accepts new issues or pull requests. Please submit new issues or enhancement requests in the new OpenStudio Coalition repository at https://github.com/openstudiocoalition/OpenStudioApplication/issues.
This repository hosts the graphical interfaces that have historically used the OpenStudio SDK[1]. These include the OpenStudio Application and the OpenStudio Sketchup Plug-in:
- The OpenStudio Application is a fully featured graphical interface to OpenStudio models including envelope, loads, schedules, and HVAC.
- The OpenStudio SketchUp Plug-in is an extension to Trimble’s popular SketchUp 3D modeling tool that allows users to quickly create geometry needed for EnergyPlus using the built-in functionality of Trimble SketchUp including existing drawing tools, integration with Google Earth, Building Maker, and Photo Match
| OpenStudio Application | Sketchup Plug-in |
|---|---|
 |
 |
[1] To understand why the graphical user interfaces are being separated from the SDK, please refer to A Shift in BTO’s BEM Strategy: A New Future for the OpenStudio Application.
OpenStudio is a cross-platform (Windows, Mac, and Linux) collection of software tools to support whole building energy modeling using EnergyPlus and advanced daylight analysis using Radiance. OpenStudio is an open source project to facilitate community development, extension, and private sector adoption.
OpenStudio includes a Software Development Kit (SDK) that allows building researchers and software developers to quickly get started through its multiple entry levels, including access through C++, Ruby, and C#.
More information and documentation is available at the OpenStudio website.
OpenStudio (core SDK) is included as a git submodule in the folder ./openstudio. Be sure to initialize submodules, which can be done during cloning by passing the --recurse-submodules flag, or after the fact via cd OpenStudioApplication/openstudio && git submodule init && git submodule update. When pulling updates from the remote repository run git pull --recurse-submodules and then git submodule update --remote --recursive.
On your first checkout be sure to initialize submodules, which can be done during cloning by passing the --recurse-submodules flag, or after the fact via cd OpenStudioApplication/openstudio && git submodule init && git submodule update.
When pulling new changes to the repository use the commands git pull --recurse-submodules and git submodule update --remote to update the ./openstudio checkout. Use cd OpenStudioApplication/openstudio && git rev-parse HEAD to verify that the OpenStudio Core checkout is pointing at the desired SHA.
Temporary information: Current this submodule is tracking branch https://github.com/NREL/OpenStudio/tree/OS_App_killswitch which will soon replace NREL/OpenStudio/develop3.
To build, use the root of the repo when configuring with ccmake.
cd OpenStudioApplication
mkdir build
cd build
ccmake ../