EnergyPlus 24.2.1 (Patched), Release Candidate 1

We will be re-releasing 24.2 with a couple fixes, renamed to 24.2.1. This is the first RC toward that re-release. Don't feel bad, we aren't the only ones who struggled with a big release over the weekend 😆 https://www.python.org/downloads/release/python-3130rc3/

EnergyPlus 24.2.0

EnergyPlus 24.2.0 (Bug Fix Release)

The U.S. Department of Energy (DOE) has released EnergyPlus version 24.2.0. There were many bug fixes and prominent new features this release. The full changelog for this release cycle is listed below. For more information about EnergyPlus, please visit www.energyplus.net.

🐞 Bug Fix Release 🐞

EnergyPlus 24.2.0 was released previously at sha e7ecb2d. After release a couple issues were identified that justified a re-release (#10766, #10777). This new version is functionally equivalent to the original 24.2.0 except those bug fixes. Even if those bug fixes don't affect your modeling, it is suggested that you use this updated version.

There was a discussion about incrementing the version's patch number to accommodate these changes (24.2.1). Given that we wanted to get this patched version out as quickly as possible without breaking/disrupting any workflows, we decided to just release with the same version number including the zero patch level. We will look into leveraging the patch number more semantically in the future if this situation ever occurs again.

Supported Platforms

• Windows 11 64-bit
• Linux (Ubuntu) 24.04 64 bit
• Mac OSX 11 and 12 64 bit versions, plus ARM support

What's Changed

New Features 🌟

• Add output wetbulb globe temperature in the csv output by @yujiex in #10506
• Adds Heat Recovery to Air-to-Water Heat Pump by @Nigusse in #10455
• Air-To-Water Heat Pump with Heat Recovery by @Nigusse in #10379
• Add the transition rules to accompany #10455 by @Myoldmopar in #10544
• NewFeature: Additional ASHRAE Metrics for E+ 24-1 by @Brijendra21 in #10311
• Variable speed fan powered induction boxes by @lymereJ in #10368
• Added Field to Site:Location to Allow Weather File Location Data to be Overwritten by User Info by @RKStrand in #10586
• Variable flow condenser plant control by @lymereJ in #10511
• Add Reports to Support createRMD - ruleset model description by @JasonGlazer in #10372
• NewFeature: Add measurement unit output for API by @Myoldmopar in #10604
• Allow ZoneHVAC:WindowAirConditioner with Airflow Network simulations by @lymereJ in #10617
• Chiller economizing using thermosiphon or fluid heat exchanger free cooling by @rraustad in #10415
• An Improved Duct Model by @lgu1234 in #10362
• Follow up to #10617 and allow other ZoneHVAC:* component with Airflow Network simulations by @lymereJ in #10637
• Space for IlluminanceMap and Internal Mass by @mjwitte in #10659
• Space Sizing and HVAC Part 4 by @mjwitte in #10566
• A couple API Endpoints by @Myoldmopar in #10658
• Modernized Error Reporting by @Myoldmopar in #9996
• Adopt the Extended Heat Index calculation in zone resilience by @yujiex in #10548
• Initial Python App Packaging by @Myoldmopar in #10716

Defects Repaired 🪲

• Fix (Probable) Fan Coil Sizing Issue by @amirroth in #10461
• Fixes Humidifier:Steam:Gas VariableInletWaterTemperature option by @shorowit in #10463
• Protect for table lookup zero divisor by @Myoldmopar in #10465
• EnergyPlus Crash Due to Zero Input for Variable Speed Coil Total Cooling by @RKStrand in #10470
• Do not apply capacity and power degradation to Coil:Heating:DX:VariableSpeed when timed defrost fraction is 0 by @lymereJ in #10327
• Correction of Location of Zone Equipment Get Routine by @RKStrand in #10482
• Fix Window Heat Transfer and Solar Out Window output reporting by @mjwitte in #10444
• Add new people schedule columns to EIO/initialization summary to address #10314 by @JasonGlazer in #10437
• Include lighting return air fraction input during sizing when ZoneAirMassFlowConservation is used by @rraustad in #10469
• Fix array bounds error with EquivalentLayer window and shading surface by @mjwitte in #10492
• New attempt at fixing #7464: outlet water temperature control issue for variable speed cooling tower by @lymereJ in #10248
• Fix EMS pump pressure override crash by @lgu1234 in #10422
• Water Use Equipment Shows Volumetric Flow Mismatch with Node Data by @RKStrand in #10497
• Fix FMU Variable Update by @mjwitte in #10510
• Correct logic in supplemental water coil used in UnitarySystem by @rraustad in #10479
• Align PlantLowFlowRateToler with DataHVACGlobals::VerySmallMassFlow by @lymereJ in #10457
• Correction of Generic Contaminant Handling in Some Situations by @RKStrand in #10516
• Fix VRF HeatRecovery Check by @mjwitte in #10515
• Fix #10426 - IndoorLivingWall documentation - Fixup units, format equations and equation description and add hyperlinks by @jmarrec in #10530
• Add convergence check for co2 and contaminant by @lgu1234 in #10500
• Fix #10355 - Correctly Set up Zone Internal Gains when Refrigeration:CompressorRack serves a Refrigeration:WalkIn object with "Zone" Heat Transfer Location by @jmarrec in #10525
• Fix #10302 - CalcEquipmentFlowRates assert failure due to out of bounds std::array indexing by @jmarrec in #10528
• Fix #10399 - Long elapsed times are not recorded correctly by @jmarrec in #10529
• #10531 - Use non-deprecated Github Actions by @jmarrec in #10532
• Fix #10365 - IDD Files Have Inconsistent Encoding by @jmarrec in #10526
• Add Reporting of Incident Solar on Shading Surfaces by @RKStrand in #10539
• Fix #10534 - Chiller:Absorption does not autosize in some cases by @jmarrec in #10540
• Addition of Limit Warnings for Node Temperatures in CondFD Solution Algorithm by @RKStrand in #10541
• Fix #9204 - Overcome StdOutputRecordCount's limit of about 2.1 billion by @jmarrec in #10536
• #9138 - Catch blank values in Schedule:File and Schedule:File:Shading and issue error by @jmarrec in #10533
• Initialize NodeData pressure in class initializer and DefaultNodeValues by @tanaya-mankad in #10485
• fix VRF_FluidTCtrl heating round 2 by @yujiex in #10331
• Fix 10519 UtilityCost:Tariff with Electric:Facility showing zero by @JasonGlazer in #10521
• Correction of Mass Flow Rate Calculation for Pools Served by Low Heater Capacity by @RKStrand in #10551
• #10524 - SetpointManager:ReturnTemperature:Chilled/HotWater (useless) warnings from GetSpecificHeatGlycol by @jmarrec in #10535
• Fix #10439 - Problems building with 3.12 on GHA - Bump python to 3.12.2 by @jmarrec in #10554
• Improve error checking in SQLite database connection (again) by @simularis in #10553
• Correction of Enclosure Based Solar Output Variables by @RKStrand in #10563
• change unit of "Zone ITE Adjusted Return Air Temperature" from W to C by @yujiex in #10565
• Make Phase Change and Variable Thermal Conductivity Material Property Input for the CondFD Solution Extensible by @RKStrand in #10556
• Fix array bounds error for interzone windows and fix convexity of mirrored surfaces by @mjwitte in #10498
• Fix #10279 - Make sure that assigning the result of a TendVariable (eg @TrendValue) results in proper actuator behavior by @jmarrec in #10575
• Correction of FEI Calculation by @RKStrand in #10572
• Correction of Hybrid Model Reporting Issues by @RKStrand in #10581
• Improve coil association in ReportCoilSelection coil sizing reports by @rraustad in #10549
• Fix autosize bug in variable speed cooling coils. by @tanaya-mankad in #10503
• Fix duplicate and near-duplicate eio headers by @mjwitte in #10597
• #10122 - Floating point test equa...

EnergyPlus 24.2.0 (Original Release)

🐞 Bug Fix Update 🐞

After this release was made, a couple bugs were fixed and 24.2.0 was re-released. Although these fixes will not affect many users, it is still suggested you use the re-release. Thank you!

---

EnergyPlus 24.2.0

The U.S. Department of Energy (DOE) has released EnergyPlus version 24.2.0. There were many bug fixes and prominent new features this release. The full changelog for this release cycle is listed below. For more information about EnergyPlus, please visit www.energyplus.net.

Supported Platforms

• Windows 11 64-bit
• Linux (Ubuntu) 24.04 64 bit
• Mac OSX 11 and 12 64 bit versions, plus ARM support

What's Changed

New Features 🌟

• Add output wetbulb globe temperature in the csv output by @yujiex in #10506
• Adds Heat Recovery to Air-to-Water Heat Pump by @Nigusse in #10455
• Air-To-Water Heat Pump with Heat Recovery by @Nigusse in #10379
• Add the transition rules to accompany #10455 by @Myoldmopar in #10544
• NewFeature: Additional ASHRAE Metrics for E+ 24-1 by @Brijendra21 in #10311
• Variable speed fan powered induction boxes by @lymereJ in #10368
• Added Field to Site:Location to Allow Weather File Location Data to be Overwritten by User Info by @RKStrand in #10586
• Variable flow condenser plant control by @lymereJ in #10511
• Add Reports to Support createRMD - ruleset model description by @JasonGlazer in #10372
• NewFeature: Add measurement unit output for API by @Myoldmopar in #10604
• Allow ZoneHVAC:WindowAirConditioner with Airflow Network simulations by @lymereJ in #10617
• Chiller economizing using thermosiphon or fluid heat exchanger free cooling by @rraustad in #10415
• An Improved Duct Model by @lgu1234 in #10362
• Follow up to #10617 and allow other ZoneHVAC:* component with Airflow Network simulations by @lymereJ in #10637
• Space for IlluminanceMap and Internal Mass by @mjwitte in #10659
• Space Sizing and HVAC Part 4 by @mjwitte in #10566
• A couple API Endpoints by @Myoldmopar in #10658
• Modernized Error Reporting by @Myoldmopar in #9996
• Adopt the Extended Heat Index calculation in zone resilience by @yujiex in #10548
• Initial Python App Packaging by @Myoldmopar in #10716

Defects Repaired 🪲

• Fix (Probable) Fan Coil Sizing Issue by @amirroth in #10461
• Fixes Humidifier:Steam:Gas VariableInletWaterTemperature option by @shorowit in #10463
• Protect for table lookup zero divisor by @Myoldmopar in #10465
• EnergyPlus Crash Due to Zero Input for Variable Speed Coil Total Cooling by @RKStrand in #10470
• Do not apply capacity and power degradation to Coil:Heating:DX:VariableSpeed when timed defrost fraction is 0 by @lymereJ in #10327
• Correction of Location of Zone Equipment Get Routine by @RKStrand in #10482
• Fix Window Heat Transfer and Solar Out Window output reporting by @mjwitte in #10444
• Add new people schedule columns to EIO/initialization summary to address #10314 by @JasonGlazer in #10437
• Include lighting return air fraction input during sizing when ZoneAirMassFlowConservation is used by @rraustad in #10469
• Fix array bounds error with EquivalentLayer window and shading surface by @mjwitte in #10492
• New attempt at fixing #7464: outlet water temperature control issue for variable speed cooling tower by @lymereJ in #10248
• Fix EMS pump pressure override crash by @lgu1234 in #10422
• Water Use Equipment Shows Volumetric Flow Mismatch with Node Data by @RKStrand in #10497
• Fix FMU Variable Update by @mjwitte in #10510
• Correct logic in supplemental water coil used in UnitarySystem by @rraustad in #10479
• Align PlantLowFlowRateToler with DataHVACGlobals::VerySmallMassFlow by @lymereJ in #10457
• Correction of Generic Contaminant Handling in Some Situations by @RKStrand in #10516
• Fix VRF HeatRecovery Check by @mjwitte in #10515
• Fix #10426 - IndoorLivingWall documentation - Fixup units, format equations and equation description and add hyperlinks by @jmarrec in #10530
• Add convergence check for co2 and contaminant by @lgu1234 in #10500
• Fix #10355 - Correctly Set up Zone Internal Gains when Refrigeration:CompressorRack serves a Refrigeration:WalkIn object with "Zone" Heat Transfer Location by @jmarrec in #10525
• Fix #10302 - CalcEquipmentFlowRates assert failure due to out of bounds std::array indexing by @jmarrec in #10528
• Fix #10399 - Long elapsed times are not recorded correctly by @jmarrec in #10529
• #10531 - Use non-deprecated Github Actions by @jmarrec in #10532
• Fix #10365 - IDD Files Have Inconsistent Encoding by @jmarrec in #10526
• Add Reporting of Incident Solar on Shading Surfaces by @RKStrand in #10539
• Fix #10534 - Chiller:Absorption does not autosize in some cases by @jmarrec in #10540
• Addition of Limit Warnings for Node Temperatures in CondFD Solution Algorithm by @RKStrand in #10541
• Fix #9204 - Overcome StdOutputRecordCount's limit of about 2.1 billion by @jmarrec in #10536
• #9138 - Catch blank values in Schedule:File and Schedule:File:Shading and issue error by @jmarrec in #10533
• Initialize NodeData pressure in class initializer and DefaultNodeValues by @tanaya-mankad in #10485
• fix VRF_FluidTCtrl heating round 2 by @yujiex in #10331
• Fix 10519 UtilityCost:Tariff with Electric:Facility showing zero by @JasonGlazer in #10521
• Correction of Mass Flow Rate Calculation for Pools Served by Low Heater Capacity by @RKStrand in #10551
• #10524 - SetpointManager:ReturnTemperature:Chilled/HotWater (useless) warnings from GetSpecificHeatGlycol by @jmarrec in #10535
• Fix #10439 - Problems building with 3.12 on GHA - Bump python to 3.12.2 by @jmarrec in #10554
• Improve error checking in SQLite database connection (again) by @simularis in #10553
• Correction of Enclosure Based Solar Output Variables by @RKStrand in #10563
• change unit of "Zone ITE Adjusted Return Air Temperature" from W to C by @yujiex in #10565
• Make Phase Change and Variable Thermal Conductivity Material Property Input for the CondFD Solution Extensible by @RKStrand in #10556
• Fix array bounds error for interzone windows and fix convexity of mirrored surfaces by @mjwitte in #10498
• Fix #10279 - Make sure that assigning the result of a TendVariable (eg @TrendValue) results in proper actuator behavior by @jmarrec in #10575
• Correction of FEI Calculation by @RKStrand in #10572
• Correction of Hybrid Model Reporting Issues by @RKStrand in #10581
• Improve coil association in ReportCoilSelection coil sizing reports by @rraustad in #10549
• Fix autosize bug in variable speed cooling coils. by @tanaya-mankad in #10503
• Fix duplicate and near-duplicate eio headers by @mjwitte in #10597
• #10122 - Floating point test equalities failing on Apple Silicon Macs by @jmarrec in #10598
• Fix FMU runtime failures on Ubuntu 24.04 by @Myoldmopar in #10593
• Fix #10322 - Bump CLI11 from 2.3.2 to 2.4.2 to fix Mac armv8: Docker energyplus input_file: File does not exist: energyplus by @jmarrec in #10595
• Fix SSC Battery State Issue by @Myoldmopar in #10543
• Fix ITE Standard Density Air Volume Flow Rate and Outdoor Air Details OA by Airloop ca...

EnergyPlus 24.2.0 IO Freeze

This is the IO freeze of 24.2. From this part on, it should only be non-IO changing PRs unless there is something critical.

Test codesigning on macOS

I know it works on my fork, but I need to test with this repo to ensure the GHA secrets are good to go too.

• #10645

EnergyPlus 23.1.0 with EIO Fix

This is a custom follow-up release of v23.1.0 with a single-line fix for the eio output for WindowConstruction to write the values for Solar Transmittance at Normal Incidence and Visible Transmittance at Normal Incidence. In versions 22.1 through 23.2, the format did not have enough terms, so the last two values were not written. Reference #10444.

EnergyPlus 22.1 with fix to plant loop low flow tolerance

This release is identical to https://github.com/NREL/EnergyPlus/tree/v22.1.0 except that it includes a fix for #10456 as shown in #10457.

v24.1.0

EnergyPlus 24.1.0

The U.S. Department of Energy (DOE) has released EnergyPlus version 24.1.0. There were many bug fixes and prominent new features this release. The full changelog for this release cycle is listed below. For more information about EnergyPlus, please visit www.energyplus.net.

Supported Platforms

• Windows 10 and 11: 64-bit versions, with possible 32-bit versions by request
• Linux (Ubuntu 20.04 and 22.04) 64 bit versions
• Mac OSX 11 and 12 64 bit versions, plus ARM support

What's Changed

New Features 🌟

• Add minimal E+ API demo to the install by @Myoldmopar in #10363
• Replace max efficiency limit on Boiler/WaterHeater objects with warning by @shorowit in #10339
• API Enhancements by @Myoldmopar in #10081
• Indoor living wall module by @LipingWang in #10385
• Enhancement for Heat Exchanger for Variable-Speed Heat Recovery Ventilation by @yujiex in #10277

Defects Repaired 🪲

• Fix missing MainsWater meter in code and the output meter documentation by @jcyuan2020 in #10243
• Fix Controller:MechanicalVentilation ProportionalControlBasedOnDesignOccupancy by @mjwitte in #10268
• Fix #10287 - ExpandObjects - Incorrect warning about Boiler:HotWater having too many fields by @jmarrec in #10288
• Integrate breaking changes in btwxt interface, including error logging via interface injection. by @tanaya-mankad in #10160
• Add missing initializations to squelch false table diffs in Annual Heat Emissions Report by @mjwitte in #10301
• Correct VRF supplemental heater operation with cycling fan by @rraustad in #10271
• Increase VRF terminal unit min-field to include supp heat coil turn-off temperature by @yujiex in #10283
• Fix hint value assignment in SetupUnitConversion() and check if there are any diffs by @jcyuan2020 in #10261
• Correction of Inconsistent Flow Rates from Swimming Pools by @RKStrand in #10303
• Mean Radiant Temperature from Zone to Enclosure by @mjwitte in #10244
• Fixes approach definition for Std 229 fluid cooler reports and adds cooling tower implementation by @jcyuan2020 in #10236
• Fix vector error for when a zone or space has no surfaces by @mjwitte in #10309
• Fix #10266 - Daylighting:Controls IDD field name inconsistency by @jmarrec in #10325
• #10345 - Sush warnings in third_party directory on modern compilers/OSes by @jmarrec in #10346
• Fixes Output:JSON tabular data output incorrectly dependent on OutputControl:Files input by @shorowit in #10155
• Fix HVAC radiant heat gain with CondFD by @mjwitte in #10310
• Fix 6919 when blanks are present in some tabular output reports by @JasonGlazer in #10201
• Correct zone temperature history terms for ThirdOrderBackwardDifference heat balance equation by @rraustad in #10226
• Add a new object type DataLoopNode::ConnectionObjectType by @lgu1234 in #10388
• Fill object defaults for blank or missing fields and fix Site:GroundReflectance:SnowModifier defaults by @rraustad in #10295
• Fixes source side sizing calculation for HeatPump:PlantLoop:EIR:Heating issue by @Nigusse in #10382
• Report some electricity usage in kW W or kWh in IP units options by @jcyuan2020 in #10256
• Allow choice in packaged units for selecting high or low speed air flow for no load supply air flow rate by @rraustad in #10313
• do not escape xml with invalid strings by @marklemay in #10394
• Correct AFN node temperature compatible with zone air temperature by @lgu1234 in #10371
• Correct crash with DOAS VS DX coils and fix system name in Coil Sizing tables by @rraustad in #10334
• Allow more multistage heating coils in AFN by @lgu1234 in #10393
• Correct system sizing when TU desisgn sizing object is used by @rraustad in #10376
• #10306 - Static gfortran by @jmarrec in #10412
• Add support of umol/m2-s in IDF Editor for IndoorLivingWall support by @JasonGlazer in #10414
• Minor fixes to EP-Launch 2, IDF Editor, IDF Version Updater by @JasonGlazer in #10428
• Minor fixes to EP-Launch, IDF Editor, IDF Version Updater (second try) by @JasonGlazer in #10434
• Fix #10350 - typo in zone_time_step python api returning system time step instead by @jmarrec in #10424
• Fix typo in test files CMake list by @lymereJ in #10436
• Addressed EIRFuelFiredHeatPump object electric energy consumption output variable reports zero value by @Nigusse in #10425
• Improved Controller:WaterCoil FindRoot error message with TemperatureAndHumidityRatio by @mjwitte in #10435
• More robust internal gain subtotals for UFAD and Displacement Ventilation by @mjwitte in #10419
• Fixes Supervisory Control Logic Problem For AirSource Plants by @Nigusse in #10418
• Fix misassigned fields in LocalAPIDataEntry (api/datatransfer.cc) by @chen1682-ntu-edu-sg in #10447
• Fix unshaded inside reveal array bounds error and add reveal and sill to Fenestration_RefBldgSmallHotelNew2004_Chicago by @mjwitte in #10442
• Fix #10453 - python38.dll missing on windows installers by @jmarrec in #10454

Under the Hood Refactoring ⚙

• SetupOutputVariable wrapper to use enum type parameters (endUseCategory, ReportingFrequency, and eResouceType) by @jcyuan2020 in #10231
• Use PyConfig to initialize python by @jmarrec in #10342
• GCC13 Fixes by @jmarrec in #10344
• Minor build cleanups by @Myoldmopar in #10007
• Heat Pump Plant Loop EIR refactoring by @Nigusse in #10404

New Contributors

• @dependabot made their first contribution in #10275
• @DonnaVakalis made their first contribution in #10396

Full Changelog: v23.2.0...v24.1.0

EnergyPlus 24.1, Release Candidate !!!6!!!

Freaking GitHub action runner image update 3 days ago broke us by having CMake 3.29 which apparently has a bug or at least different behavior. So...we learned today:

• We are going to be pulling our installer testing (EPTravisTester) over to this E+ main repo so that it gets tested at each installer build. We can add more and more tests, such as in this case, verifying the python DLL/SO/DYLIB exists at the install root.
• Please don't update your CMake to 3.29 if you are going to be building installers.
• And I feel like we need to modify our GitHub action workflows to pin to exact versions of all our dependencies to avoid GHA pulling the rug out from under us.

OK, famous last words -- this will be retagged as 24.1.0 later this afternoon.

FYI @jmarrec @jasondegraw @JasonGlazer @mjwitte

EnergyPlus 24.1.0 IO Freeze

This is the IO freeze of 24.1.0...finally.