OpenStudio Platform Documentation

OpenStudio SDK Documentation

The components of the OpenStudio SDK are documented for use by internal and external interface developers. The C++ Documentation is the primary source for information about the classes and methods available in the OpenStudio SDK. The Ruby Documentation details name changes or other differences between the C++ interface and the Ruby interface.

Component Description C++ Documentation Ruby Documentation
Utilities Utility functionality used throughout the OpenStudio C++ SDK. Includes parsers for Idf and Idd file formats. utilities
utilities/idd
OpenStudio Utilities
OpenStudio BCL Utilities
OpenStudio Core Utilities
OpenStudio Data Utilities
OpenStudio Document Utilities
OpenStudio Economics Utilities
OpenStudio FileTypes Utilities
OpenStudio Geometry Utilities
OpenStudio Idd Utilities
OpenStudio Idf Utilities
OpenStudio Plot Utilities (deprecated)
OpenStudio Sql Utilities
OpenStudio Time Utilities
OpenStudio Units Utilities
Building Modeler The OpenStudio Building Model. model OpenStudio::Model
OpenStudio::Model (Core)
OpenStudio::Model (Simulation)
OpenStudio::Model (Resources)
OpenStudio::Model (Geometry)
OpenStudio::Model (HVAC)
Version Translator Backwards compatibility for OpenStudio Model and Component. osversion OpenStudio::OSVersion
EnergyPlus Manager Translators to and from EnergyPlus. energyplus OpenStudio::EnergyPlus
Radiance Manager Translators to and from Radiance. radiance OpenStudio::Radiance
Building Analyzer: Ruleset Electronic representation of measures for changing or analyzing buildng energy models ruleset OpenStudio::Ruleset
Run Manager Simulation workflow and run management functionality. runmanager OpenStudio::Runmanager
Building Analyzer: Analysis Framework Perturbation, optimization, and uncertainty handling of OpenStudio Building Models. analysis OpenStudio::Analysis
Project Manager Management of multiple OpenStudio Building Models associated with a single project. project OpenStudio::Project
Analysis Manager Management of applying analysis::Algorithms to analysis::Problems, with data persistence to a project database. analysisdriver OpenStudio::AnalysisDriver
Translator: gbXML Import of gbXML models into OpenStudio gbxml OpenStudio::GbXML
Translator: SDD Import and export of SDD models sdd OpenStudio::SDD
OpenStudio Application Components Library of Qt Widgets and related code that is used to build up the OpenStudio Application openstudio_lib
model_editor
OpenStudio::Openstudiolib
OpenStudio::Modeleditor

OpenStudio Application Documentation for Developers

Application Description Documentation
OpenStudio Plug-in for SketchUp Programmers guide to the OpenStudio Plug-in for SketchUp OpenStudio::Plugin
plugin
OpenStudio Application Building energy modeling and analysis interface for one model openstudio_app
ParametricAnalysisTool Create, run, and compare design alternatives pat_app
ResultsViewer Browse and plot EnergyPlus Sqlite time series data resultsviewer
RunManager Run and monitor multiple simulation workflows runmanager_app