Versioning and Releasing

Version numbers

In general, there is a definition for software, how the version numbers are named, which looks like this:

v1.3.5

• 1: major release - for significant changes
• 3: minor release - functional extensions
• 5: patch level - mostly bug fixes

This means, if you found a bug and want to fix it, just raise the last number of the version, if you want to add a new model or some new functions raise the second number. Hold in mind, that if you do changes to existing models, you probably need to write a conversion script

Major Release

What to do:

• Merge IBPSA into AixLib (see below)
• Merge dev into master
• Make a release
• Update this wiki entry if you find any problems during the process

How to merge the current Modelica IBPSA Library into AixLib

In order to merge the current Modelica IBPSA library, make sure your local repositories of Modelica IBPSA and of AixLib are up to date. Your Modelica IBPSA repository should be checked out to the current master branch. With AixLib, you should be on the branch you want to merge with. This branch should be up to date with the current development or master branch.

Also, make sure that you have the BuildingsPy Python library installed on your computer. Although the installation via pip install works, we recommend using the version found on GitHub, as this is the most up-to-date: pip install -e [Path/to/your/BuildingsPy/Clone]. If when running mergeModelicaIBPSA.py you introduce the wrong paths for the AixLib and Modelica IBPSA libraries, you have to delete the mergePaths.json file where the paths are stored. This file will be stored in the python installation.

Then you can simply run the merge script at AixLib\AixLib\Resources\Scripts\mergeModelicaIBPSA.py. More information available under BuildingsPy Documentation.

Lessons learned from lateset merge, for release 0.9.0 (2020-01-16)

• Still for each UsersGuide package a UsersGuide mention is added in the package.order, which is unnecessary. revert
• The ref results for the following IBPSA models where not copied by merge script:
  • AixLib.Controls.Continuous.Examples.PIDHysteresisTimer
  • AixLib.Controls.SetPoints.Examples.SupplyReturnTemperatureReset
  • AixLib.Airflow.Multizone.Examples.ClosedDoors

Library check returns:

Lessons learned from merge, for release 0.8.0 (2019-09-17)

• Load AixLib in OpenModelica.
• Check whole AixLib.

AixLib: Overall, 7 Errors, 1194 Warnings and 6486 Messages have been issued. IBPSA: Overall, 6 Errors, 841 Warnings and 8459 Messages have been issued.

1. Script AixLib\AixLib\Resources\Scripts\mergeModelicaIBPSA.py works differently than the older script for Annex60 merge, Wiki has been updated.
2. Bugs with the script
   • Some Reference Results files are deleted and added is script runs two times in a row, so just ignore the changes or rerun the script.
   • Package.order files seems not to be updated correctly while running once. Maybe a second run helps.
   • For each UsersGuide package a UsersGuide mention is added in the package.order, which is unnecessary. revert this changes
3. Some models produce errors when checking, these are ModelicaIBPSA models, nothing to be done. You can find a screenshot below: These errors come from:
   • heaPum.UACon & heaPu.UAEva: AixLib.Fluid.HeatPumps.Calibration.BaseClasses.PartialWaterToWater
   • Size mismatch errors: AixLib.Fluid.Humidifiers.SprayAirWasher_X
   • Last two errors: AixLib.Fluid.Humidifiers.SteamHumidifier_X
4. AixLib.Utilities.Sources.NcDataReader on its own produces errors at checking. Load NcDataReader2 and the errors dissapear.
5. The new Obsolete Package which came with v4.0 of IBPSA is not merged by the merge script yet and had to copied by hand, please hold this in mind. The problem is discussed in IBPSA here.
6. IBPSA now has its own conversion script. This must be copied by hand into AixLib and linked as any other conversion scirpt in the package.mo. You also have to change the paths in the script from IBPSA.Package.model -> AixLib.Package.model.