v4.0.0

• Info

  • changes start at #225 (2025/10/17) and end at #349 (2025/09/19); 86 commits in total

• main changes

  • refactor file structure (#257) - split code into separate files using init.py only to provide the package interface
  • consistently use of the logging package; remove all usage of print() (#253, #269)
  • Split functions for specific OMC commands as separate class OMCSessionCMD (#282) - to be removed in a later version!
  • allow to run OMCsession in Docker / WSL (#319, #295, #302, #306)

• interface changes

  • allow to modify default command line options (#349) - ModelicaSystem/commandLineOptions now as list (was a string)
  • Make ModelicaSystem.linearize() return all values (#266)
  • ModelicaSystem can only be run local using OMCProcessLocal (#309)
  • Getter functions of ModelicaSystem now take also a list as input and raise KeyError if a value does not exists (#299)
  • Setter functions of ModelicaSystem now take also a dict as input (#314)
  • Simulation flags to be provided as dicts (use simargs; simflags is depreciated) (#279)

• internal details / for developers

  • setup pre-commit (#289) - enforce code quality by using codespell, flake8 and mypy
  • improve unittest coverage and code quality (#246, #249, ...)
  • use specific exceptions for OMCsession* and ModelicaSystem* (#228, #272)
  • add / improve docstrings (#257, #337, ...)
  • use '_' for private variables and functions (#304)
  • use pathlib.Path() for any path handling, preparing for OMCPath (#247, #280, #303, #303, #329)
  • definition of class ModelicaSystemCmd to handle simulations (#279)
  • Define OMCProcess* classes to handle different definitions (by Port/LOcal/Docker/WSL) (#295, #302, #306)
  • lots of rewrites for internal functions (ModelicaSystem/OMCSession) (#265, #271, #270, #281, #287, #295, #301, #316, #311, #314, #340, #341, ...)

• important bugfixes

  • On Windows use information in *.bat file to define the needed dll paths (#229)
  • issue 245 - Fix ModelicaSystem cannot load from relative path (#247)
  • issue 224 - do not run the results of linearize() as python cade as it breaks matplotlib (#320)

• removed features

  • remove corba support (#240)
  • drop Python 2.x; Python >= 3.10 needed (#256)

New Contributors

• @syntron made their first contribution in #226
• @dependabot[bot] made their first contribution in #222
• @AxelMatstoms made their first contribution in #239
• @ondras12345 made their first contribution in #242
• @Nmichele29 made their first contribution in #285

Full Changelog: v3.6.0...v4.0.0

v3.6.0

What's Changed

• fix: library import before opening model when model is inside a package by @jules-l-jimmy in #219
• feat: get unit of scalars in quantitiesList by @jules-l-jimmy in #220
• Remove distutils, update CI by @AnHeuermann in #221
• fix setup.py long_description_content_type by @arun3688 in #223

New Contributors

• @jules-l-jimmy made their first contribution in #219
• @AnHeuermann made their first contribution in #221

Full Changelog: v3.5.2...v3.6.0

v3.5.2

What's Changed

• Always call getErrorString() when verbose=True by @adeas31 in #203
• add support to custombuildDirectory by @arun3688 in #205
• fixes issue #207 by @InigoGastesi in #208
• fix result file path by @arun3688 in #210
• load linearized model directly from file by @arun3688 in #213
• Changed to use list instead of string for subprocess command. by @j-emils in #214
• release 3.5.2 by @arun3688 in #216

New Contributors

• @InigoGastesi made their first contribution in #208
• @j-emils made their first contribution in #214

Full Changelog: v3.5.1...v3.5.2

v3.5.1

What's Changed

• update version number by @arun3688 in #200
• load the dependent libraries using ModelicaSystem by @arun3688 in #201

Full Changelog: v3.5.0...v3.5.1

v3.5.0

What's Changed

• Always print getErrorString as it might contain build warnings by @adeas31 in #159
• Added github templates by @adeas31 in #160
• Set user environment variable for omc started from wsgi by @adeas31 in #161
• support variableFilter to ModelicaSystem by @arun3688 in #163
• "outputFormat" in simulateOptions by @Tesshub in #168
• parse min and max attribute by @arun3688 in #170
• use readSimulationResultVars for getSolutions by @arun3688 in #171
• create separate temp directory for each ModelicaSystem session by @arun3688 in #172
• use overrideFile as default to support large scale parameter setting by @arun3688 in #173
• avoid compiling linearization and use .exe and runtime flag -l by @arun3688 in #174
• Fix mistyped fileNamePrefix. by @javiarrobas in #178
• report proper error messages to users by @arun3688 in #179
• swicth CI to github workflow actions by @arun3688 in #181
• allow modelicaSystem() to directly load MSL without filename by @arun3688 in #180
• check fmi regressions by @arun3688 in #183
• schedule FMI regression At 12:00 AM, only on Friday by @arun3688 in #184
• change to markdown and add status badge by @arun3688 in #185
• fix status badge alignment by @arun3688 in #186
• test fmi regression in windows by @arun3688 in #187
• run FMI regression test on each commit by @arun3688 in #188
• add nightly builds and schedule FMIRegression test every day by @arun3688 in #189
• use directly buildModelFMU() for FMI_Regression tests by @arun3688 in #191
• fix openmodelica setup by @arun3688 in #195
• add linearFile to system path by @arun3688 in #197
• suppress the print statements by @arun3688 in #198

New Contributors

• @Tesshub made their first contribution in #168
• @javiarrobas made their first contribution in #178

Full Changelog: v3.4.0...v3.5.0

v3.4.0

What's Changed

• Replaced deprecated 'getchildren' method with 'list(elem)' for Python >= 3.2 by @kzscisoft in #132
• Avoid using translations by @adeas31 in #131
• add needed dll's to PATH for windows simulation by @arun3688 in #136
• fix linearfile for linearization() by @arun3688 in #140
• report info message for non-modifiable parameters by @arun3688 in #141
• update getParameters when rebuilding model by @arun3688 in #142
• allow users to provide library version by @arun3688 in #143
• fix getClassNames without className argument by @Arinomo in #154
• New release version 3.4.0 by @adeas31 in #158

Full Changelog: v3.3.0...v3.4.0

v3.2.0

3.2.0 release

v3.0.3

Fixed some potential deadlocks

v3.0.0

OMPython 3.0.0