Skip to content

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

Draft
syntron wants to merge 56 commits intoOpenModelica:masterfrom
syntron:syntron_RFC
Draft

RFC - definition of a runner class using as much of the existing code as possible#404
syntron wants to merge 56 commits intoOpenModelica:masterfrom
syntron:syntron_RFC

Conversation

@syntron
Copy link
Contributor

@syntron syntron commented Jan 11, 2026

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!

@syntron syntron mentioned this pull request Jan 11, 2026
Open
@joewa joewa mentioned this pull request Jan 11, 2026
Merged
syntron added 28 commits January 18, 2026 19:20
@syntron
[ModelExecution*] create classes to handle model execution
ed74d54 
* 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()
@syntron
[test_ModelicaSystemCmd] update unittest
3f4f80e
@syntron
[OMCSession] add get_version() and get_workdir()
5468f46 
* 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
@syntron
[OMCPathReal] remove dummy function stat()
fbd7f28
@syntron
[OMCSession] use function keyword arguments if possible
de0e3c2
@syntron
[ModelicaSystem] use function keyword arguments if possible
6dd7815
@syntron
update docstring of __init__.py - do not promote depreciated OMCSessi…
1af6916 
…onZMQ
@syntron
[ModelicaSystem] update handling of outputs and continuous data
5587e8c 
* store data as numpy.float64 - allows to define None values
* split get*() function into Initial values and Final values
@syntron
[ModelicaSystem] use KeyError in getOutputsFinal()
96ad82c
@syntron
[ModelicaSystem] use KeyError in getContinuousFinal()
595ee5c
@syntron
[ModelicaSystem] fix docstring of getContinuous()
91841bb
@syntron
[test_ModelicaSystem.py] needed changes due to update of output / con…
7c7fed5 
…tinuous data handling
@syntron
[ModelExecutionData] include the original exception if reraised as Mo…
41dda2b 
…delExecutionException
@syntron
[ModelicaSystem] define check_model_executable() - test if the model …
ff35a8b 
…existable exists and can be executed
@syntron
Merge branch 'OMCPath_remove_stat' into v4.2.0-status20260124
eb56b86
@syntron
Merge branch 'ModelicaSystem_cleanup' into v4.2.0-status20260124
b789248
@syntron
Merge branch 'use_function_keyword_arguments' into v4.2.0-status20260124
c7e1662
@syntron
Merge branch 'update_init_docstring' into v4.2.0-status20260124
f02a559
@syntron
Merge branch 'ModelicaSystem_getContinuous_getOutputs' into v4.2.0-st…
ddf345c 
…atus20260124
@syntron
Merge branch 'ModelicaSystem_check_model_executable' into v4.2.0-stat…
f38e243 
…us20260124
@syntron
[ModelicaSystemDoE] simplify definition; use a Modelicasystem instanc…
4a2eaca 
…e as argument
@syntron
[ModelicaSystemDoE] update docstring
a98f4fd
@syntron
[ModelicaSystemDoE] fix for relative paths
a80d543
@syntron
[ModelicaSystemDoE] fix unittest
117b01a 
* test_ModelicaSystemDoE_local is tested
* test_ModelicaSystemDoE_docker should work
* test_ModelicaSystemDoE_WSL is untested
@syntron
Merge branch 'ModelicaSystemDoE' into v4.2.0-status20260124
cf1529a
@syntron
[ModelicaSystemOMC] add docstring for sendExpression()
f5f2bb5
@syntron
[ModelicaSystemBase] define parse_om_version() as staticmethod
79d842e
@syntron
[ModelicaSystemBase] include the original exception if reraised as Mo…
44d50b2 
…delExecutionException
syntron added 28 commits January 24, 2026 15:22
@syntron
[ModelicaSystem] fix order of imports
48eab90
@syntron
Merge branch 'ModelicaSystem_small_fixes' into v4.2.0-status20260124
94fc5c3
@syntron
[OMCSession] fix import order; zmq is a 3rd party package
70e3b76
@syntron
Merge branch 'OMCSession_small_fixes' into v4.2.0-status20260124
a5244b1
@syntron
[ModelicaSystem] split ModelicaSystem into ModelicaSystemABC and Mode…
873cbb8 
…licaSystem
@syntron
[ModelicaSystem] rename ModelicaSystem => ModelicaSystemOMC
9abf38d 
* add compatibility variable for ModelicaSystem
@syntron
[test_ModelicaSystemOMC] rename from ModelicaSystem and update
991adf2
@syntron
[test_*] use ModelicaSystemOMC
46ef920
@syntron
[ModelicaSystem] split ModelicaSystemDoE into ModelicaDoEABC and Mode…
e499308 
…licaDoE
@syntron
[ModelicaSystem] rename ModelicaSystemDoE => ModelicaDoEOMC
59c3471 
* add compatibility variable for ModelicaSystemDoE
@syntron
[test_ModelicaDoEOMC] rename from ModelicaSystemDoE and update
4bce6d7
@syntron
[ModelicaSystem] update ModelicaDoEABC to use ModelicaSystemABC
52b6403
@syntron
[ModelicaSystem] define doe_get_solutions() as separate method
90bb065
@syntron
[OMCSession] update OMCPath to use OMPathABC as baseline and further …
b99ef6e 
…cleanup
@syntron
[ModelicaSystem] shortcut to use OMCPath = OMPathABC for now
3f48c24
@syntron
[ModelicaSystem] fix usage of OMCPath; replace by OMPathABC
571ce75
@syntron
[ModelicaSystem] define (_)simulate_cmd() as private function
b337e8c
@syntron
Merge branch 'ModelicaSystem_simulate_cmd' into OMCSession_OMPathABC
9a42128
@syntron
[OMCSession] update OMCSession* to use OMSessionABC as baseline and f…
d6eb0e3 
…urther cleanup
@syntron
[ModelicaSystem] shortcut to use OMCSession = OMSessionABC for now
bb73a89
@syntron
[ModelicaSystem] fix usage of OMCSession; replace by OMSessionABC
4256238
@syntron
[OMCSession] add *Runner related classes for OMPath and OMSession
d21e7df
@syntron
[ModelicaSystem] add ModelicaSystemRunner
2fb4bc1
@syntron
[test_ModelicaSystemRunner] add test case for ModelicaSystemRunner
a22ad1c
@syntron
[ModelicaSystem] add ModelicaDoERunner
7cfe79c
@syntron
[test_ModelicaDoERunner] add test case for ModelicaDoERunner
0da155d
@syntron
Revert "[ModelicaSystem] define (_)simulate_cmd() as private function"
be452d1 
This reverts commit b337e8c.
@syntron
syntron RFC status 2026/02/06
7b68938
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@syntron