Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
f6ea4a1
Start to update proposed idd.
Aug 21, 2025
aa1bb00
Merge branch 'develop' into v25.2.0-IOFreeze
Aug 25, 2025
29ebfd8
Update ft field name for CoilHeatingWaterToAirHeatPumpVariableSpeedEq…
Aug 25, 2025
7d58536
Add idd fields for SiteWaterMainsTemperature.
Aug 25, 2025
f00b904
Update model files for SiteWaterMainsTemperature.
Aug 25, 2025
db0e608
Update ft files for SiteWaterMainsTemperature.
Aug 25, 2025
8d88b89
Update vt files for SiteWaterMainsTemperature.
Aug 25, 2025
cd92d4c
Formatting.
Aug 25, 2025
d12f68a
Field name changes for CoilWaterHeatingAirToWaterHeatPumpVariableSpeed.
Aug 25, 2025
4d432fd
Merge branch 'v25.2.0-IOFreeze' into v25.2.0-IOFreeze-mains
Aug 25, 2025
4842230
Fix new method types.
Aug 25, 2025
1275d7c
Update field name in ft test file.
Aug 26, 2025
639ee0e
Merge branch 'v25.2.0-IOFreeze' into v25.2.0-IOFreeze-mains
Aug 26, 2025
73ee659
Return the right type.
Aug 26, 2025
558e22a
Update more field names in ft test file.
Aug 26, 2025
851d091
Merge branch 'v25.2.0-IOFreeze' into v25.2.0-IOFreeze-mains
Aug 26, 2025
3375775
Minor typo in new vt test.
Aug 27, 2025
eabfe1c
Actually run the new vt rule.
Aug 27, 2025
9c1e1af
Remove required-field for Initial Value field.
Aug 27, 2025
60bd88d
Change initialValue to return optional double.
Aug 27, 2025
8e5857b
Update expected values for a buried site water mains ft test.
Aug 27, 2025
746564f
Update values method after change to optional getter.
Aug 27, 2025
de0ed18
Update model tests for Actuator and Schedule.
Aug 28, 2025
13b78a7
HeatExchangerDesiccantBalancedFlow now defaults EconomizerLockout to …
Sep 11, 2025
16f8a5e
More proposed idd updates.
Sep 30, 2025
fa0b0a9
Update idds and model test for boiler capacity greater than zero.
Oct 6, 2025
26a3222
Update node type in idd for CentralHeatPumpSystem.
Oct 6, 2025
5b2f6e5
Add new optional OutputXXX fields to proposed idd.
Oct 7, 2025
89f97ee
Try v25.2 windows test package 1.
Oct 7, 2025
ac2e696
Version update listed idf files.
Oct 8, 2025
c3a3daf
Update min-fields for ZoneHVAC:HighTemperatureRadiant from 14 to 15, …
Oct 8, 2025
03091e4
Stub new developer doc release notes md.
Oct 10, 2025
fe4535d
Merge branch 'v25.2.0-IOFreeze' into v25.2.0-IOFreeze-extint
Oct 10, 2025
e4d1e32
Update the release notes.
Oct 10, 2025
053a839
Update idd with Availability Schedule Name for several coil objects.
Oct 10, 2025
5cfd33a
Update cmakelists with iofreeze shas.
Oct 15, 2025
dcf1684
Stub GHE:Vertical:Sizing:Rectangle in proposed idd.
Oct 15, 2025
2e1a9be
Remove reference on SizingPeriod:WeatherFileDays until object wrapped.
Oct 15, 2025
fb28a81
New sql test file with iofreeze installer.
Oct 15, 2025
baed61a
Add centos / AlmaLinux / win 32 hashes
jmarrec Oct 16, 2025
c7ac26f
Formatting changes to made diff easier with E+
jmarrec Oct 16, 2025
9d99a16
Add missing objects
jmarrec Oct 16, 2025
133c329
Add field changes except AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSp…
jmarrec Oct 16, 2025
6455312
Update Jenkins library reference to fix-bug version
anchapin Oct 16, 2025
aa51961
Remove reference on SizingPeriod:WeatherFileDays until object wrapped…
Oct 16, 2025
ba3deae
Update expected fuel oil annual total cost for sqlFile2.
Oct 16, 2025
6424d08
Remove specific version reference from Jenkins library to use the lat…
anchapin Oct 16, 2025
d40b2a2
Update sqlfile costs per Ubuntu's result
jmarrec Oct 20, 2025
b67421b
Update src/osversion/VersionTranslator.cpp
jmarrec Oct 20, 2025
1b5c1e4
Merge pull request #5477 from NREL/v25.2.0-IOFreeze-mains
jmarrec Oct 20, 2025
d4937ce
Merge pull request #5481 from NREL/v25.2.0-IOFreeze-extint
jmarrec Oct 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -195,15 +195,15 @@ endif()

# EnergyPlus Idd version
set(ENERGYPLUS_VERSION_MAJOR 25)
set(ENERGYPLUS_VERSION_MINOR 1)
set(ENERGYPLUS_VERSION_MINOR 2)
set(ENERGYPLUS_VERSION_PATCH 0)
set(ENERGYPLUS_VERSION "${ENERGYPLUS_VERSION_MAJOR}.${ENERGYPLUS_VERSION_MINOR}.${ENERGYPLUS_VERSION_PATCH}")
# Build SHA is not required to have a value, but if it does OpenStudio will require this build.
set(ENERGYPLUS_BUILD_SHA "1c11a3d85f")
set(ENERGYPLUS_BUILD_SHA "6a6bc0728b")

# ENERGYPLUS_RELEASE_NAME is used to locate the E+ download
# from the github releases
set(ENERGYPLUS_RELEASE_NAME "v25.1.0-WithDSOASpaceListFixes")
set(ENERGYPLUS_RELEASE_NAME "v25.2.0-IOFreeze")

set(ENERGYPLUS_REPO "NREL")

Expand Down Expand Up @@ -648,30 +648,30 @@ endif()
if(UNIX)
if(APPLE)
if (ARCH MATCHES "arm64")
set(ENERGYPLUS_EXPECTED_HASH f2fce0c8883d057dae498d1a0a717a80)
set(ENERGYPLUS_EXPECTED_HASH 50c7092dee84ea5f94b6b32be6dd03d4)
set(ENERGYPLUS_PLATFORM "Darwin-macOS13-arm64")
else()
set(ENERGYPLUS_EXPECTED_HASH f3bd66b9555d86e7330f6bb86f18eb89)
set(ENERGYPLUS_EXPECTED_HASH 7c01999d5a840168c9bfbfad912794b9)
set(ENERGYPLUS_PLATFORM "Darwin-macOS12.1-x86_64")
endif()
elseif(LSB_RELEASE_ID_SHORT MATCHES "CentOS")
set(ENERGYPLUS_EXPECTED_HASH 6fb9360c50ca797d16f74e167dd8b7ce)
set(ENERGYPLUS_EXPECTED_HASH daeb225a46744c714f49e50cda7de86d)
set(ENERGYPLUS_PLATFORM "Linux-CentOS7.9.2009-x86_64")
elseif(LSB_RELEASE_ID_SHORT MATCHES "AlmaLinux")
set(ENERGYPLUS_EXPECTED_HASH 67f00826449aad725a5a5b56fe0ec76a)
set(ENERGYPLUS_EXPECTED_HASH 7138b16742723aa7d39f6c185d33d741)
set(ENERGYPLUS_PLATFORM "Linux-AlmaLinux9.6-x86_64")
else()
if(LSB_RELEASE_VERSION_SHORT MATCHES "24.04")
if (ARCH MATCHES "arm64")
set(ENERGYPLUS_EXPECTED_HASH dbe28aebdbfc28ee8538cabb2dd15305)
set(ENERGYPLUS_EXPECTED_HASH 12b0e89296efcb3ecff2eab03b94f82c)
else()
set(ENERGYPLUS_EXPECTED_HASH af8ee54182777923fa4154b122c39447)
set(ENERGYPLUS_EXPECTED_HASH dc23c201393665a352e160e6b5dd03c5)
endif()
elseif(LSB_RELEASE_VERSION_SHORT MATCHES "22.04")
if (ARCH MATCHES "arm64")
set(ENERGYPLUS_EXPECTED_HASH 2ddd6ddb854cc3957943a9dd396c2dce)
set(ENERGYPLUS_EXPECTED_HASH 343a8477d3a93afa6e5d076257b3a08c)
else()
set(ENERGYPLUS_EXPECTED_HASH 7700f3f7865e36e442b7d171c2e2f96a)
set(ENERGYPLUS_EXPECTED_HASH fff86a0b919c106cacc414129e2a465e)
endif()
else() # e.g., 18.04, 20.04
message(FATAL_ERROR "EnergyPlus no longer provides packages for Ubuntu < 22.04")
Expand Down Expand Up @@ -708,11 +708,11 @@ elseif(WIN32)
if(CMAKE_SIZEOF_VOID_P EQUAL 8) # 64 bit
set(ENERGYPLUS_PATH "EnergyPlus-${ENERGYPLUS_VERSION}-${ENERGYPLUS_BUILD_SHA}-Windows-x86_64")
set(ENERGYPLUS_ARCH 64)
set(ENERGYPLUS_EXPECTED_HASH 630e0b8de20dea68185224072c079d90)
set(ENERGYPLUS_EXPECTED_HASH 9d82c78d59b8ad4833843464296ef8c2)
else()
set(ENERGYPLUS_PATH "EnergyPlus-${ENERGYPLUS_VERSION}-${ENERGYPLUS_BUILD_SHA}-Windows-i386")
set(ENERGYPLUS_ARCH 32)
set(ENERGYPLUS_EXPECTED_HASH e26ed12ee4df8dafa3d34a3340a9b780)
set(ENERGYPLUS_EXPECTED_HASH 8fc1c6fcbdc66b6348a2bf29df02d560)
endif()
if(EXISTS "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}.zip")
file(MD5 "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}.zip" ENERGYPLUS_HASH)
Expand Down
110 changes: 110 additions & 0 deletions developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_10_1_TBD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# OpenStudio Version 3.10.1

_Release Notes_ - _TBD_

These release notes describe version 3.10.1 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](https://github.com/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.10.1**__
- EnergyPlus
- Command Line Interface (CLI)
- Radiance
- Ruby API
- Python API
- C++ SDK

**Note** that [PAT](https://github.com/NREL/OpenStudio-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](https://github.com/NREL/OpenStudio-PAT) GitHub page.

# Where to Find OpenStudio SDK Documentation

- OpenStudio SDK release documentation, including these release notes, tutorials, and other user documentation, is available at [https://www.openstudio.net/](https://www.openstudio.net/.)
- C++ API documentation is available at [OpenStudio SDK Documentation](https://openstudio-sdk-documentation.s3.amazonaws.com/index.html)
- Measure development documentation is available at [OpenStudio Measure Writer's Reference Guide](http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/ )
- A roadmap for planned features is available at [Roadmap](http://nrel.github.io/OpenStudio-user-documentation/getting_started/roadmap/)

# Installation Notes

OpenStudio SDK 3.10.1 is supported on:

* 64-bit Windows 7 – 11
* macOS: 11.6+ x86_64, 12.1+ arm64
* Ubuntu: 22.04 x86_64, 24.04 x86_64, 22.04 arm64

OpenStudio SDK 3.10.1 supports [EnergyPlus Release 25.2.0, Bug Fix Edition](https://github.com/NREL/EnergyPlus/releases/tag/v25.2.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.10.1.

OpenStudio SDK 3.10.1 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.10.1.

As usual, you can refer to the **[OpenStudio SDK Compatibility Matrix](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix)** for more information.


## Installation Steps

- Download and install [OpenStudio SDK](https://github.com/NREL/openstudio) and/or any third party tool that embeds the OpenStudio SDK into their software such as [openstudiocoalition/OpenStudioApplication](https://github.com/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.
- A BCL AUth Key is no longer needed to access content on [Building Component Library (BCL)](https://bcl.nrel.gov) BCL is typically accessed through third party OpenStudio applications to provide modelers access to building components and OpenStudio measures; however you an also browse it and download content using the BCL link above.

For help with common installation problems please visit [Getting Started](http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/).

# OpenStudio SDK: Changelog

The 3.10.1 is a **major** release. This update includes several new features, performance improvements, and bug fixes.

## C++ Workflow code

As of OpenStudio SDK 3.7.0 a re-written workflow written in C++ is used by default in place of the Ruby based Workflow Gem that had been used in the past. This enhancement is in support of Python measures being used in an OpenStudio workflow, including mixed language workflows that include both Ruby Measures and Python Measures. If you need to use the older Workflow Gem implementation, you can do that by using the `classic` subcommand after `openstudio`. `classic` will be deprecated in a future version of OpenStudio.

## 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.10.1`

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

You can also refer to the [OpenStudio SDK Python Binding Version Compatibility Matrix](https://github.com/NREL/OpenStudio/wiki/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

* [#5481](https://github.com/NREL/OpenStudio/pull/5481) - ExternalInterface's optional Initial Value field
* Field `Initial Value` is made optional for `ExternalInterface:FunctionalMockupUnitExport:To:Schedule` and `ExternalInterface:FunctionalMockupUnitExport:To:Actuator`
* API-breaking change for `ExternalInterface:FunctionalMockupUnitExport:To:Schedule` and `ExternalInterface:FunctionalMockupUnitExport:To:Actuator`:
* `initialValue` (`double` to `boost::optional<double>`)

## Minor changes and bug fixes




Refer to the changelog on the release page at [v3.10.1](https://github.com/NREL/OpenStudio/releases/v3.10.1)

**Full Changelog**: https://github.com/NREL/OpenStudio/compare/v3.10.0...v3.10.1

**New Contributors**:

### OpenStudio Standards v0.8.2

Update the openstudio-standards gem to version [0.8.2](https://github.com/NREL/openstudio-standards/releases/tag/v0.8.2)
In addition to some refactoring, this release also included conversion of 90.1 data to formal database.

---
# This YAML header controls the pandoc (via TeX) to PDF settings
# To convert the markdown to pdf, do `pandoc release_notes.md -o release_notes.pdf`
title: 'OpenStudio Release Notes - 3.10.1'
author:
- National Renewable Energy Laboratory
colorlinks: true
linkcolor: blue
urlcolor: Mahogany
toccolor: gray
geometry:
- margin=1in
---
1 change: 1 addition & 0 deletions resources/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ set(utilities_resources_src
utilities/SqlFile/1ZoneEvapCooler-V24-1-0.sql
utilities/SqlFile/1ZoneEvapCooler-V24-2-0.sql
utilities/SqlFile/1ZoneEvapCooler-V25-1-0.sql
utilities/SqlFile/1ZoneEvapCooler-V25-2-0.sql
utilities/xml/base.xml
utilities/xml/hpxml_with_error.xml
utilities/xml/schema/HPXML.xsd
Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/5ZoneAirCooled/in.idf
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
! Environmental Emissions: None
! Utility Tariffs: None

Version,25.1;
Version,25.2;

Building,
Building, !- Name
Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/AllFuelTypes/in.idf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Version,25.1;
Version,25.2;

Timestep,6;

Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/BestestEx/in.idf
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
!BESTEST-EX Case L200EX-PH BASE-CASE, developed by NREL
!Use EnergyPlus IDFEditor to view inputs in IP units

Version,25.1;
Version,25.2;

SimulationControl,
No, !- Do Zone Sizing Calculation
Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/Daylighting_Office/in.idf
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
! schedule types, always on schedule, misc
! ***GENERAL SIMULATION PARAMETERS***

Version,25.1;
Version,25.2;

SimulationControl,
YES, !- Do Zone Sizing Calculation
Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/Daylighting_School/in.idf
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
! WeatherFileName=USA_CO_Boulder_TMY2.epw
! End SimMetaData

Version,25.1;
Version,25.2;

Timestep,6;

Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/FrameAndDivider/in.idf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Version,25.1;
Version,25.2;

Timestep,4;

Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/HospitalBaseline/in.idf
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
! End SimMetaData
! Number of Zones: 130

Version,25.1;
Version,25.2;

Timestep,6;

Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/NewFileTemplate.idf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!- =========== ALL OBJECTS IN CLASS: VERSION ===========

Version,25.1;
Version,25.2;

!- =========== ALL OBJECTS IN CLASS: BUILDING ===========

Expand Down
2 changes: 1 addition & 1 deletion resources/energyplus/Office_With_Many_HVAC_Types/in.idf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Version,25.1;
Version,25.2;

Building,
Building 1, !- Name
Expand Down
Loading
Loading