Skip to content

Commit

Permalink
Issue3046 - Update release notes for 9.0.0 (#3050)
Browse files Browse the repository at this point in the history 
* Added release information for version 9.0.0

* Updated date

* Added 8.1.3 release notes
  • Loading branch information
@mwetter
mwetter authored May 28, 2022
1 parent 4f21177 commit dff251c
Show file tree
Hide file tree
Showing 2 changed files with 180 additions and 17 deletions.
195 changes: 179 additions & 16 deletions Buildings/package.mo
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,16 +208,66 @@ Each class (i.e., model, block and function) must be used in an example or valid
annotation (Documentation(info="<html>
<div class=\"release-summary\">
<p>
Version 9.0.0 is ... xxx
Version 9.0.0 is a major release that updates the Modelica version from 3.2.3 to 4.0.0.
</p>
<p>
This release updates the Modelica version from 3.2.3 to 4.0.0.
The library has been tested with Dymola 2022x,
OpenModelica 1.19.0-dev (613-gd6e04c0-1),
OPTIMICA (revision 2022-05-09-master-4b0cd2bf71) and recent versions of Impact.
</p>
<p>
This release also updates almost all fluid component models to remove the parameter <code>massDynamics</code>,
which is now set to the same value as the parameter <code>energyDynamics</code>. This simplifies use of the models.
A conversion script will update this setting when updating from Buildings 8 to 9.
The following major changes have been done:
</p>
<ul>
<li>
The Modelica version has been updated from version 3.2.3 to 4.0.0.
</li>
<li>
Most fluid component models have been updated to remove the parameter <code>massDynamics</code>,
which is now set to the same value as the parameter <code>energyDynamics</code>.
</li>
<li>
The models for coupling with EnergyPlus have been moved to the package
<code>Buildings.ThermalZones.EnergyPlus_9_6_0</code> to allow
support for more than one EnergyPlus version
in future releases.
</li>
<li>
The BESTEST validation in the package
<code>Buildings.ThermalZones.Detailed.Validation.BESTEST</code>
has been updated to the latest BESTEST version, and new tests have been added.
</li>
<li>
The package <code>Buildings.Fluid.Geothermal.BuriedPipes</code>
has been added to model heat transfer between buried pipes and the ground,
such as for district energy systems.
</li>
<li>
The package <code>Buildings.Media.Steam</code> for modeling steam has been added.
</li>
<li>
Various new models have been added to the package <code>Buildings.Airflow.Multizone</code>
for modeling multizone air exchange.
</li>
<li>
Models for ice tanks have been added to the package
<code>Buildings.Fluid.Storage.Ice</code>.
</li>
<li>
Various models, such as for PV, solar collectors and thermal zones have been
improved to obtain the latitude of the building from the weather data bus,
rather than requiring the user to specify it.
</li>
<li>
The run-time coupling with Python has been updated to Python version 3.8,
and it has been renamed to <code>Buildings.Utilities.IO.Python_3_8</code>.
</li>
<li>
Various other models have been improved or added, in particular for modeling of
control sequences using the Control Description Language that has been developed
in the OpenBuildingControl project at <a href=\"https://obc.lbl.gov\">https://obc.lbl.gov</a>.
</li>
</ul>
</div>
<!-- New libraries -->
<p>
Expand Down Expand Up @@ -1217,18 +1267,125 @@ units are wrong or errors in documentation):
</td>
</tr>
</table>
</html>"));
end Version_9_0_0;


class Version_8_1_3 "Version 8.1.3"
extends Modelica.Icons.ReleaseNotes;
annotation (Documentation(info="<html>
<div class=\"release-summary\">
<p>
Note:
Version 8.1.3 is a patch that has backward compatible bug fixes.
It is backwards compatible with versions 8.0.0, 8.1.0, 8.1.1 and 8.1.2.
</p>
<ul>
<li>
xxx
</li>
</ul>
<p>
The library has been tested with Dymola 2022,
JModelica (revision 14023),
OpenModelica 1.19.0-dev (449+g4f16e6af22),
OPTIMICA (revision OCT-dev-r26446_JM-r14295) and recent versions of Impact.
</p>
</div>
<!-- New libraries -->
<!-- New components for existing libraries -->
<!-- Backward compatible changes -->
<!-- Non-backward compatible changes to existing components -->
<!-- Errors that have been fixed -->
<p>
The following <b style=\"color:red\">critical errors</b> have been fixed (i.e., errors
that can lead to wrong simulation results):
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=\"0\" cellpadding=\"2\" style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid.HeatExchangers</b>
</td>
</tr>
<tr><td valign=\"top\"> Buildings.Fluid.HeatExchangers.WetCoilCounterFlow<br/>
Buildings.Fluid.HeatExchangers.WetCoilDiscretized</br>
</td>
<td valign=\"top\">Corrected removal of latent heat from component.<br/>
This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3027\">#3027</a>.
</td>
</tr>
</table>
<!-- Uncritical errors -->
</html>"));
end Version_9_0_0;
end Version_8_1_3;


class Version_8_1_2 "Version 8.1.2"
extends Modelica.Icons.ReleaseNotes;
annotation (Documentation(info="<html>
<div class=\"release-summary\">
<p>
Version 8.1.2 is a patch that has backward compatible bug fixes.
It is backwards compatible with versions 8.0.0, 8.1.0 and 8.1.1.
</p>
<p>
The library has been tested with Dymola 2022,
JModelica (revision 14023),
OpenModelica 1.19.0-dev (449+g4f16e6af22),
OPTIMICA (revision OCT-dev-r26446_JM-r14295) and recent versions of Impact.
</p>
</div>
<!-- New libraries -->
<!-- New components for existing libraries -->
<!-- Backward compatible changes -->
<p>
The following <b style=\"color:blue\">existing components</b>
have been <b style=\"color:blue\">improved</b> in a
<b style=\"color:blue\">backward compatible</b> way:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=\"0\" cellpadding=\"2\" style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.HeatTransfer</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.HeatTransfer.Windows.BaseClasses.CenterOfGlass
</td>
<td valign=\"top\">Changed the gas layer to be conditional.<br/>
This is for
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3026\">#3026</a>.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Boilers.Data.Lochinvar
</td>
<td valign=\"top\">Added annotation <code>defaultComponentPrefixes = \"parameter\"</code>.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatPumps.Data.EquationFitReversible.Generic
</td>
<td valign=\"top\">Removed <code>protected</code> declaration inside the record as the Modelica Language Specification
only allows public sections in a record.<br/>
This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3009\">#3009</a>.
</td>
</tr>
</table>
<!-- Non-backward compatible changes to existing components -->
<!-- Errors that have been fixed -->
<!-- Uncritical errors -->
<p>
The following <b style=\"color:red\">uncritical errors</b> have been fixed (i.e., errors
that do <b style=\"color:red\">not</b> lead to wrong simulation results, e.g.,
units are wrong or errors in documentation):
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=\"0\" cellpadding=\"2\" style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Controls</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Controls.OBC.CDL.Conversions.BooleanToInteger<br/>
Buildings.Controls.OBC.CDL.Conversions.BooleanToReal<br/>
</td>
<td valign=\"top\">Corrected documentation texts where the variables were described with wrong types.<br/>
This is for
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3016\">#3016</a>.
</td>
</tr>
</table>
</html>"));
end Version_8_1_2;

class Version_8_1_1 "Version 8.1.1"
extends Modelica.Icons.ReleaseNotes;
annotation (Documentation(info="<html>
Expand Down Expand Up @@ -10476,7 +10633,13 @@ on the Buildings library.
</p>
<ul>
<li>
<a href=\"modelica://Buildings.UsersGuide.ReleaseNotes.Version_9_0_0\">Version 9.0.0</a> (xxx, 2021)
<a href=\"modelica://Buildings.UsersGuide.ReleaseNotes.Version_9_0_0\">Version 9.0.0</a> (May 31, 2022)
</li>
<li>
<a href=\"modelica://Buildings.UsersGuide.ReleaseNotes.Version_8_1_3\">Version 8.1.3</a> (May 31, 2022)
</li>
<li>
<a href=\"modelica://Buildings.UsersGuide.ReleaseNotes.Version_8_1_2\">Version 8.1.2</a> (May 26, 2022)
</li>
<li>
<a href=\"modelica://Buildings.UsersGuide.ReleaseNotes.Version_8_1_1\">Version 8.1.1</a> (May 12, 2022)
Expand Down Expand Up @@ -11017,11 +11180,11 @@ end UsersGuide;
annotation (
preferredView="info",
version="9.0.0",
versionDate="2021-06-08",
dateModified="2021-06-08",
versionDate="2022-05-31",
dateModified="2022-05-31",
uses(Modelica(version="4.0.0")),
conversion(
from(version={"8.0.0", "8.1.0", "8.1.1"},
from(version={"8.0.0", "8.1.0", "8.1.1", "8.1.2", "8.1.3"},
script="modelica://Buildings/Resources/Scripts/Conversion/ConvertBuildings_from_8_to_9.0.0.mos")),
preferredView="info",
Documentation(info="<html>
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The main project site is http://simulationresearch.lbl.gov/modelica.

## Current release

Download [Buildings Library 8.1.1 (2022-05-12)](https://github.com/lbl-srg/modelica-buildings/releases/download/v8.1.1/Buildings-v8.1.1.zip)
Download [Buildings Library 9.0.0 (2022-05-31)](https://github.com/lbl-srg/modelica-buildings/releases/download/v9.0.0/Buildings-v9.0.0.zip)

## License

Expand Down

0 comments on commit dff251c

Please sign in to comment.