From af4484444276b26dd3c97e1e13d8e39ac8063646 Mon Sep 17 00:00:00 2001 From: Michael Wetter Date: Sat, 2 Sep 2023 08:07:36 -0700 Subject: [PATCH] Issue3497 release10 0 0 preparations (#3498) * Updated BuildingsPy to 5.0.0 release candidate * Updated BuildingsPy to 5.0.0 --- .travis.yml | 2 +- Buildings/package.mo | 339 +++++++++++++++++++++++++++++++++++++++++-- README.md | 2 +- 3 files changed, 329 insertions(+), 14 deletions(-) diff --git a/.travis.yml b/.travis.yml index 5c1abf23805..4238290ed80 100644 --- a/.travis.yml +++ b/.travis.yml @@ -30,7 +30,7 @@ services: env: global: - - BUILDINGSPY_VERSION=BuildingsPy@0c16e6b6cdd427a9f0b94db1e3c5a1be8915d87a + - BUILDINGSPY_VERSION=BuildingsPy@v5.0.0 - OMC_VERSION=ubuntu-2204-omc:1.22.0_dev-41-g8a5b18f-1 - OPTIMICA_VERSION=travis-ubuntu-2204-optimica:1.43.4 - DYMOLA_VERSION=travis_ubuntu-2004_dymola:2023x-x86_64_rev-1 diff --git a/Buildings/package.mo b/Buildings/package.mo index ba62fc06bfc..7df468416fd 100644 --- a/Buildings/package.mo +++ b/Buildings/package.mo @@ -209,8 +209,73 @@ Each class (i.e., model, block and function) must be used in an example or valid annotation (Documentation(info="

-Version 10.0.0 is ... xxx +Version 10.0.0 is a major release that adds various new packages and models.

+

+The library has been tested +Dymola 2023x, +OpenModelica 1.22.0-dev (41-g8a5b18f-1), +OPTIMICA 1.43.4 and recent versions of Impact. +

+

+The following major changes have been done compared to release 9.1.1: +

+

@@ -1300,16 +1365,247 @@ units are wrong or errors in documentation): +")); + end Version_10_0_0; + + class Version_9_1_1 "Version 9.1.1" + extends Modelica.Icons.ReleaseNotes; + annotation (Documentation(info=" +

-Note: +Version 9.1.1 is backward compatible with 9.1.0, except that the Spawn binaries need to be updated as described + in Buildings.ThermalZones.EnergyPlus_9_6_0.UsersGuide.Installation. +

+

+ The library has been tested with + Dymola 2023x, + OpenModelica 1.22.0-dev (41-g8a5b18f-1), + OPTIMICA 1.43.4 and recent versions of Impact. +

+

+ The Spawn binaries have been updated from version 0.3.0 to 0.4.3. + Both use the same EnergyPlus input data files from EnergyPlus 9.6.0. + The update corrects a bug that caused EnergyPlus to always send + a heat capacitance multiplier of 1 to Modelica + (see #3481). +

+
+ + +

+The following new components have been added +to existing libraries:

- + + + + + + + +
Buildings.BoundaryConditions.WeatherData +
Buildings.BoundaryConditions.WeatherData.BaseClasses.PartialConvertTime + Added model to be extended in solar models that need calendar year for calculation.
+ See IBPSA, #1716. + +
+ +

+The following existing components +have been improved in a +backward compatible way: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Buildings.Controls.OBC.Utilities +
Buildings.Controls.OBC.Utilities.PIDWithInputGains + Corrected the instance antWinGai2 to be conditional.
+ This is for + #3423. +
Buildings.BoundaryConditions +
Buildings/BoundaryConditions/SolarGeometry/BaseClasses/Declination.mo
+ Buildings/BoundaryConditions/SolarIrradiation/BaseClasses/SkyClearness.mo
+ Buildings/BoundaryConditions/WeatherData/BaseClasses/ConvertTime.mo
+ Buildings/BoundaryConditions/WeatherData/BaseClasses/EquationOfTime.mo
+ Buildings/BoundaryConditions/WeatherData/BaseClasses/LocalCivilTime.mo + 		Updated radiation models to use calendar time instead of simulation time.
+ See IBPSA, #1716. + +
Buildings.Controls.OBC.CDL +
Buildings.Controls.OBC.CDL.Psychrometrics.WetBulb_TDryBulPhi + Added a constant in order for unit check to pass.
+ See IBPSA, #1711. + +
Buildings.Controls.OBC.CDL.Continuous.Validation.MovingAverage
+ Buildings.Controls.OBC.CDL.Utilities.Validation.SunRiseSet
+ Buildings.Controls.OBC.CDL.Utilities.Validation.SunRiseSetNegativeStartTime
+ Buildings.Controls.OBC.CDL.Utilities.Validation.SunRiseSetPositiveStartTime + 		Changed models to comply with CDL specifications.
+ This is for + #3301. +
Buildings.Electrical +
Buildings.Electrical.Interfaces.PartialTwoPort + Added constraining clause for terminal as models that extend from this model + access a component that is not in the base class, and Optimica 1.40 + issues a warning for this.
+ This is for + #3236. +
Buildings.Fluid +
Buildings.Fluid.Examples.Performance.Example5
+ Buildings.Fluid.Examples.Performance.Example6
+ Buildings.Fluid.Examples.Performance.Example7
+ Buildings.Fluid.Examples.Performance.Example8 + 		Added a constant in order for unit check to pass.
+ See IBPSA, #1711. + +
Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.convectionResistanceCircularPipe
+ Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.partialInternalResistances + 		Corrected variability of assignment to comply with the Modelica Language Definition.
+ See IBPSA, #1762. + +
Buildings.Fluid.HeatExchangers.BaseClasses.Examples.EpsilonNTUZ + Added a constant in order for unit check to pass.
+ See IBPSA, #1711. + +
Buildings.Media +
Buildings.Media.Examples.BaseClasses.PartialProperties + Removed a self-dependent default binding of a function input.
+ This is for + #3384. +
Buildings.Utilities +
Buildings.Utilities.Plotters.Examples.Scatter
+ Buildings.Utilities.Plotters.Examples.TimeSeries
+ Buildings.Utilities.Psychrometrics.TWetBul_TDryBulPhi
+ Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi + 		Added a constant in order for unit check to pass.
+ See IBPSA, #1711. + +
+ + +

+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + +
Buildings.Controls.OBC.CDL +
Buildings.Controls.OBC.CDL.Continuous.Sources.CalendarTime + Refactored implementation to avoid wrong day number due to rounding errors + that caused simultaneous events to not be triggered at the same time.
+ This is for issue 3199. +
Buildings.Fluid.HeatExchangers +
Buildings.Fluid.HeatExchangers.DryCoilDiscretized + Corrected the modification of hexReg[nReg].m2_flow_nominal.
+ This is for #3441. +
Buildings.ThermalZones.EnergyPlus_9_6_0 +
Buildings.ThermalZones.EnergyPlus_9_6_0.ThermalZone + Corrected bug that caused EnergyPlus to always + send 1 for the heat capacitance multiplier.
+ This is for #3481. +
Buildings.Utilities.Time +
Buildings.Utilities.Time.CalendarTime + Refactored implementation to avoid wrong day number due to rounding errors + that caused simultaneous events to not be triggered at the same time.
+ This is for issue 3199. +
+ +

+The following uncritical errors have been fixed (i.e., errors +that do not lead to wrong simulation results, e.g., +units are wrong or errors in documentation): +

+ + + + + + + + + + + +
Buildings.Fluid.FMI +
Buildings.Fluid.FMI.Adaptors.Outlet + Corrected dimension of X in function call, which caused the model to not translate with some tools + if the media has only one component such as water.
+ IBPSA, #1768. +
Buildings.Fluid.HeatExchangers +
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.Evaporation + Corrected assertion for the condition dX_nominal<0 + and the documentation.
+ This is for issue 3322. +
")); - end Version_10_0_0; + end Version_9_1_1; class Version_9_1_0 "Version 9.1.0" extends Modelica.Icons.ReleaseNotes; @@ -12106,7 +12402,10 @@ on the Buildings library.