RFC - definition of a runner class using as much of the existing code as possible #404

syntron · 2026-01-11T18:12:51Z

Content (lots of changes / these will be splitted into several PRs if the general approach is approved):

OMCSession.py: rename real OMCPath* classes as privat (start with '_')
OMCSession: define OMCPathDummy and OMCSessionDummy => no OMC server
ModelExecution.py: include all code related to model execution (from OMCsession*; ModelicaSystemCmd)
ModelicaSystemDoE.py: seperate file for this class
ModelicaSystemDoE.py: use ModelicaSystem / reduce number of arguments to init
ModelicaSystem(Base).py: split getOutputs() and getContinuous() to Initial and Final data
ModelicaSystem(Base).py: getOutputs*() / getContinuous*() - always return np.float64
ModelicaSystemBase.py: define a basic version of ModelicaSystem
ModelicaSystemRunner.py: definition of a 'runner' class using ModelicaSystemBasic / OMCSessionDummy (see PR Enable the usage of a pre-built model executables by ModelicaSystemRunner #401)
test_ModelicaSystemRunner.py: test case for ModelicaSystemRunner
test_*: update of test cases based on above listed changes

Compared to PR #401 this solution:

still uses the existing OMPython requirements (dependencies of the Runner class; i.e. numpy, etc.)
shares nearly all code with the current definitions (by using OMCPathDummy and OMCSessionDummy)
uses | instead of Union

Further changes could do additional modifications such that the 3rd party packages (ZMQ) are not needed at all in the runner code path.

All tests are running without error / tested in https://github.com/syntron/OMPython/actions/runs/20865402893

Please comment!

* rename ModelicaSystemCmd => ModelExecutionCmd * rename OMCSessionRunData => ModelExecutionData * create class ModelExecutionException * move some code: * OMCSession.omc_run_data_update() => merge into ModelExecutionCmd.define() * OMCSession.run_model_executable() => ModelExecutionData.run()

…delExecutionException

* this prepares a version of OMCSession which is independend of OMC as these functions where the last two which needed sendExpression() in basic ModelicaSystem functionality

* store data as numpy.float64 - allows to define None values * split get*() function into Initial values and Final values

…tinuous data handling

…existable exists and can be executed

…e as argument

* test_ModelicaSystemDoE_local is tested * test_ModelicaSystemDoE_docker should work * test_ModelicaSystemDoE_WSL is untested

…delExecutionException

…atus20260207

…m OMSessionABC * needed for the compatibility layer

* add get_session() * fix return values

* check return value from OMC * define return value for methods

* fix return values * additional cleanups

…rLocal and OMPathRunner Bash

* move more code to OMCSessionDockerHelper * use _docker_omc_start() to differentiate classes * define cmd_prefix

* use .items()

…ivate variable _model_name

* ModelicaSystemRunner & OMCPath * ModelicaSystemRunner & OMPathRunnerLocal * ModelicaSystemRunner & OMPathRunnerBash * ModelicaSystemRunner & OMPathRunnerBash using docker * ModelicaSystemRunner & OMPathRunnerBash using WSL (not tested!)

* OMCPath & OMCSessionZMQ * OMCPath & OMCSessionLocal * OMCPath & OMCSessionDocker * OMCPath & OMCSessionWSL (not tested!) * OMPathLocal & OMCSessionRunner * OMPathBash & OMCSessionRunner * OMPathBash & OMCSessionRunner in docker * OMPathBash & OMCSessionRunner in WSL (not tested!)

syntron · 2026-02-09T22:23:44Z

Some status update on this PR - the main points are:

Define a runner functionality which allows to run compiled (binary) models without OMC (see PR Enable the usage of a pre-built model executables by ModelicaSystemRunner #401 / @joewa)
Allow compatibility with OMPython 4.0.0 by defining a support layer on top of the latest code (see [OMCSession*] renames #384 (comment); @casella)

The code defined here updates the internal structure of OMPython such that:

generic code is separated in ABC classes
derived code exists for OMC usage and Runner usage
a compatibility layer exists such that the interface of OMPython 4.0.0 is (basically) supported; this is tested using the original unittests from v4.0.0

Furthermore, as OMCPath is working only for Python >= 3.12, another dimension exists. There is a dummy implementation of OMCPath for Python < 3.12 such that most of the functionality can also be used here. See PR #401 for a hint that even older Python version are used (Python 3.10 or even lower).

These changes could be the baseline for a new documentation (see https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/ompython.html). My idea was to include these changes as 4.x.0 and create a cut at the next release (or keep some kind of compatibility layer alive).

(partly from the discussion in PR #387)

syntron · 2026-02-09T22:26:46Z

The failed test is due to Windows - it runs well for v4.0.0 (see: https://github.com/syntron/OMPython/actions/runs/21842400755) and 4.x.x (see: https://github.com/syntron/OMPython/actions/runs/21841418638)

syntron mentioned this pull request Jan 11, 2026

Enable the usage of a pre-built model executables by ModelicaSystemRunner #401

Open

joewa mentioned this pull request Jan 11, 2026

Syntron rfc joewa/OMPython#1

Merged

syntron force-pushed the syntron_RFC branch from d81e33b to 7b68938 Compare February 6, 2026 22:32

syntron added 27 commits February 7, 2026 15:54

[OMParser] cleanup usage of Dict

8f3a5fc

[OMParser] remove import sys

9a21043

[OMParser] basic pylint fixes

0ae0a4b

[OMParser] optimise code in make_values()

e9c5b07

[test_ModelicaSystemCmd] update unittest

c592e39

[ModelExecutionData] include the original exception if reraised as Mo…

598aabb

…delExecutionException

[OMCPathReal] remove dummy function stat()

6f692e4

[OMCSession] add get_version() and get_workdir()

b694ec0

* this prepares a version of OMCSession which is independend of OMC as these functions where the last two which needed sendExpression() in basic ModelicaSystem functionality

[ModelicaSystem] update handling of outputs and continuous data

57d9768

* store data as numpy.float64 - allows to define None values * split get*() function into Initial values and Final values

[ModelicaSystem] use KeyError in getOutputsFinal()

931405c

[ModelicaSystem] use KeyError in getContinuousFinal()

56a1d09

[ModelicaSystem] fix docstring of getContinuous()

bf7ac80

[test_ModelicaSystem.py] needed changes due to update of output / con…

1cf9d37

…tinuous data handling

[ModelicaSystem] define check_model_executable() - test if the model …

578130f

…existable exists and can be executed

[ModelicaSystemDoE] simplify definition; use a Modelicasystem instanc…

9641ad4

…e as argument

[ModelicaSystemDoE] update docstring

9599b3f

[ModelicaSystemDoE] fix for relative paths

4ebe762

[ModelicaSystemDoE] fix unittest

96d9ad1

* test_ModelicaSystemDoE_local is tested * test_ModelicaSystemDoE_docker should work * test_ModelicaSystemDoE_WSL is untested

[ModelicaSystemOMC] add docstring for sendExpression()

6f89459

[ModelicaSystemBase] define parse_om_version() as staticmethod

5439eb3

[ModelicaSystemBase] include the original exception if reraised as Mo…

e1f5a63

…delExecutionException

[OMCSession] fix import order; zmq is a 3rd party package

f70c37c

Merge branch 'OMCPath_remove_stat' into v4.1.0-status20260207

5316792

Merge branch 'ModelicaSystem_cleanup' into v4.1.0-status20260207

0465dbd

Merge branch 'ModelicaSystem_getContinuous_getOutputs' into v4.1.0-st…

11b132c

…atus20260207

Merge branch 'ModelExecution' into v4.1.0-status20260207

8c479f6

syntron added 26 commits February 9, 2026 22:07

[OMCSessionZMQ] move class definition such that it can be derived fro…

fcbf004

…m OMSessionABC * needed for the compatibility layer

[OMPathABC] improve definition

bc7d67e

* add get_session() * fix return values

[(_)OMCPath] improve definition

cec15a9

* check return value from OMC * define return value for methods

[(_)OMPathRunnerLocal] improve definition

bd74eef

* fix return values * additional cleanups

[__init__] define OMPathRunnerLocal for public interface

1ad349a

[_OMPathRunnerBash] define class

f9580af

[__init__] define OMPathRunnerBash for public interface

f33cc56

[OMSessionRunner] update code such that it can be used by OMPathRunne…

ea3b8b9

…rLocal and OMPathRunner Bash

[OMCSessionPort] fix timeout handling

5396e6f

[OMCSessionDocker*] improve data handling

ca39353

* move more code to OMCSessionDockerHelper * use _docker_omc_start() to differentiate classes * define cmd_prefix

[OMCSessionWSL] define cmd_prefix

c367e2d

[OMCSessionWSL] layout fix

0c4cbd6

[ModelicaSystemABC] reorder code in __init__()

c2e6623

[ModelicaSystem*] linter fixes

5328fab

[OMTypedParser] compatibility layer

123ddd8

[__init__/OMCSession] prepare compatibility layer

65ae825

[ModelicaSystem] define as compatibility layer

abed1db

[ModelicaSystemCmd] define as compatibility layer

73c5062

[test_*] reorder imports

1084f3e

[tests_ModelicaDoE*] fix pylint hint

10d33fd

* use .items()

[tests_*] use OMSessionABC.get_version()

75c1e27

[test_ModelicaSystemCmd] use get_model_name() instead of access to pr…

6d59d2c

…ivate variable _model_name

[test_ModelicaSystemOMC] read file using utf-8 encoding / linter fix

20bb002

[test_ModelicaSystemRunner] update test case

f14d022

* ModelicaSystemRunner & OMCPath * ModelicaSystemRunner & OMPathRunnerLocal * ModelicaSystemRunner & OMPathRunnerBash * ModelicaSystemRunner & OMPathRunnerBash using docker * ModelicaSystemRunner & OMPathRunnerBash using WSL (not tested!)

add workflow to run unittests in ./tests

0deda10

syntron force-pushed the syntron_RFC branch from 6ef0900 to 0deda10 Compare February 9, 2026 22:13

syntron mentioned this pull request Feb 9, 2026

Remove OMCSessionZMQ #387

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RFC - definition of a runner class using as much of the existing code as possible #404

RFC - definition of a runner class using as much of the existing code as possible #404

Uh oh!

syntron commented Jan 11, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

RFC - definition of a runner class using as much of the existing code as possible #404

Are you sure you want to change the base?

RFC - definition of a runner class using as much of the existing code as possible #404

Uh oh!

Conversation

syntron commented Jan 11, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

syntron commented Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant