Skip to content

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

Open
syntron wants to merge 134 commits intoOpenModelica:masterfrom
syntron:syntron_RFC
Open

RFC - definition of a runner class using as much of the existing code as possible#404
syntron wants to merge 134 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 27 commits February 7, 2026 15:54
@syntron
[OMParser] cleanup usage of Dict
8f3a5fc
@syntron
[OMParser] remove import sys
9a21043
@syntron
[OMParser] basic pylint fixes
0ae0a4b
@syntron
[OMParser] optimise code in make_values()
e9c5b07
@syntron
[ModelExecution*] create classes to handle model execution
52e522d 
* 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
c592e39
@syntron
[ModelExecutionData] include the original exception if reraised as Mo…
598aabb 
…delExecutionException
@syntron
[OMCPathReal] remove dummy function stat()
6f692e4
@syntron
[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
@syntron
[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
@syntron
[ModelicaSystem] use KeyError in getOutputsFinal()
931405c
@syntron
[ModelicaSystem] use KeyError in getContinuousFinal()
56a1d09
@syntron
[ModelicaSystem] fix docstring of getContinuous()
bf7ac80
@syntron
[test_ModelicaSystem.py] needed changes due to update of output / con…
1cf9d37 
…tinuous data handling
@syntron
[ModelicaSystem] define check_model_executable() - test if the model …
578130f 
…existable exists and can be executed
@syntron
[ModelicaSystemDoE] simplify definition; use a Modelicasystem instanc…
9641ad4 
…e as argument
@syntron
[ModelicaSystemDoE] update docstring
9599b3f
@syntron
[ModelicaSystemDoE] fix for relative paths
4ebe762
@syntron
[ModelicaSystemDoE] fix unittest
96d9ad1 
* test_ModelicaSystemDoE_local is tested
* test_ModelicaSystemDoE_docker should work
* test_ModelicaSystemDoE_WSL is untested
@syntron
[ModelicaSystemOMC] add docstring for sendExpression()
6f89459
@syntron
[ModelicaSystemBase] define parse_om_version() as staticmethod
5439eb3
@syntron
[ModelicaSystemBase] include the original exception if reraised as Mo…
e1f5a63 
…delExecutionException
@syntron
[OMCSession] fix import order; zmq is a 3rd party package
f70c37c
@syntron
Merge branch 'OMCPath_remove_stat' into v4.1.0-status20260207
5316792
@syntron
Merge branch 'ModelicaSystem_cleanup' into v4.1.0-status20260207
0465dbd
@syntron
Merge branch 'ModelicaSystem_getContinuous_getOutputs' into v4.1.0-st…
11b132c 
…atus20260207
@syntron
Merge branch 'ModelExecution' into v4.1.0-status20260207
8c479f6
syntron added 23 commits February 10, 2026 18:43
@syntron
[tests_ModelicaDoE*] fix pylint hint
82f9f01 
* use .items()
@syntron
[tests_*] use OMSessionABC.get_version()
715cb8a
@syntron
[test_ModelicaSystemCmd] use get_model_name() instead of access to pr…
f0e5d61 
…ivate variable _model_name
@syntron
[test_ModelicaSystemOMC] read file using utf-8 encoding / linter fix
4ab8bf5
@syntron
[test_ModelicaSystemRunner] update test case
2e435f3 
* ModelicaSystemRunner & OMCPath
* ModelicaSystemRunner & OMPathRunnerLocal
* ModelicaSystemRunner & OMPathRunnerBash
* ModelicaSystemRunner & OMPathRunnerBash using docker
* ModelicaSystemRunner & OMPathRunnerBash using WSL (not tested!)
@syntron
[test_OMCPath] update test case
44a10a3 
* 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
add workflow to run unittests in ./tests
1472540
@syntron
[test_OMParser] use only the public interface => om_parser_basci()
cfa3c12
@syntron
[test_OMTypedParser] rename file / use om_parser_typed()
2480a28
@syntron
update tests - do NOT run test_FMIRegression.py
6f179c1 
reason:
* it is only a test for OMC / not OMPython specific
* furthermore, it is run automatically via cron job (= FMITest)
@syntron
[ModelExecutionCmd] fix variable shadow
7ad9e9f
@syntron
[ModelicaSystemCmd] add missing docstring
535ef9d
@syntron
[OMCSession] spelling fixes
68c503b
@syntron
[OMCSessionCmd] add warning about depreciated class
d593729
@syntron
[OMCSessionABC] remove duplicated code; see OMSessionABC
b8032dc
@syntron
[OMSessionRunnerABC] define class
af54fc6
@syntron
[OMCSessionZMQ] call super()__init__()
da0cf41
@syntron
[OMCPath] fix forward dependency on OMCSessionLocal
ab37478
@syntron
[OMSessionException] rename from OMCSessionException
e1f25b7
@syntron
[__init__] fix imports
6a7f03b
@syntron
[ModelExecution*] move classes into model_execution.py
8440e25
@syntron
[OMCSession] split file
11ad83c
@syntron
[ModelicaSystem] split file
93994f9
@syntron
Copy link
Contributor Author

syntron commented Feb 13, 2026

This is a final version of my changes to get a 'runner' functionality to OMPython. The main parts:

  • Compatibility with OMPython v4.0.0
  • Split fucntions into ABC / OMC / Runner
  • Split the large files into smaller onces based on the usage

This PR will be splitted into smaller steps.

@syntron syntron marked this pull request as ready for review February 13, 2026 23:20
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