Merge branch 'master' into use_items

Author: adeas31

.github/workflows/FMITest.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
       - uses: actions/checkout@v5
       - name: "Set up OpenModelica Compiler"
-        uses: OpenModelica/setup-openmodelica@v1.0.2
+        uses: OpenModelica/setup-openmodelica@v1.0.4
         with:
           version: ${{ matrix.omc-version }}
           packages: |

.github/workflows/Test.yml

@@ -41,7 +41,7 @@ jobs:
         run: 'pre-commit run --all-files'
 
       - name: "Set up OpenModelica Compiler"
-        uses: OpenModelica/setup-openmodelica@v1.0.2
+        uses: OpenModelica/setup-openmodelica@v1.0.4
         with:
           version: ${{ matrix.omc-version }}
           packages: |

OMPython/ModelicaSystem.py

@@ -639,7 +639,8 @@ def sendExpression(self, command: str, parsed: bool = True) -> Any:
                 # see: https://build.openmodelica.org/Documentation/OpenModelica.Scripting.ErrorLevel.html
                 if log_level == 'error':
                     raise OMCSessionException(msg)
-                elif log_level == 'warning':
+
+                if log_level == 'warning':
                     logger.warning(msg)
                 elif log_level == 'notification':
                     logger.info(msg)
@@ -769,7 +770,7 @@ class OMCProcessLocal(OMCProcess):
     def __init__(
             self,
             timeout: float = 10.00,
-            omhome: Optional[str] = None,
+            omhome: Optional[str | os.PathLike] = None,
     ) -> None:
 
         super().__init__(timeout=timeout)
@@ -782,7 +783,7 @@ def __init__(
         self._omc_port = self._omc_port_get()
 
     @staticmethod
-    def _omc_home_get(omhome: Optional[str] = None) -> pathlib.Path:
+    def _omc_home_get(omhome: Optional[str | os.PathLike] = None) -> pathlib.Path:
         # use the provided path
         if omhome is not None:
             return pathlib.Path(omhome)
@@ -854,7 +855,7 @@ def __init__(
             self,
             timeout: float = 10.00,
             dockerExtraArgs: Optional[list] = None,
-            dockerOpenModelicaPath: str = "omc",
+            dockerOpenModelicaPath: str | os.PathLike = "omc",
             dockerNetwork: Optional[str] = None,
             port: Optional[int] = None,
     ) -> None:
@@ -864,7 +865,7 @@ def __init__(
             dockerExtraArgs = []
 
         self._dockerExtraArgs = dockerExtraArgs
-        self._dockerOpenModelicaPath = dockerOpenModelicaPath
+        self._dockerOpenModelicaPath = pathlib.PurePosixPath(dockerOpenModelicaPath)
         self._dockerNetwork = dockerNetwork
 
         self._interactivePort = port
@@ -970,7 +971,7 @@ def __init__(
             timeout: float = 10.00,
             docker: Optional[str] = None,
             dockerExtraArgs: Optional[list] = None,
-            dockerOpenModelicaPath: str = "omc",
+            dockerOpenModelicaPath: str | os.PathLike = "omc",
             dockerNetwork: Optional[str] = None,
             port: Optional[int] = None,
     ) -> None:
@@ -1053,7 +1054,7 @@ def _docker_omc_cmd(
                        ]
                        + self._dockerExtraArgs
                        + dockerNetworkStr
-                       + [self._docker, self._dockerOpenModelicaPath]
+                       + [self._docker, self._dockerOpenModelicaPath.as_posix()]
                        + omc_path_and_args_list
                        + extraFlags)
 
@@ -1113,7 +1114,7 @@ def __init__(
             timeout: float = 10.00,
             dockerContainer: Optional[str] = None,
             dockerExtraArgs: Optional[list] = None,
-            dockerOpenModelicaPath: str = "omc",
+            dockerOpenModelicaPath: str | os.PathLike = "omc",
             dockerNetwork: Optional[str] = None,
             port: Optional[int] = None,
     ) -> None:
@@ -1165,7 +1166,7 @@ def _docker_omc_cmd(self, omc_path_and_args_list) -> list:
                            "--user", str(self._getuid()),
                        ]
                        + self._dockerExtraArgs
-                       + [self._dockerCid, self._dockerOpenModelicaPath]
+                       + [self._dockerCid, self._dockerOpenModelicaPath.as_posix()]
                        + omc_path_and_args_list
                        + extraFlags)
 

OMPython/OMCSession.py

@@ -1,12 +1,13 @@
 import OMPython
 import shutil
 import os
+import pathlib
 
 
 def test_CauerLowPassAnalog():
     mod = OMPython.ModelicaSystem(modelName="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
                                   lmodel=["Modelica"])
-    tmp = mod.getWorkDirectory()
+    tmp = pathlib.Path(mod.getWorkDirectory())
     try:
         fmu = mod.convertMo2Fmu(fileNamePrefix="CauerLowPassAnalog")
         assert os.path.exists(fmu)
@@ -16,7 +17,7 @@ def test_CauerLowPassAnalog():
 
 def test_DrumBoiler():
     mod = OMPython.ModelicaSystem(modelName="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler", lmodel=["Modelica"])
-    tmp = mod.getWorkDirectory()
+    tmp = pathlib.Path(mod.getWorkDirectory())
     try:
         fmu = mod.convertMo2Fmu(fileNamePrefix="DrumBoiler")
         assert os.path.exists(fmu)

tests/test_FMIExport.py

@@ -34,9 +34,9 @@ def test_setParameters():
     model_path = omc.sendExpression("getInstallationDirectoryPath()") + "/share/doc/omc/testmodels/"
     mod = OMPython.ModelicaSystem(model_path + "BouncingBall.mo", "BouncingBall")
 
-    # method 1
-    mod.setParameters(pvals={"e": 1.234})
-    mod.setParameters(pvals={"g": 321.0})
+    # method 1 (test depreciated variants)
+    mod.setParameters("e=1.234")
+    mod.setParameters(["g=321.0"])
     assert mod.getParameters("e") == ["1.234"]
     assert mod.getParameters("g") == ["321.0"]
     assert mod.getParameters() == {
@@ -46,8 +46,9 @@ def test_setParameters():
     with pytest.raises(KeyError):
         mod.getParameters("thisParameterDoesNotExist")
 
-    # method 2
-    mod.setParameters(pvals={"e": 21.3, "g": 0.12})
+    # method 2 (new style)
+    pvals = {"e": 21.3, "g": 0.12}
+    mod.setParameters(**pvals)
     assert mod.getParameters() == {
         "e": "21.3",
         "g": "0.12",
@@ -64,8 +65,8 @@ def test_setSimulationOptions():
     mod = OMPython.ModelicaSystem(fileName=model_path + "BouncingBall.mo", modelName="BouncingBall")
 
     # method 1
-    mod.setSimulationOptions(simOptions={"stopTime": 1.234})
-    mod.setSimulationOptions(simOptions={"tolerance": 1.1e-08})
+    mod.setSimulationOptions(stopTime=1.234)
+    mod.setSimulationOptions(tolerance=1.1e-08)
     assert mod.getSimulationOptions("stopTime") == ["1.234"]
     assert mod.getSimulationOptions("tolerance") == ["1.1e-08"]
     assert mod.getSimulationOptions(["tolerance", "stopTime"]) == ["1.1e-08", "1.234"]
@@ -77,7 +78,7 @@ def test_setSimulationOptions():
         mod.getSimulationOptions("thisOptionDoesNotExist")
 
     # method 2
-    mod.setSimulationOptions(simOptions={"stopTime": 2.1, "tolerance": "1.2e-08"})
+    mod.setSimulationOptions(stopTime=2.1, tolerance=1.2e-08)
     d = mod.getSimulationOptions()
     assert d["stopTime"] == "2.1"
     assert d["tolerance"] == "1.2e-08"
@@ -105,7 +106,7 @@ def test_customBuildDirectory(tmp_path, model_firstorder):
     tmpdir = tmp_path / "tmpdir1"
     tmpdir.mkdir()
     m = OMPython.ModelicaSystem(filePath, "M", customBuildDirectory=tmpdir)
-    assert m.getWorkDirectory().resolve() == tmpdir.resolve()
+    assert pathlib.Path(m.getWorkDirectory()).resolve() == tmpdir.resolve()
     result_file = tmpdir / "a.mat"
     assert not result_file.exists()
     m.simulate(resultfile="a.mat")
@@ -119,7 +120,9 @@ def test_getSolutions(model_firstorder):
     a = -1
     tau = -1 / a
     stopTime = 5*tau
-    mod.setSimulationOptions(simOptions={"stopTime": stopTime, "stepSize": 0.1, "tolerance": 1e-8})
+
+    simOptions = {"stopTime": stopTime, "stepSize": 0.1, "tolerance": 1e-8}
+    mod.setSimulationOptions(**simOptions)
     mod.simulate()
 
     x = mod.getSolutions("x")
@@ -298,7 +301,7 @@ def test_getters(tmp_path):
     x0 = 1.0
     x_analytical = -b/a + (x0 + b/a) * np.exp(a * stopTime)
     dx_analytical = (x0 + b/a) * a * np.exp(a * stopTime)
-    mod.setSimulationOptions(simOptions={"stopTime": stopTime})
+    mod.setSimulationOptions(stopTime=stopTime)
     mod.simulate()
 
     # getOutputs after simulate()
@@ -327,7 +330,7 @@ def test_getters(tmp_path):
         mod.getContinuous("a")  # a is a parameter
 
     with pytest.raises(OMPython.ModelicaSystemError):
-        mod.setSimulationOptions(simOptions={"thisOptionDoesNotExist": 3})
+        mod.setSimulationOptions(thisOptionDoesNotExist=3)
 
 
 def test_simulate_inputs(tmp_path):
@@ -345,7 +348,8 @@ def test_simulate_inputs(tmp_path):
 """)
     mod = OMPython.ModelicaSystem(fileName=model_file.as_posix(), modelName="M_input")
 
-    mod.setSimulationOptions(simOptions={"stopTime": 1.0})
+    simOptions = {"stopTime": 1.0}
+    mod.setSimulationOptions(**simOptions)
 
     # integrate zero (no setInputs call) - it should default to None -> 0
     assert mod.getInputs() == {
@@ -357,7 +361,7 @@ def test_simulate_inputs(tmp_path):
     assert np.isclose(y[-1], 0.0)
 
     # integrate a constant
-    mod.setInputs(name={"u1": 2.5})
+    mod.setInputs(u1=2.5)
     assert mod.getInputs() == {
         "u1": [
             (0.0, 2.5),
@@ -374,7 +378,8 @@ def test_simulate_inputs(tmp_path):
     assert np.isclose(y[-1], 2.5)
 
     # now let's integrate the sum of two ramps
-    mod.setInputs(name={"u1": [(0.0, 0.0), (0.5, 2), (1.0, 0)]})
+    inputs = {"u1": [(0.0, 0.0), (0.5, 2), (1.0, 0)]}
+    mod.setInputs(**inputs)
     assert mod.getInputs("u1") == [[
         (0.0, 0.0),
         (0.5, 2.0),
@@ -387,17 +392,20 @@ def test_simulate_inputs(tmp_path):
     # let's try some edge cases
     # unmatched startTime
     with pytest.raises(OMPython.ModelicaSystemError):
-        mod.setInputs(name={"u1": [(-0.5, 0.0), (1.0, 1)]})
+        mod.setInputs(u1=[(-0.5, 0.0), (1.0, 1)])
         mod.simulate()
     # unmatched stopTime
     with pytest.raises(OMPython.ModelicaSystemError):
-        mod.setInputs(name={"u1": [(0.0, 0.0), (0.5, 1)]})
+        mod.setInputs(u1=[(0.0, 0.0), (0.5, 1)])
         mod.simulate()
 
     # Let's use both inputs, but each one with different number of
     # samples. This has an effect when generating the csv file.
-    mod.setInputs(name={"u1": [(0.0, 0), (1.0, 1)],
-                        "u2": [(0.0, 0), (0.25, 0.5), (0.5, 1.0), (1.0, 0)]})
+    inputs = {
+        "u1": [(0.0, 0), (1.0, 1)],
+        "u2": [(0.0, 0), (0.25, 0.5), (0.5, 1.0), (1.0, 0)],
+    }
+    mod.setInputs(**inputs)
     csv_file = mod._createCSVData()
     assert pathlib.Path(csv_file).read_text() == """time,u1,u2,end
 0.0,0.0,0.0,0

tests/test_ModelicaSystem.py

@@ -62,10 +62,10 @@ def test_getters(tmp_path):
     assert "startTime" in d
     assert "stopTime" in d
     assert mod.getLinearizationOptions(["stopTime", "startTime"]) == [d["stopTime"], d["startTime"]]
-    mod.setLinearizationOptions(linearizationOptions={"stopTime": 0.02})
+    mod.setLinearizationOptions(stopTime=0.02)
     assert mod.getLinearizationOptions("stopTime") == ["0.02"]
 
-    mod.setInputs(name={"u1": 10, "u2": 0})
+    mod.setInputs(u1=10, u2=0)
     [A, B, C, D] = mod.linearize()
     g = float(mod.getParameters("g")[0])
     l = float(mod.getParameters("l")[0])

tests/test_linearization.py

@@ -35,10 +35,13 @@ def test_optimization_example(tmp_path):
 
     mod = OMPython.ModelicaSystem(fileName=model_file.as_posix(), modelName="BangBang2021")
 
-    mod.setOptimizationOptions(optimizationOptions={"numberOfIntervals": 16,
-                                                    "stopTime": 1,
-                                                    "stepSize": 0.001,
-                                                    "tolerance": 1e-8})
+    optimizationOptions = {
+        "numberOfIntervals": 16,
+        "stopTime": 1,
+        "stepSize": 0.001,
+        "tolerance": 1e-8,
+    }
+    mod.setOptimizationOptions(**optimizationOptions)
 
     # test the getter
     assert mod.getOptimizationOptions()["stopTime"] == "1"
@@ -47,7 +50,9 @@ def test_optimization_example(tmp_path):
 
     r = mod.optimize()
     # it is necessary to specify resultfile, otherwise it wouldn't find it.
-    time, f, v = mod.getSolutions(["time", "f", "v"], resultfile=r["resultFile"])
+    resultfile_str = r["resultFile"]
+    resultfile_omcpath = mod._getconn.omcpath(resultfile_str)
+    time, f, v = mod.getSolutions(["time", "f", "v"], resultfile=resultfile_omcpath.as_posix())
     assert np.isclose(f[0], 10)
     assert np.isclose(f[-1], -10)