Skip to content

Releases: NREL/OpenStudio

OpenStudio v3.6.0

09 May 16:10
@tijcolem tijcolem
v3.6.0
860f5de
Compare
Choose a tag to compare
OpenStudio v3.6.0

OpenStudio Version 3.6.0

Release Notes - 05/09/2023

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.6.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.6.0 is supported on:

  • 64-bit Windows 7 – 11
  • macOS: 10.15+ x86_64, 12.1+ arm64
  • Ubuntu: 20.04 x86_64, 22.04 x86_64, 22.04 arm64
  • Centos7

OpenStudio SDK 3.6.0 supports EnergyPlus Release 23.1.0, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.6.0.

OpenStudio SDK 3.6.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.6.0.

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2021-2022 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply re-run the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/.

OpenStudio SDK: Changelog

The 3.6.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window.

pip install openstudio==3.6.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at openstudio on TestPyPi to install development bindings.

You can also refer to the OpenStudio SDK Python Binding Version Compatibility Matrix to see the list of supported platforms and python versions.

New Features, Major Fixes and API-breaking changes

  • #4719,#4721 - Phase 2 support to run Python based measures. This functionality is still experimental and can only be accessed from the CLI using the experimental labs subcommand. Phase 2 now allows users to run both a Python and Ruby measure in the same workflow. To explore the various new options this new feature has to offer, you can access the help menu openstudio labs --help Also, to help jump start python measure development, included in the installation are example .osw workflow files that contain Python, Ruby and Python+Ruby based workflows that can be ran using the labs subcommand. For instance, the following will run a Ruby + Python based workflow: openstudio labs run -w ./Examples/compact_osw/compact_ruby_and_python.osw

  • #4778 - Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR

    • ZoneHVAC:TerminalUnit:VariableRefrigerantFlow has API-breaking changes related to setters and getters for its heating and cooling coils. They now use HVACComponent instead of the more restrictive CoilHeatingDXVariableRefrigerantFlow and CoilCoolingDXVariableRefrigerantFlow.
    • AirConditionerVariableRefrigerantFlow::clone was changed to stop cloning the child Curve objects (20 of them)

  • #4740 - Fix issues around ScheduleFixedInterval

    • A minor API breaking change: intervalLength/setIntervalLength now return/accept an int rather than a double to conform to the IDD type \integer
    • Translated daily schedules start on correct day
    • Leap day is no longer ignored on translation
    • Interval no longer restricted to one day or less

  • #4813 - Wrap SolarCollectorPerformance:PhotovoltaicThermal:BIPVT

    • SolarCollectorFlatPlatePhotovoltaicThermal has API-breaking changes in the solarCollectorPerformance getter due to the addition of this new object: it used to return a SolarCollectorPerformancePhotovoltaicThermalSimple (the only performance object at the time), now it's a ModelObject.

  • #4717 Update GroundHeatExchangerHorizontalTrench: wrap Site:GroundTemperature:Undisturbed:XXX objects

    • Wrap Site:GroundTemperature:Undisturbed:KusudaAchenbach and Site:GroundTemperature:Undisturbed:Xing objects
    • Update GroundHeatExchanger:HorizontalTrench to actually use the Ground Temeprature Model field

  • #4532 Performance improvements

  • #4800,#4844 Update to v23.1.0 EnergyPlus

  • #4808 Wrap OutputControl:Timestamp

  • #4825 add Coil:UserDefined

  • #4806 Wrap Gas-Fired Absorption Heat Pump (GAHP)

    • Wrap HeatPump:AirToWater:FuelFired:Heating and HeatPump:AirToWater:FuelFired:Cooling objects
    • The objects define an equation-fit fuel-fired absorption heat pump, based on manufacture-provided performance curves and testing/modeling methods
    • The GAHP is a combined space heating and domestic hot water solution, especially for cold climates. It can serve as heat sources for plant loops of space heating coils, hydronic radiators, DHW water heaters, and low-temperature space heating floors or TABS systems. Driven by gas heat or other types of fuel heat, the equipment can consume very little electricity and can have a much higher overall COP than conventional fuel-combustion type boilers or water heaters.

  • #4799 Add Fuel-related Methods from OpenStudio-Standard

  • #4857 Schedule:File ctor with path

    • Introduce new ScheduleFile constructor with path instead of ExternalFile argument

  • Support Ubuntu 22.04 and remove 18.04

Minor changes and bug fixes

  • #4828 - Fix Space load-based actuator for spaces are named ba...
Read more

Contributors

wenyikuang
Assets 19

OpenStudio v3.5.1

29 Dec 21:37
@tijcolem tijcolem
v3.5.1
22e1db7
Compare
Choose a tag to compare
OpenStudio v3.5.1

What's Changed

  • Windows arg parsing in #4779
  • Fix #4767 - Preserve order of Component objects during VersionTranslation in #4768
  • Bump to 3.5.1 and add default VT in #4752
  • Fix #4741 - Python binding version on mac with GitHub Actions in #4742
  • Fix #4758 - Download component from BCL is broken in 3.5.0in #4759
  • Fix #4754 - Cloning an object that uses a TableLookup into another model doesn't bring the ModelObjectList and IndependentVariables in #4755
  • Fix #4756 - Update OS:ComponentData during VersionTranslation in #4757
  • Support "No Load Supply Air Flow Rate Ratio" on UnitarySystemPerformance:Multispeed in #4749
  • Ruby gem addressable needs unicode.data. by in #4751
  • Fix #4761 - Cleanup temporary directory when doing Schematron XMLValidation by #4762
Assets 14

OpenStudio v3.5.0

10 Nov 16:30
@tijcolem tijcolem
v3.5.0
7b14ce1
Compare
Choose a tag to compare
OpenStudio v3.5.0

OpenStudio Version 3.5.0

Release Notes - 11/10/2022

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.5.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.5.0 is supported on 64-bit Windows 7 – 11, OS X 10.15, Ubuntu 18.04, 20.04 and Centos7

OpenStudio SDK 3.5.0 supports EnergyPlus Release 22.1.0, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.5.0.

OpenStudio SDK 3.5.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.5.0.

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2021-2022 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply re-run the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/.

OpenStudio SDK: Changelog

The 3.5.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window.

pip install openstudio==3.5.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at openstudio on TestPyPi to install development bindings.

You can also refer to the OpenStudio SDK Python Binding Version Compatibility Matrix to see the list of supported platforms and python versions.

New Features, Major Fixes and API-breaking changes

  • #4689,#4702,#4694,#4674,#4641,#4688,#4653 - Phase 1 support to run Python based measures.
    • Currently, this functionality is experimental and can only be accessed from the CLI using the experimental labs subcommand. This also includes a redesigned help menu (openstudio labs --help) to explore the various new options this new feature has to offer.
    • Included in the installation are example .osw workflow files that contain Python based measures that can be ran using the labs subcommand. For instance, the following will run a python based workflow: openstudio run -w ./Examples/compact_osw/compact_python_only.osw
    • For this release, only Python or Ruby can be ran in a single workflow file. Running both Python and Ruby support is planned for the next phase 2 installment in v3.6.0
  • #4600 - Phase 1 support to run Python EMS plugin using OpenStudio.
  • #4623 - FloorspaceJS to OpenStudio direct reverse translator vs the 3-way process of converting FloorspaceJS to ThreeJS to OSM.
  • #4571 - Metadata mapped to GLTF data object at export. Allows users to view metadata in a glTF capable browser.
  • #4587 - Error handling and gbXML schema validation when running gbXML based workflows.
  • #4616 - Addresses #4611, allow non-Quadratic curves for the EIR-f-PLR for the Chiller:Electric:EIR object
    • Chiller:Electric:EIR has a few API-breaking changes related to its Curves. The types for the constructor, getters and setters used to be explicit (eg: CurveBiquadratic): it is now the base class, more generic, Curve type for added flexibility.
  • #4642 - Addresses #4575, API change for EvaporativeCoolerFluid:SingleSpeed
    • EvaporativeCoolerFluid:SingleSpeed has an API-breaking change related to its performanceInputMethod getter. It is now a required field that returns std::string instead of boost::optional<std::string>.
  • #4644 - Addresses #4575, API change for Coil:Cooling:DX:SingleSpeed and Coil:Cooling:DX:TwoSpeed
    • Coil:Cooling:DX:SingleSpeed and Coil:Cooling:DX:TwoSpeed have API-breaking changes related to many of their getters. They are now required fields that return double instead of boost::optional<double>. Also removes many deprecated methods.
  • #4632 - Remove deprecated methods for AirWallMaterial, Node, SizingSystem, ZoneAirMassFlowConservation
    • Removes the deprecated AirWallMaterial class completely, in favor of ConstructionAirBoundary
    • Removes functions in Node that have been deprecated for 9+ years
    • Removes deprecated methods in the SizingSystem, ZoneAirMassFlowConservation, PlantLoop & AirLoopHVAC, AvailablilityManagerNightCycle, ZoneVentilationDesignFlowRate classes
    • Refer to the CSV file at developer/ruby/deprecated_methods.csv for more information
  • #4665 - Deprecate methods on Coil DX objects
    • Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:MultiSpeed:StageData, and Coil:Cooling:DX:CurveFit:Speed: ratedEvaporatorFanPowerPerVolumeFlowRate and setRatedEvaporatorFanPowerPerVolumeFlowRate in favor of ratedEvaporatorFanPowerPerVolumeFlowRate2017 and setRatedEvaporatorFanPowerPerVolumeFlowRate2017
    • Coil:Heating:DX:SingleSpeed and Coil:Heating:DX:MultiSpeed:StageData: ratedSupplyFanPowerPerVolumeFlowRate and setRatedSupplyFanPowerPerVolumeFlowRate in favor of ratedSupplyFanPowerPerVolumeFlowRate2017 and setRatedSupplyFanPowerPerVolumeFlowRate2017
  • #4666 - Changes related to availability schedule methods
    • Coil:Heating:Gas:MultiStage has an API-bre...
Read more
Assets 15

OpenStudio v3.4.0 vcomp fix (Windows Installer Only)

07 May 14:42
@tijcolem tijcolem
v3.4.0-vcomp
9e989db
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
OpenStudio v3.4.0 vcomp fix (Windows Installer Only) Pre-release
Pre-release

This is an update to the v3.4.0 Windows installer that includes vcomp140.dll for EnergyPlus. This dll is a pretty common library that gets installed alongside with various software so many systems likely already have this (i.e. Windows 2019 server edition), but some bare bones Windows versions may not and will hit the error mentioned on #4581

Contributors

jmarrec
Assets 4

OpenStudio v3.4.0

05 May 13:44
@tijcolem tijcolem
v3.4.0
4bd816f
Compare
Choose a tag to compare
OpenStudio v3.4.0

OpenStudio Version 3.4.0

Release Notes - 05/05/2022

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.4.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.4.0 is supported on 64-bit Windows 7 – 10, OS X 10.15, and Ubuntu 18.04, 20.04

OpenStudio SDK 3.4.0 supports EnergyPlus Release 22.1.0, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.4.0.

OpenStudio SDK 3.4.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.4.0.

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply re-run the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/.

OpenStudio SDK: Changelog

The 3.4.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window. 

pip install openstudio==3.4.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at https://test.pypi.org/project/openstudio/ to install development bindings.

New Features, Major Fixes and API-breaking changes

  • #4560, #4540 - Update to EnergyPlus v22.1.0
  • #4550 - Addresses #4403, add Sql helper methods to retrieve assembly U-factor, SHGC, and Visible Transmittance values for glazing systems
  • #4456 - Fix #4456 - Improve performance of OpenStudio::UnzipFile::extractAllFiles
  • #4424 - Fixes #4361 OpenStudio API-reported surface "netArea" (when dealing with Frame & Divider objects)
  • #4502 - #4496 - Add gems cbor and msgpack and allow using a package from an openstudio-gems PR
  • #4497 - Addresses #4495, ElectricLoadCenterDistribution FT has incomplete charge/discharge logic
  • #4494 - Addresses #4483, OS:Coil:Heating:DX:MultiSpeed:StageData has no Name field
  • #4499 - Addresses #4410, wrap AirflowNetwork:MultiZone:SpecifiedFlowRate
  • #4510 - Addresses #4509, bad nodes created for AirLoopHVAC:UnitarySystem with only cooling coil and supplemental heating coil
  • #4508 - Addresses #4469, method to reverse translate the EnergyPlus ScheduleYear object to the OpenStudio ScheduleRuleset object
  • #4525 - Fixes #4387 gltf changes as per PR 4520 comments/suggestions
  • #4485 - Fixes #4438 gbXML export order is not reproducible
  • #4444 - Fixes #4375 gbXML Import reverses floors/ceilings normals and surface types
  • #4527 - Fixes #4372 intersection issue found using create bar
  • #4535 - Fixes #4533 - Wrap SurfaceProperty:LocalEnvironment and SurfaceProperty:SurroundingSurfaces
  • #4513 - Addresses #4457, support gbXML reverse translation where user-input <Name> is different from the ID
  • #4534 - Addresses #4311, add water heaters (mixed or stratified) to the supply side of different plant loops using source/use side connections (e.g., to configure a heat recovery chiller)
  • #4528 - Cooling tower fixes (ctor for SingleSpeed, and missing IDD defaults) and model tests
  • #4520 - Adds exports functionality to a use web standard glTF to replace deprecated three.js JSON format
  • #4548 - Addresses #4531, breaking changes for some model getters:
    • CoolingTower:*Speed
      • evaporationLossMode (boost::optional<std::string> to std::string)
      • blowdownCalculationMode (boost::optional<std::string> to std::string)
      • cellControl for CoolingTower:VariableSpeed
    • PlantLoop
      • commonPipeSimulation (boost::optional<std::string> to std::string)
      • add new methods: isCommonPipeSimulationDefaulted, commonPipeSimulationValues, and validCommonPipeSimulationValues
  • #4505 Addresses #4477, improve handling of invalid values passed to SDK by adding optional switch for turning off IDD validity checking
  • #4504 Fix #2941 - Add option to show workflow run stdout + style + timings

Minor changes and bug fixes

  • #4487 - Add operator< for BCLComponent and BCLMeasure
  • #4482 - Fix #4481 - add missing \ip-units W to the OpenStudio.idd
  • #4491 - Fix #4490 - Expose RoofGeometry helpers to Swig bindings
  • #4498 - Bump to 3.3.1 and add default VT
  • #4474 - Better string representation of Matrix and Transformation in the bindings
  • #4475 - Add a method on the FT to get known ft options
  • #4512 - Update copyrights 2022
  • #4537 - Review PR #4534 (f...
Read more

Contributors

Brijendra21
Assets 13

OpenStudio v3.3.0

05 Nov 17:58
@tijcolem tijcolem
v3.3.0
ad235ff
Compare
Choose a tag to compare
OpenStudio v3.3.0

OpenStudio Version 3.3.0

Release Notes - 11/05/2021

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.3.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.3.0 is supported on 64-bit Windows 7 – 10, OS X 10.15, and Ubuntu 18.04, 20.04

OpenStudio SDK 3.3.0 supports EnergyPlus Release 9.6, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.3.0.

OpenStudio SDK 3.3.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.3.0.

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply re-run the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/.

OpenStudio SDK: Changelog

The 3.3.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window.

pip install openstudio==3.3.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at https://test.pypi.org/project/openstudio/ to install development bindings.

New Features, Major Fixes and API-breaking changes

  • #4406 - Update to EnergyPlus v9.6.0_PlusSpaceFix1
    • Experimental Support for the EnergyPlus 9.6.0 space concept was added
      • This feature is currently opt-in, either by manually calling ForwardTranslator::setExcludeSpaceTranslation(false) before calling ForwardTranslator::translateModel(Model&) or passing the CLI argument --space-translation to the run method (eg: openstudio run --space-translation -w workflow.osw)
      • A few limitations due to DaylightingControls/IlluminanceMap exist: in case one of these objects is found in a ThermalZone, spaces will be combined for that ThermalZone (historical behavior)
      • #4471 - Space PR: adjustments to make DaylightingControls work
      • #4434 - Addresses #4409, forward translate Space
      • #4447 - Add ForwardTranslator options to the CLI run method
      • #4465 - [Developer] Refactor Forward Translation of ThermalZone in particular for Space translation PR
    • Note: EnergyPlus due to the Space feature now enforces unicity of names within the Zone, Space, ZoneList and SpaceList objects. As a result, we are now enforcing this in the openstudio::model namespace: the same name can no longer be used for objects of type ThermalZone, Space, SpaceType.
  • #4350 - Fix #3599 - Add new fields to control outdoor air for AirTerminalSingleDuctInletMixer
  • #4365 - Addresses #4364, Availability Schedule for DaylightingControl
  • #4342 - Fix #4327 - FanSystemModel electricPowerFraction should be optional
  • #4368 - Addresses #4362, add support of HeatPump:PlantLoop:EIR:Heating and HeatPump:PlantLoop:EIR:Cooling to model air-to-water heat pump
  • #4382 - Addresses #4380, completing SDK support of Tubular and Light Well Daylighting Devices
  • #4381 - Addresses #3906, support new field 'Minimum Air Flow Turndown Schedule Name' for AirTerminals
  • #4407 - Add AirLoopHVAC to ThreeJS user data by @antoine-galataud
  • #4402 - Addresses #3910, realign OS:SizingPeriod:DesignDay with E+ IDD
  • #4417 - Fix #4156 - Support nested subfolders in approved Measure directories
  • #4452 - Fix #4448 - Issues with angles in DaylightingControl
  • #4317 - Addresses #3147, add HeatExchanger:Desiccant:BalancedFlow
  • #4326 - Fix Wrap E+ WaterHeater:Sizing object
  • #4319 - Fix Wrap E+ FuelFactors object
  • #4418 - Resolves #4395 Add in CLI option to use epJSON
  • #4347 - Fix #227 - Actually use the EPW start year or start day of week when "UseWeatherFile" is used in YearDescription for assumedYear
    • Please note that before, while the IDD default was UseWeatherFile, it would typically use the Assumed Base Year instead (2009) which resulted in using Thursday as a Start Day of Week for simulation. Depending on your weather file, you might experience a different Start Day of Week which could lead to slight EUI deviations. More information can be seen on NREL/OpenStudio-resources#153
  • #4389 - Update BCL to use BCL2 (https://bcl2.nrel.gov/)

Minor changes and bug fixes

  • #4349 - Fix #3514 - Make strings returned from openstudio to ruby UTF8
  • #4346 - Addresses #4329 and #4330, issues with AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass
  • #4356 - Fix #4353 - Add a missing reference in E+ Idd for PythonPlugin:Instance (ProgramNames)
  • #4355 - Fix #4354 - Issue AirLoopHVACOutdoorAirSystem...
Read more

Contributors

antoine-galataud
Assets 11

OpenStudio v3.2.1

25 Jun 14:06
@tijcolem tijcolem
v3.2.1
bdbdbc9
Compare
Choose a tag to compare
OpenStudio v3.2.1

OpenStudio Version 3.2.1

Changes since 3.2.0

  • #4307 - Standardize Curve IDD references like E+ does (Uni/Bi...variateFunctions) and remove hard check in model code
  • 4337 - Fix Encode searchTerm in BCL (including spaces, not only "+" signs)
  • #4344 - Update openstudio-gems for new versions of measure-tester-gem (v0.3.1), openstudio-extension-gem (v0.4.3), openstudio-workflow-gem (v2.2.1) and openstudio-standards (v0.2.14).
  • #4332 - Fix StringHelpers openstudio::replace
  • #4326 - Fix Wrap E+ WaterHeater:Sizing object
  • #4324 - FIx Do not Warn if Sql doesn't have a Year field
  • #4319 - Fix Wrap E+ FuelFactors object
  • #4302 - Fix Deprecation Warning of last argument as keyword parameters

OpenStudio Standards v0.2.14

  • Added comstock 2016 and 2019 templates
  • Fixed a coil reference for radiant systems
  • Fixed a method name compatibility issue for VAV terminals for OS v3.0.0 and earlier
  • Adjusted radiant fractions for lighting to better reflected lighting fractions in newer lighting technology
Assets 11

OpenStudio v3.2.0

04 May 17:11
@tijcolem tijcolem
v3.2.0
e11f0a0
Compare
Choose a tag to compare
OpenStudio v3.2.0

OpenStudio Version 3.2.0

Release Notes - 05/04/2021

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.2.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.2.0 is supported on 64-bit Windows 7 – 10, OS X 10.14 – 10.15, and Ubuntu 18.04, 20.04

OpenStudio SDK 3.2.0 supports EnergyPlus Release 9.5, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.2.0.

OpenStudio SDK 3.2.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.2.0.

OpenStudio SDK 3.2.0 now uses Ruby 2.7.2 as the supported version (2.5.5 previously in the 3.x series, and 2.2.4 for 2.x series).

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply rerun the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/.

OpenStudio SDK: Changelog

The 3.2.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

Update to Ruby 2.7.2

OpenStudio SDK now comes with Ruby 2.7.2 (#4207) which provides many improvements over the previous version, v2.5.5, such as pattern matching, REPL improvement, compaction GC, separation of positional and keyword arguments, and security related improvements.

To see the full list of Ruby updates and improvements, please refer to the official ruby release notes.

Python Bindings

New for OpenStudio SDK is support for Python bindings ( #4122). OpenStudio users can now use the popular Python Programming language across supported platforms to interface with OpenStudio SDK. Users can install the bindings using the Python package tool called pip. To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window.

pip install openstudio==3.2.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at https://test.pypi.org/project/openstudio/ to install development bindings.

New Features, Major Fixes and API-breaking changes

A number of new features and API-breaking changes have been implemented in OpenStudio SDK 3.2.0:

  • #4271 - Update to EnergyPlus v9.5.0

    • Most of the actual changes were done in #4212 - Update to V9.5.0-IOFreeze

  • New objects:

    • #4155 - Wrap Humidifier:Stream:Gas in OS SDK
    • #4157 - Wrap ZoneHVAC:CoolingPanel:RadiantConvective:Water in OS SDK
    • #4159 - Wrap Refrigeration:ComporessorRack in OS SDK
    • #4186 - Wrap Chiller:Electric:ReformulatedEIR in OS SDK
    • #4192 - Wrap Generator:WindTurbine in OS SDK
    • #4193 - Wrap Fan:ComponentModel in OS SDK
    • #4194 - Wrap PhotovoltaicPerformance:Sandia in OS SDK
      • The recommended instantiation is via the factory methods GeneratorPhotovoltaic::sandia(const Model&) or GeneratorPhotovoltaic::fromSandiaDatabase(const Model&, const std::string& sandiaModulePerformanceName) where sandiaModulePerformanceName is one of keys in the now-embedded Sandia database. Please use the PhotovoltaicPerformanceSandia::sandiaModulePerformanceNames() static method to lookup the valid names.
    • #4225 - Wrap ElectricLoadCenter:Storage:LiIonNMCBattery in OS SDK
    • #4236 - Wrap CoilSystem:IntegratedHeatPump:AirSource and Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed in OS SDK
    • #4258 - Wrap ZoneInfiltration:FlowCoefficient in OS SDK.
      • This object is wrapped as SpaceInfiltrationFlowCoefficient and is a SpaceLoad

  • #4199 - Add support for translating a Workspace/IdfFile to epJSON

  • #4253 - Allow ZoneHVAC:TerminalUnit:VariableRefrigerantFlow to connect to AirLoopHVAC

  • #4180 - Fixes #4175, issues with ft for ElectricLoadCenter:Distribution

    • ElectricLoadCenterDistribution objects are now possible with no generators / transformers
    • A default ElectricLoadCenterDistribution is no longer instantiated in the constructor of children objects: GeneratorFuelCell, GeneratorMicroTurbine, GeneratorPhotovoltaic, GeneratorPVWatts

  • #4153 - Fix #3532 #4152 - Make heating/cooling coils optional for ZoneHVACLowTempVariableFlow and add missing fields to coils

    • This is an API breaking change, the coils are now optional so the getters have been modified to account for this.
    - HVACComponent heatingCoil() const;
+ boost::optional<HVACComponent> heatingCoil() const;
- HVACComponent coolingCoil() const;
+ boost::optional<HVACComponent> coolingCoil() const;

  • #4221 - Geometry improvements including fixing intersection issues

Minor changes:

  • #4136 - Fix #4125, Fix #4135 - GbXML ForwardTranslator: clear map&set, and add a modelToGbXMLString method
  • #4137 - Addresses #4076, radiant system enhancements
  • #4149 - Addresses #3706, add drain water heat exchanger methods to WaterUseConnections
  • #4188 - Fix #...
Read more
Assets 11

OpenStudio v3.1.0

16 Oct 23:19
@tijcolem tijcolem
v3.1.0
e165090
Compare
Choose a tag to compare
OpenStudio v3.1.0

OpenStudio Version 3.1.0

Release Notes - 10/16/2020

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.1.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.1.0 is supported on 64-bit Windows 7 – 10, OS X 10.14 – 10.15, and Ubuntu 18.04.

OpenStudio SDK 3.1.0 supports EnergyPlus Release 9.4, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.1.0.

OpenStudio SDK 3.1.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.1.0.

OpenStudio SDK 3.x now uses Ruby 2.5.5 as the supported version (2.2.4 previously).

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply rerun the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user- documentation/help/troubleshooting/.

OpenStudio SDK: Changelog

The 3.1.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

New Features, Major Fixes and API-breaking changes

A number of API-breaking changes have been implemented in OpenStudio SDK 3.1.0:

  • #3960 - Added support for building the C# bindings via dotnet CLI, including on Unix platforms
  • #3966 - Closes #3945 - Support the EnergyPlus object SurfaceControl:MovableInsulation which can be used to add insulation surface(s) on top of opaque surfaces, such as a transparent coating that affects the radiative gains to a roof surface
  • #3959 - Also included some improvements in the generated C# bindings by reducing build warnings and properly exposing some types via SWIG
    • ScheduleTypeKey (which is normally only use by OpenStudio internals in ScheduleTypeRegistry checks) previously mapped to a std::pair<std::string, std::string> which was SWIGed in ruby as an Array of strings of size two, but improperly exposed in C#. It now uses a dedicated helper class with two methods ScheduleTypeKey::className() and ScheduleTypeKey::scheduleDisplayName()
  • #3987 - Closes #3907 - Support new Coil:Cooling:DX, Coil:Cooling:DX:CurveFit:Performance, Coil:Cooling:DX:CurveFit:OperatingMode, Coil:Cooling:DX:CurveFit:Speed objects
  • #4009 - Closes #4006 - Add SwimmingPool:Indoor to SDK
  • #4050 - Fixes #3921 - Some children of RefrigerationSystem can be added several times and produce a fatal when System is removed
    • RefrigerationSystem will now be enforcing unicity for all children. This was already the case for a few of the child objects such as Case and WalkIns, it is now the case for all objects (RefrigerationCondenserCascade, RefrigerationSubcoolerMechanical and RefrigerationSubcoolerLiquidSuction, etc.). What this means is that setter methods (or add methods in case of a list) will remove the child for any current RefrigerationSystem it is on first.
  • #4066 - Multiple shading controls referenced by a single subsurface
    • SubSurface was historically the one referencing the ShadingControl object. Now it's a many-to-many relationship where ShadingControl has an extensible 'Sub Surface Name' field, and multiple ShadingControl objects can reference the same SubSurface. This is trickling down from a change introduced in EnergyPlus version 9.4, and specifically in PR NREL/EnergyPlus#8196
    • Methods in SubSurface have been deprecated but are kept for backward compatibility. They will be removed in a future version of OpenStudio:
      • shadingControl(): prefer shadingControls()
      • setShadingControl(ShadingControl&): use addShadingControl(SubSurface&), addShadingControls(std::vector<SubSurface>&) or setShadingControls(std::vector<SubSurface>&)
      • resetShadingControl(): use removeAllShadingControls() instead
    • All Shading Control Type values should now be supported. Refer to issue #4074 for more information
    • Fields 'Glare Control Is Active', 'Type of Slat Angle Control for Blinds', 'Slat Angle Schedule Name', 'Setpoint2', and 'Multiple Surface Control Type' are now implemented as well
  • #4026 - Fix OpenStudio Windows crashed during save attempt
  • #4028 - Fixes #3835 - Decrease overall load time of CLI and lazy load OpenStudio ruby bindings when possible
  • #4059 - Add new OutputControl:Files object to SDK, which allows conditionally turning on/off output from EnergyPlus
  • #4101 - Update EnergyPlus v940 official

Minor changes:

  • #3961 - Update cmake to use included FindPython method and fix zlib's crypt.h
  • #3970 - Update conan dependency fmt/6.2.0 and use option to define FMT_HEADER_ONLY
  • #3979, #4004, #4071 - Update openstudio-gems to include openstudio-extension v0.3.0, openstudio-workflow v2.1.0, openstudio-standards v0.2.12, openstudio_measure_tester v0.2.3
  • #4015, #4047- Updates the conan dependencies to try and pin version using hash
  • #4027 - Include 64/32 bit universal nuget package in cmake build process.
  • #4029 - Closes [#3832](https://github.com/...
Read more
Assets 8

OpenStudio v3.0.1

26 Jun 18:22
@tijcolem tijcolem
v3.0.1
09b7c8a
Compare
Choose a tag to compare
OpenStudio v3.0.1 
tag and release 3.0.1
Assets 8