RFC - definition of a runner class using as much of the existing code as possible by syntron · Pull Request #404 · OpenModelica/OMPython

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

…e as argument

…delExecutionException

…onZMQ

…mmand) the following classes are not changed - these are obsolete: - OMCSessionZMQ - OMCSessionCmd

adeas31 · 2026-02-18T15:46:55Z

looks good

OK; I will create small parts for review & merge; there are some changes on top to restructure the two main files

Sorry I haven't got time to look into this yet.
As I understand, you will break this into new smaller PRs for review & merge, right?

syntron · 2026-02-18T17:57:53Z

Sorry I haven't got time to look into this yet. As I understand, you will break this into new smaller PRs for review & merge, right?

yes - this is the plan; the one RFC is way too big / too much changes to get an easy overview ...

syntron · 2026-02-18T17:59:39Z

Summary of the changes in these RFC; the elements will be provided as single PRs.

Basic concept / plan:

Define a Runner variant which allows to run compiled (binary) models without usage of an OMC server
Split all code into 3 parts: ABC (generic code), OMC related, Runner related
Define a compatibility layer which provides OMPython v4.0.0 compatibility

This means for some period of time, the new interface and the compatibility layer can exist in parallel (versions
4.x.x). Thus, errors can be found & fixed and people can adapt to the new interface before it is the only option.

Steps for the implementation (see PRs below):

(A) independent PRs based on current master; together these build the baseline for (B) and further
(B) split classes into ABC / OMC related
(C) define Runner part
(D) use unittests from v4.0.0 as reference / prepare compatibility layer
(E) prepare & split files (move classes around)
(F) cleanup after changes
(G) move all depreciated code into the compatibility layer
(H) removal of compatibility layer for a OMPython v5.0.0 (merged later)

I tried to order the PRs based on the steps (A) to (H) but some will be out of order. If the PRs are merged, please try
to follow the numbering.

PRs based on this RFC (using the branch name in my fork syntron:OMPython as reference; I will use this comment to link the PRs step by step):

(step A)

(A001) simplify_workflow_Test
(A002) OMParser
(A003) OMTypedParser
(A004) ModelicaSystem_okey_oval
(A005) OMCPath_remove_stat
(A006) OMCSession_small_fixes
(A007) ModelicaSystem_cleanup
(A008) ModelicaSystem_getContinuous_getOutputs
(A009) ModelicaSystem_small_fixes
(A000) use_function_keyword_arguments
(A011) update_init_docstring
(A012) reorder_imports
(A013) ModelicaSystemDoE
(A014) ModelExecution
(A015) ModelicaSystem_check_model_executable

(step B)

(B001) ModelicaSystem_split
(B002) ModelicaSystemDoE_split
(B003) OMCSession_OMPathABC
(B004) OMCSession_OMSessionABC

(step C)

(C001) Runner_definitions

(step D)

(D001) OMSession_small_fixes
(D002) OMSessionZMQ_move
(D003) OMCPath_improve
(D004) OMSessionRunner
(D005) OMCSession_classes_update
(D006) ModelicaSystem_small_fixes2
(D007) test_v400
(D008) v400_compatibility_layer

(step E)

(E001) update_tests
(E002) prepare_restructure
(E003) restructure

(step F)

(F001) restructure_cleanup

=> status syntron_RFC

step G & H are still to be reordered

syntron · 2026-02-18T18:42:05Z

PRs of step A:

(A001) simplify_workflow_Test - PR #411
(A002) OMParser - PR #412
(A003) OMTypedParser - PR #413
(A004) ModelicaSystem_okey_oval - PR #414
(A005) OMCPath_remove_stat - PR #415
(A006) OMCSession_small_fixes - PR #416
(A007) ModelicaSystem_cleanup - PR #417
(A008) ModelicaSystem_getContinuous_getOutputs - PR #418
(A009) ModelicaSystem_small_fixes - PR #419
(A011) update_init_docstring - PR #421
(A012) reorder_imports - PR #422
(A013) ModelicaSystemDoE - PR #423

moved to the end / rebase needed:
(A010) use_function_keyword_arguments - PR #420
(A014) ModelExecution - PR #424
(A015) ModelicaSystem_check_model_executable - PR #425

The final state can be found at https://github.com/syntron/OMPython/tree/mergeA

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 26 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

[ModelicaSystemDoE] simplify definition; use a Modelicasystem instanc…

9641ad4

…e as argument

[ModelicaSystemDoE] update docstring

9599b3f

[ModelicaSystemDoE] fix for relative paths

4ebe762

[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

[OMCSession] use function keyword arguments if possible

7be0970

[ModelicaSystem] use function keyword arguments if possible

2b1290f

update docstring of __init__.py - do not promote depreciated OMCSessi…

ea6fad5

…onZMQ

reorder imports in __init__.py

7c949d6

[OMCSession] align definition of sendExpression() - use expr (was: co…

e078fa3

…mmand) the following classes are not changed - these are obsolete: - OMCSessionZMQ - OMCSessionCmd

syntron force-pushed the syntron_RFC branch from 7b68938 to a996096 Compare February 8, 2026 11:34

syntron added 9 commits February 17, 2026 21:20

[OMCSessionZMQ] call super()__init__()

a245bbd

[OMCPath] fix forward dependency on OMCSessionLocal

793c2c7

[OMSessionException] rename from OMCSessionException

5cd9793

[__init__] fix imports

1ed71d4

[ModelExecution*] move classes into model_execution.py

8756e92

[OMCSession] split file

8489a32

[ModelicaSystem] split file

56a735c

[README.md] small updates

219eae3

[__init__] small updates

4568c87

syntron force-pushed the syntron_RFC branch from b20568b to 4568c87 Compare February 17, 2026 20:32

syntron marked this pull request as draft February 18, 2026 18:16

This was referenced Feb 18, 2026

(A001) Simplify workflow for unittests #411

Open

(A002) OMParser #412

Open

(A003) [OMTypedParser] fix PyparsingDeprecationWarning(s) + reorder imports #413

Open

(A004) [ModelicaSystemCmd] do not reuse variable names (key/val) #414

Open

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
syntron wants to merge 131 commits intoOpenModelica:masterfrom
syntron:syntron_RFC

syntron commented Jan 11, 2026

Uh oh!

adeas31 commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026 •

edited

Loading

Uh oh!

syntron commented Feb 18, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

syntron commented Jan 11, 2026

Uh oh!

adeas31 commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026

Uh oh!

syntron commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

syntron commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

syntron commented Feb 18, 2026 •

edited

Loading

syntron commented Feb 18, 2026 •

edited

Loading