[ModelicaSystem] rename variables

Author: syntron

OMPython/ModelicaSystem.py

@@ -389,8 +389,8 @@ def __init__(
 
     def model(
             self,
-            name: str,
-            file: Optional[str | os.PathLike] = None,
+            model_name: str,
+            model_file: Optional[str | os.PathLike] = None,
             libraries: Optional[list[str | tuple[str, str]]] = None,
             variable_filter: Optional[str] = None,
             build: bool = True,
@@ -400,9 +400,9 @@ def model(
         This method loads the model file and builds it if requested (build == True).
 
         Args:
-            file: Path to the model file. Either absolute or relative to
+            model_file: Path to the model file. Either absolute or relative to
               the current working directory.
-            name: The name of the model class. If it is contained within
+            model_name: The name of the model class. If it is contained within
               a package, "PackageName.ModelName" should be used.
             libraries: List of libraries to be loaded before the model itself is
               loaded. Two formats are supported for the list elements:
@@ -428,7 +428,7 @@ def model(
             raise ModelicaSystemError("Can not reuse this instance of ModelicaSystem "
                                       f"defined for {repr(self._model_name)}!")
 
-        if not isinstance(name, str):
+        if not isinstance(model_name, str):
             raise ModelicaSystemError("A model name must be provided!")
 
         if libraries is None:
@@ -438,16 +438,16 @@ def model(
             raise ModelicaSystemError(f"Invalid input type for libraries: {type(libraries)} - list expected!")
 
         # set variables
-        self._model_name = name  # Model class name
+        self._model_name = model_name  # Model class name
         self._libraries = libraries  # may be needed if model is derived from other model
         self._variable_filter = variable_filter
 
         if self._libraries:
             self._loadLibrary(libraries=self._libraries)
 
         self._file_name = None
-        if file is not None:
-            file_path = pathlib.Path(file)
+        if model_file is not None:
+            file_path = pathlib.Path(model_file)
             # special handling for OMCProcessLocal - consider a relative path
             if isinstance(self._session.omc_process, OMCProcessLocal) and not file_path.is_absolute():
                 file_path = pathlib.Path.cwd() / file_path
@@ -1676,8 +1676,8 @@ def convertFmu2Mo(
             raise ModelicaSystemError(f"Missing file {filepath.as_posix()}")
 
         self.model(
-            name=f"{fmu_path.stem}_me_FMU",
-            file=filepath,
+            model_name=f"{fmu_path.stem}_me_FMU",
+            model_file=filepath,
         )
 
         return filepath
@@ -1951,8 +1951,8 @@ def __init__(
             omc_process=omc_process,
         )
         self._mod.model(
-            file=fileName,
-            name=modelName,
+            model_file=fileName,
+            model_name=modelName,
             libraries=lmodel,
             variable_filter=variableFilter,
         )

tests/test_FMIExport.py

@@ -7,7 +7,7 @@
 def test_CauerLowPassAnalog():
     mod = OMPython.ModelicaSystem()
     mod.model(
-        name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
+        model_name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
         libraries=["Modelica"],
     )
     tmp = pathlib.Path(mod.getWorkDirectory())
@@ -21,7 +21,7 @@ def test_CauerLowPassAnalog():
 def test_DrumBoiler():
     mod = OMPython.ModelicaSystem()
     mod.model(
-        name="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler",
+        model_name="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler",
         libraries=["Modelica"],
     )
     tmp = pathlib.Path(mod.getWorkDirectory())

tests/test_FMIImport.py

@@ -24,7 +24,7 @@ def test_FMIImport(model_firstorder):
 
     # create model & simulate it
     mod1 = OMPython.ModelicaSystem()
-    mod1.model(file=filePath, name="M")
+    mod1.model(model_file=filePath, model_name="M")
     mod1.simulate()
 
     # create FMU & check

tests/test_ModelicaSystem.py

@@ -40,8 +40,8 @@ def worker():
         filePath = model_firstorder.as_posix()
         mod = OMPython.ModelicaSystem()
         mod.model(
-            file=filePath,
-            name="M",
+            model_file=filePath,
+            model_name="M",
         )
         mod.simulate()
         mod.convertMo2Fmu(fmuType="me")
@@ -55,8 +55,8 @@ def test_setParameters():
     model_path = omc.omcpath(model_path_str)
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_path / "BouncingBall.mo",
-        name="BouncingBall",
+        model_file=model_path / "BouncingBall.mo",
+        model_name="BouncingBall",
     )
 
     # method 1 (test depreciated variants)
@@ -90,8 +90,8 @@ def test_setSimulationOptions():
     model_path = omc.omcpath(model_path_str)
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_path / "BouncingBall.mo",
-        name="BouncingBall",
+        model_file=model_path / "BouncingBall.mo",
+        model_name="BouncingBall",
     )
 
     # method 1
@@ -127,8 +127,8 @@ def test_relative_path(model_firstorder):
 
         mod = OMPython.ModelicaSystem()
         mod.model(
-            file=model_relative,
-            name="M",
+            model_file=model_relative,
+            model_name="M",
         )
         assert float(mod.getParameters("a")[0]) == -1
     finally:
@@ -141,8 +141,8 @@ def test_customBuildDirectory(tmp_path, model_firstorder):
     tmpdir.mkdir()
     mod = OMPython.ModelicaSystem(customBuildDirectory=tmpdir)
     mod.model(
-        file=filePath,
-        name="M",
+        model_file=filePath,
+        model_name="M",
     )
     assert pathlib.Path(mod.getWorkDirectory()).resolve() == tmpdir.resolve()
     result_file = tmpdir / "a.mat"
@@ -161,8 +161,8 @@ def test_getSolutions_docker(model_firstorder):
         omc_process=omc.omc_process,
     )
     mod.model(
-        name="M",
-        file=model_firstorder.as_posix(),
+        model_file=model_firstorder,
+        model_name="M",
     )
 
     _run_getSolutions(mod)
@@ -171,8 +171,8 @@ def test_getSolutions_docker(model_firstorder):
 def test_getSolutions(model_firstorder):
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_firstorder.as_posix(),
-        name="M",
+        model_file=model_firstorder,
+        model_name="M",
     )
 
     _run_getSolutions(mod)
@@ -219,8 +219,8 @@ def test_getters(tmp_path):
 """)
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_file.as_posix(),
-        name="M_getters",
+        model_file=model_file.as_posix(),
+        model_name="M_getters",
     )
 
     q = mod.getQuantities()
@@ -415,8 +415,8 @@ def test_simulate_inputs(tmp_path):
 """)
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_file.as_posix(),
-        name="M_input",
+        model_file=model_file.as_posix(),
+        model_name="M_input",
     )
 
     simOptions = {"stopTime": 1.0}

tests/test_ModelicaSystemCmd.py

@@ -19,8 +19,8 @@ def model_firstorder(tmp_path):
 def mscmd_firstorder(model_firstorder):
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_firstorder.as_posix(),
-        name="M",
+        model_file=model_firstorder.as_posix(),
+        model_name="M",
     )
     mscmd = OMPython.ModelicaSystemCmd(
         session=mod.session(),

tests/test_OMSessionCmd.py

@@ -10,7 +10,7 @@ def test_isPackage():
 def test_isPackage2():
     mod = OMPython.ModelicaSystem()
     mod.model(
-        name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
+        model_name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
         libraries=["Modelica"],
     )
     omccmd = OMPython.OMCSessionCmd(session=mod.session())

tests/test_linearization.py

@@ -26,8 +26,8 @@ def model_linearTest(tmp_path):
 def test_example(model_linearTest):
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_linearTest,
-        name="linearTest",
+        model_file=model_linearTest,
+        model_name="linearTest",
     )
     [A, B, C, D] = mod.linearize()
     expected_matrixA = [[-3, 2, 0, 0], [-7, 0, -5, 1], [-1, 0, -1, 4], [0, 1, -1, 5]]
@@ -61,8 +61,8 @@ def test_getters(tmp_path):
 """)
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_file.as_posix(),
-        name="Pendulum",
+        model_file=model_file.as_posix(),
+        model_name="Pendulum",
         libraries=["Modelica"],
     )
 

tests/test_optimization.py

@@ -35,8 +35,8 @@ def test_optimization_example(tmp_path):
 
     mod = OMPython.ModelicaSystem()
     mod.model(
-        file=model_file.as_posix(),
-        name="BangBang2021",
+        model_file=model_file.as_posix(),
+        model_name="BangBang2021",
     )
 
     optimizationOptions = {