Skip to content

ModelicaSystem - use OMCPath #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 53 commits into
base: master
Choose a base branch
from
Open

ModelicaSystem - use OMCPath #322

wants to merge 53 commits into from

Conversation

syntron
Copy link
Contributor

@syntron syntron commented Jul 11, 2025 •
edited
Loading

A big step on the way to run ModelicaSystem not only locally; see #315 item (1):

  1. need of file system interactions => solution: create OMCPath, an implementation of a pathlib.Path object which uses OMC as backend (see detailed analyses which functionality is needed in PR [ModelicaSystem] only local omc process allowed #309)

based on PR #317, #314, #320 and #321

addditional requirements: PR #329 and PR #330

@syntron syntron force-pushed the ModelicaSystem_use_OMCPath branch from f1695a9 to 466740c Compare July 12, 2025 14:22
This was referenced Jul 12, 2025
Open
Open
@syntron syntron force-pushed the ModelicaSystem_use_OMCPath branch from 466740c to 3278b53 Compare July 22, 2025 18:38
@syntron syntron force-pushed the ModelicaSystem_use_OMCPath branch 4 times, most recently from 74f1c4e to 17baf1a Compare August 12, 2025 20:12
@syntron syntron marked this pull request as ready for review August 12, 2025 20:29
@syntron syntron force-pushed the ModelicaSystem_use_OMCPath branch from 17baf1a to 082be04 Compare August 14, 2025 20:19
syntron added 20 commits August 16, 2025 14:49
@syntron
[OMCPath] add class
c12c277
@syntron
[OMCPath] add implementation using OMC via sendExpression()
908a239
@syntron
[OMCPath] add pytest (only docker at the moment)
00d016f
@syntron
[OMCPath] TODO items
a449445
@syntron
[test_OMCPath] mypy fix
17c9ee8
@syntron
[test_OMCPath] fix end of file
942635e
@syntron
[test_OMCPath] define test using OMCSessionZMQ() locally
11b2524
@syntron
add TODO - need to check Python versions
05b3c4d 
* not working: 3.10
* working:     3.12
@syntron
[test_OMCPath] activate docker based on test_docker
79e118a
@syntron
[OMCPath] add more functionality and docstrings
e0cb453
@syntron
[OMCPath] remove TODO entries
2b86442
@syntron
[OMCPath] define limited compatibility for Python < 3.12
a9fb9f9 
* use modified pathlib.Path as OMCPath
@syntron
[OMCSEssionZMQ] use OMCpath
fcb8571
@syntron
[OMCSessionZMQ] create a tempdir using omcpath_tempdir()
51b9160
@syntron
[OMCPath] fix mypy
dd9afed
@syntron
[OMCPath] add warning message for Python < 3.12
dc0393e
@syntron
[OMCPath] try to make mypy happy ...
6ff54d3
@syntron
[test_OMCPath] only for Python >= 3.12
c4323b3
@syntron
[test_OMCPath] update test
ec552dd
@syntron
[OMCPath._omc_resolve] use sendExpression() with parsed=False
3b99f2f 
* this is scripting output and, thus, it cannot be parsed
syntron added 28 commits August 16, 2025 14:49
@syntron
[OMCSession*] fix flake8 (PyCharm likes the empty lines)
1de0e3b
@syntron
[OMCSessionZMQ] more generic definiton for omcpath_tempdir()
8f38def
@syntron
[OMCPathCompatibility] mypy on github ...
9dc161b
@syntron
[OMCPathCompatibility] improve log messages
fd906cc
@syntron
[test_OMCPath] update
90f8c98
@syntron
[OMCPathReal] align exists() to the definition used in pathlib
b2a9190
@syntron
[test_OMCPath] fix error
b11bfa9 
error: "unlink" of "OMCPathReal" does not return a value (it only ever returns None)  [func-returns-value]
@syntron
[ModelicaSystem] update handling of work directory
26e73f6 
* use as input str or os.PathLike; the later covers all pathlib objects
* rename _tempdir to _work_dir
* rename setTempDirectory() => setWorkDirectory()
* setWorkDirectory() sets the work dir and also returns its path
* use setWorkDirectory() within code; this allows to add special handling
  to the function if needed
@syntron
[ModelicaSystem] update handling of xml_file
a9442b5
@syntron
[ModelicaSystem] replace ET.parse() with ET.ElementTree(ET.fromstring())
c4fabc5 
read the file content and work on this string

see: https://stackoverflow.com/questions/647071/python-xml-elementtree-from-a-string-source
@syntron
[ModelicaSystem._xmlparse] mypy fixes & cleanup
3133f61
@syntron
[ModelicaSystem] remove class variable _xml_file
33ea460
@syntron
[ModelicaSystem] fix mypy warning - value can have different types in…
fa1f453 
… this code (int or str)
@syntron
[ModelicaSystem] do not use package csv
250870c 
background: if OMCPath will be used, it is not available
@syntron
[ModelicaSystem] create override file using pathlib.Path.write_text()
66b9df3 
background: open() is not available if OMCPath is used
@syntron
[ModelicaSystem] update handling of override file
a676435 
* define file name based on result file name & Path
* simplify code
@syntron
Merge branch 'ModelicaSystem_workdir' into ModelicaSystemCmd_use_OMCPath
6b55beb
@syntron
Merge branch 'ModelicaSystem_xml' into ModelicaSystemCmd_use_OMCPath
0ffa36b
@syntron
Merge branch 'ModelicaSystem_prepare_OMCPath' into ModelicaSystemCmd_…
3eb80f7 
…use_OMCPath
@syntron
[ModelicaSystem] update handling of override file
4384fa5 
* define file name based on result file name & Path
* simplify code
@syntron
[ModelicaSystem] fix rebase fallout 2
6617ab2
@syntron
[test_ModelicaSystem] fix test_customBuildDirectory()
3022e65
@syntron
[ModelicaSystem] fix blank lines (flake8)
daa3caf
@syntron
[test_optimization] fix due to OMCPath usage
f627daf
@syntron
[test_FMIExport] fix due to OMCPath usage
47dd995
@syntron
[ModelicaSystem] improve definition of getSolution
d42753e 
* allow different ways to define the path
@syntron
[ModelicaSystem] use OMCPath for nearly all file system interactions
229d624 
remove pathlib - use OMCPath and (for type hints) os.PathLike
@syntron
[ModelicaSystem] improve result file handling in simulate()
087db3d
@syntron syntron force-pushed the ModelicaSystem_use_OMCPath branch from 082be04 to 087db3d Compare August 16, 2025 13:26
@adeas31 adeas31 added this to the 4.1.0 milestone Aug 18, 2025
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
4.1.0
Development

Successfully merging this pull request may close these issues.
2 participants
@syntron @adeas31