OpenStudio v1.1.1

Merge branch 'develop' into 20131021_ETH_BugFixes

OpenStudio v1.1.0

These release notes describe version 1.1.0 of the OpenStudio software suite developed by the National Renewable Energy Laboratory (NREL), Buildings and Thermal Systems, Commercial Buildings Research Group, Tools Development Section, and associated collaborators. The notes are organized into the following sections:

• Where to Find OpenStudio Documentation
• Installation Notes
• Overview
• New Features
• Known Issues

Where to Find OpenStudio Documentation

• OpenStudio release documentation, including these release notes, tutorials, and other user documentation, is available at http://openstudio.nrel.gov/documentation.
• C++ API documentation is available at http://openstudio.nrel.gov/sdk-documentation.
• Measure writing documentation is available at http://openstudio.nrel.gov/openstudio-measure-writing-guide
• OpenStudio Life Cycle Costing Examples are available at http://openstudio.nrel.gov/openstudio-life-cycle-examples

Installation Notes

OpenStudio is supported on Windows XP – 8.1, OS X 10.7 – 10.8, and Ubuntu 12.04.

Installation Steps

• Download and install EnergyPlus 8.0.
  • Download EnergyPlus 8.0. Create an account and login if you don’t already have one.
  • OpenStudio will work with 32 or 64bit EnergyPlus installers.
• The OpenStudio SketchUp Plug-in requires Sketchup 8.0 or SketchUp 2013 (not available for Linux).
• Create an OpenStudio account, then download and install OpenStudio.
• Setup a Building Component Library (BCL) account to access online building components and measures. View instructions on how to setup your account and configure the key in OpenStudio.

Optional Installation Steps

• For Radiance integration, download and install Radiance.
• If you plan to use the OpenStudio SDK Ruby bindings via command prompt on Windows, download and extract ruby.zip to C:\Ruby (or other desired location), and add C:\Ruby\bin to the PATH environment variable.

Overview

OpenStudio 1.1.0 adds support for manual calibration of simulation results from monthly utility data. A new reporting measure type was introduced that has access to input data and simulation results that can be used to create custom reports and to perform automated quality control checks. Another major new feature is simulation using cloud computing resources through Amazon EC2. Users first set up an account with Amazon and link it to OpenStudio. The ParametricAnalysisTool (PAT) can then be used to run simulations locally or on Amazon EC2. This feature is still under active development to improve process connection and performance, and users are strongly urged to carefully review all disclaimer text and provided EC2 monitor web links in the cloud configuration dialogs. This version of OpenStudio also adds support for EnergyPlus 8.0 along with a number of new HVAC components.

New Features

OpenStudio Platform 1.1.0

• Added support for EnergyPlus 8.0.
• Added a new calibration feature that compares monthly utility data to simulation results. Users should use an actual meteorological year (AMY) weather file for best results.
• Added support for reporting measures that can process model inputs and simulation outputs as part of a workflow.
• Added back-end support for parallel simulation using Vagrant and Amazon EC2 instances. This feature is still under active development to improve performance and stability of distributed computing resources. Simulations in PAT may still be run locally as well.

OpenStudio SketchUp Plug-in 1.1.0

• Improved general performance, stability, and usability.
• Added shading controls for sub-surfaces.
• Added experimental user script to convert SketchUp groups to OpenStudio spaces.

OpenStudio Application 1.1.0

• Improved general performance, stability, and usability.
• Added Utility Bills Sub-tab in support of new calibration feature.
• New HVAC Components (Contributed by Oak Ridge National Laboratory)
  • GroundHeatExchangerVertical - Enables support for ground source heat pumps EvaporativeFluidCoolerSingleSpeed.
  • AirTerminalSingleDuctVAVNoReheat
  • AirTerminalSingleDuctConstantVolumeReheat
• New HVAC Components (Contributed by Group 14)
  • In-slab radiant heating/cooling, including water and electric resistance.
  • Chilled beams, both passive and active.
• Simplified measures library to show OpenStudio, EnergyPlus, and new Reporting measures side by side.
• Added calibration view to Results tab to view utility data side by side with simulation results.

OpenStudio ParametricAnalysisTool 1.1.0

• Simplified measures library to show OpenStudio, EnergyPlus, and new Reporting measures side by side.
• Added several additional Energy Conservation Measures to the Building Component Library, accessible through PAT and the OpenStudio application.
• Added Cloud Settings, Cloud Monitor, and a diagnostic dialog in support of simulations using the Amazon EC2 cloud computing service. Once the user creates an Amazon account and links to it from OpenStudio, OpenStudio can provision and distribute simulations across a user-selected number of EC2 instances.
• The Run tab was redesigned in support of simulations using cloud computing services. This includes a number of new interface elements and characteristics described below.
  • A cloud status button to display and alter the cloud state.
  • Design alternatives can now be selected and deselected for simulation. This can be accomplished by clicking on them individually, or by using the “Select All” and “Clear Selection” buttons. Previously there was no selection mechanism, and all design alternatives had to be run.
  • When a cloud instance is running, there is a new column to choose which design alternatives’ detailed simulation results should be downloaded upon completion. You can select these individually or select all, being mindful that simulation results can be quite large.
  • There is similar functionality to individually or globally clear simulation results.
• A button to download the highlighted design alternatives’ detailed simulation results was added to the Results tab.

OpenStudio RunManager 1.1.0

• No changes.

OpenStudio ResultsViewer 1.1.0

• No changes.

OpenStudio Ruby Bindings 1.1.0

• No changes.

OpenStudio C# Bindings 1.1.0

• No changes.

OpenStudio Python Bindings 1.1.0

• No changes.
• Python bindings are not packaged with OpenStudio. To use them see our developer page for guidance on building OpenStudio.

OpenStudio JavaScript V8 Bindings 1.1.0

• No changes.
• JavaScript bindings are not packaged with OpenStudio. To use them see our developer page for guidance on building OpenStudio.

Known Issues

The following are issues known at the time of publication of these release notes. Please contact [email protected] if you require further assistance.

Known Issues Common to All Platforms

OpenStudio SketchUp Plug-in

• If you use copy multiple on group-level OpenStudio objects, you will get one extra copy. The extra group is created by the first copy-and-paste operation and is not removed when the copy multiple occurs. To address this, after you perform a copy multiple procedure on groups or spaces, press delete. The objects you need to delete should already be selected. If you are copying loose surfaces such as windows, there are no problems, as SketchUp will merge equivalent surfaces. [issue #28]
• Using SketchUp's undo operation on OpenStudio model elements may produce unexpected results. [issues #54 and #150]
• SKP and OSM link is not maintained when files are relocated. You can manually re-establish that link. When opening a SketchUp file Launch SketchUp and then Open the SketchUp file. If that doesn't work you can also directly load the OSM file, bypassing the SKP file. [issue #409]
• It is possible for the OpenStudio Plug-in to conflict with other SketchUp plug-ins. If you suspect this is a problem, try testing with other plug-ins disabled, or contact [email protected] for assistance. [issue #26]
• Importing Constructions and Import Schedules from the OpenStudio SketchUp Plug-in are broken, but you can load an OSM file as library in the OpenStudio application and then selectively drag specific objects into your model. [issue #201]
• Using "Intersect" in the surface matching dialog can result in a crash or unexpected result. This is more common with models that were imported from other CAD formats at some point in the workflow. It is a good idea to save prior to using this to avoid any loss of data. This is related to an underlying SketchUp bug. [issue #168]
• "Project Loose Geometry" can crash SketchUp. It is a good idea to save prior to using this to avoid any loss of data. [issue #484]
• If your OpenStudio model crashes SketchUp or has unexpected behavior please forward it to [email protected] with a description of the problem. Please also include the directory that has the same name as the OSM file. You can attach it as a zip file.

OpenStudio Application

• When going to the Site / Utility Bills subtab after setting up the prerequisite objects you will see an object that can't be edited. That isn't a real object. To add your first object switch away from the "Electric Utility Bill" category at the left, and then click the green "+" to create a new object. [issue #577]
• The Site / Utility Rates subtab the workflow are marked as "coming soon," and will be completed in an upcoming release of OpenStudio.
• To enable set point schedule drop zones on the Therma...

OpenStudio v1.0.7

Merge branch 'develop' of https://github.com/NREL/OpenStudio into dev…

OpenStudio v1.0.6

Fix scan depth. This bug was caused by the re-write of ToolFinder.cpp

@axelstudios this fixes both the installed and debug builds on my tests

@rpg777 While I was in there, I also now ignore ruby provided by DAYSIM, solving some support issues for you.

OpenStudio v1.0.5

Translate PTAC fan operating mode.

OpenStudio v1.0.4

Fix Apple installer issue related to updates

Apple's PackageMaker supports "reloctable" bundles which was preventing
app bundles from going in the expected location.  This is the proposed
fix.

OpenStudio v1.0.3

Fixing Issue #436. OSArgument::valueAsBool was being called without f…

OpenStudio v1.0.2

Fixing a reference to EnergyPlus 7.2

This causes OpenStudio's run tab to always say that EnergyPlus 8.0 has not been found, even if it has.

OpenStudio v1.0.1

Modifying app resource files to ignore non-numeric build string

[#53337061]

OpenStudio v1.0.0

These release notes describe a particular version of the OpenStudio software suite developed by the National Renewable Energy Laboratory (NREL), Electricity, Resources, and Building Systems Integration Center (ERBSIC), Commercial Buildings Research Group, Tools Development Section, and associated collaborators. The notes are organized into the following sections:

• Where to Find OpenStudio Documentation
• Installation Notes
• Overview
• New Features
• Known Issues

Where to Find OpenStudio Documentation

• OpenStudio release documentation, including these release notes, tutorials, and other user documentation is available at http://openstudio.nrel.gov/documentation.
• C++ API documentation is available at http://openstudio.nrel.gov/sdk-documentation.
• Measure writing documentation is available at http://openstudio.nrel.gov/openstudio-measure-writing-guide
• OpenStudio Life Cycle Costing Examples document is available at http://openstudio.nrel.gov/openstudio-life-cycle-examples

Installation Notes

OpenStudio is supported on Windows XP – 7, OS X 10.7 – 10.8, and Ubuntu 12.04.

Installation Steps

• Download and install EnergyPlus 7.2. The main EnergyPlus page takes you to EnergyPlus 8. Follow the steps below to download EnergyPlus 7.2
  • Create an EnergyPlus account if you don't have one and then login.
  • After you log in you can click the link to access the page to "Download Older Versions of Energy Plus".
  • Choose the appropriate version of EnergyPlus 7.2 for your computer. Download and follow the instructions. OpenStudio will work with 32 or 64bit EnergyPlus installers.
• The OpenStudio SketchUp Plug-in requires Sketchup 8.0 or SketchUp 2013 (not available for Linux).
• Create an OpenStudio account, then download and install OpenStudio.
• Setup a Building Component Library (BCL) account to access online building components and measures. View instructions on how to setup your account and configure the key in OpenStudio.

Optional Installation Steps

• For Radiance integration, download and install Radiance.
• If you plan to use the OpenStudio SDK Ruby bindings via command prompt on Windows, download and extract ruby.zip to C:\Ruby (or other desired location), and add C:\Ruby\bin to the PATH environment variable.
• Install the DAKOTA algorithm library as described on the developer pages if you plan to run large-scale analyses with the Ruby bindings.
• Download and install the 32-bit OpenSSL libraries if you will be running simulations remotely through an SSH connection on Windows.

Overview

OpenStudio 1.0.0 adds life cycle cost objects to OpenStudio models and to energy conservation measures used in the Parametric Analysis Tool (PAT). In addition to being able to evaluate design alternatives based on energy use, users can now look at total life cycle costs, first year capital costs, annual utility savings, and simple payback. A new HVAC control view lets users set the operation time, night cycle operation, supply air temperature, economizer, and demand controlled ventilation for air loops. A major new category of HVAC equipment has been added with the introduction of an air to air heat recovery model, which can be used to model a variety of sensible and latent heat recovery devices.

New Features

OpenStudio Platform 1.0.0

• Added new model object LifeCycleCost for capturing capital and operating costs associated with building components and measures.
• Improved EnergyPlus IDF import and export. EnergyPlus export is now more repeatable and import is more stable.
• Improved consistency in the handling of multipliers throughout the OpenStudio model API.
• Suppressed erroneous log messages.
• All applications now catch thrown exceptions and report the error to the user before exiting or relaunching.
• BCL measures can now be updated to the latest version through the BCL dialog.
• Added and improved filesystem integration on Windows, Linux, and OS X, including imporoved installers.

OpenStudio SketchUp Plug-in 1.0.0

• Improved general performance and stability.
• Added OpenStudio SketchUp plug-in support for SketchUp 2013 (Pro and Make).
• Simplified plug-in user interface.
• gbXML import now handles files with malformed surfaces.
• Added "Export RPX File" for integration with the ASHRAE Radiant Performance Explorer human comfort tool. This can be found under "OpenStudio User Scripts / Reports".
• Improved default profiles on Ruleset Schedules.

OpenStudio Application 1.0.0

• Improved general performance, stability, and usability.
• Added a new "Controls" subtab for air loops in the "HVAC Systems" tab. This allows the user to set the HVAC operation schedules, night cycle, supply air temperature, economizer, and demand controlled ventilation.
• A major new category of HVAC equipment has been added with the introduction of an air to air heat recovery model, which can be used to model a variety of sensible and latent heat recovery devices.
• New HVAC Components
  • Water-to-air heat pumps
  • Water and electric baseboard heaters
  • Demand controlled ventilation
  • Night cycling
  • Air-to-air energy recovery
  • Constant volume pumps
  • Outdoor air based reset control strategy for air and water loops
  • Unit heaters
• Replaced "Scripts" tab with "Measures" Tab that is consistent with the Parametric Analysis Tool.
  • Measures added to a model in this tab will be brought into the Parametric Analysis Tool if the model is chosen as a baseline.

OpenStudio ParametricAnalysisTool 1.0.0

• Measures are now downloaded from the Building Component Library instead of being included in the installer. Users can download new measures as they are posted, and get updates to existing measures without having to install an update to OpenStudio.
  • If a new measure makes use of features added in a later version of OpenStudio then you will have to update OpenStudio if you want to use that particular measure.
• Updated measures now include inputs to support new life cycle analysis object in OpenStudio. Measures can add life cycle objects or manipulate objects that already exist. The following are some common inputs introduced, although specific inputs will vary from measure to measure.
  • Material and Installation Cost
  • Years Until Costs Start (number of years left until due to be replaced)
  • Demolition Cost Occur During Initial Construction (true/false)
  • Expected Life
  • O&M Costs
  • O&M Frequency
• Added "Always Run Measures" that operate on the baseline model as well as each design alternative.
  • These measures can run at various stages defined by where the user places them relative to the measure groups in the project.
  • Some measures added to the Building Component Library that were designed to be used as "Always Run Measures" are under "Economics -> Life Cycle Cost Analysis". Many of these add life cycle costs to objects in the model.
• Added new columns to the "Reports" tab to show First Year Capital Cost, Annual Utility Cost, Simple Payback, and Total Life Cycle Cost.

OpenStudio RunManager 1.0.0

• No changes.

OpenStudio ResultsViewer 1.0.0

• No changes.

OpenStudio Ruby Bindings 1.0.0

• No changes.

OpenStudio C# Bindings 1.0.0

• No changes.

OpenStudio Python Bindings 1.0.0

• Added experimental bindings.

OpenStudio JavaScript V8 Bindings 1.0.0

• Added experimental bindings.

Known Issues

The following are issues known at the time of publication of these release notes. Please contact [email protected] if you require further assistance.

Known Issues Common to All Platforms

OpenStudio SketchUp Plug-in

• If you use copy multiple on group-level OpenStudio objects, you will get one extra copy. The extra group is created by the first copy-and-paste operation and is not removed when the copy multiple occurs. To address this, after you perform a copy multiple procedure on groups or spaces, press delete. The objects you need to delete should already be selected. If you are copying loose surfaces such as windows, there are no problems, as SketchUp will merge equivalent surfaces. [bug 36]
• Using SketchUp's undo operation on OpenStudio model elements may produce unexpected results. [bugs 438 and 797]
• SKP and OSM link is not maintained when files are relocated. You can manually re-establish that link. When opening a SketchUp file Launch SketchUp and then Open the SketchUp file. If that doesn't work you can also directly load the OSM file, bypassing the SKP file. [bug 61]
• It is possible for the OpenStudio Plug-in to conflict with other SketchUp plug-ins. If you suspect this is a problem, try testing with other plug-ins disabled, or contact [email protected] for assistance. [bug 24]
• Importing Constructions and Import Schedules from the OpenStudio SketchUp Plug-in are broken, but you can load an OSM file as library in the OpenStudio application and then selectively drag specific objects into your model. [bug 930]
• Using "Intersect" in the surface matching dialog can result in a crash or unexpected result. This is more common with models that were imported from other CAD formats at some point in the workflow. It is a good idea to save prior to using this to avoid any loss of data. This is related to an underlying SketchUp bug. [bugs 856 and 1220]
• "Project Loose Geometry" can crash SketchUp. It is a goo...