[ModelicaSystem] rename model_definition() => model()

Author: syntron

OMPython/ModelicaSystem.py

@@ -424,9 +424,9 @@ def __init__(
         self._file_name: Optional[os.PathLike]
         self._variable_filter: Optional[str] = None
 
-    def model_definition(
+    def model(
             self,
-            model: str,
+            name: str,
             file: Optional[str | os.PathLike | pathlib.Path] = None,
             libraries: Optional[list[str | tuple[str, str]]] = None,
             variable_filter: Optional[str] = None,
@@ -440,7 +440,7 @@ def model_definition(
         Args:
             file: Path to the model file. Either absolute or relative to
               the current working directory.
-            model: The name of the model class. If it is contained within
+            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:
@@ -462,8 +462,8 @@ def model_definition(
             mod.setup_model(model="modelName", file="ModelicaModel.mo", libraries=[("Modelica","3.2.3"), "PowerSystems"])
         """
 
-        if not isinstance(model, str):
-            raise ModelicaSystemError("A model name must be provided (argument modelName)!")
+        if not isinstance(name, str):
+            raise ModelicaSystemError("A model name must be provided (argument name)!")
 
         if libraries is None:
             libraries = []
@@ -472,7 +472,7 @@ def model_definition(
             raise ModelicaSystemError(f"Invalid input type for lmodel: {type(libraries)} - list expected!")
 
         # set variables
-        self._model_name = model  # Model class name
+        self._model_name = name  # Model class name
         self._lmodel = libraries  # may be needed if model is derived from other model
         self._file_name = pathlib.Path(file).resolve() if file is not None else None  # Model file/package name
         self._variable_filter = variable_filter

tests/test_FMIExport.py

@@ -5,8 +5,8 @@
 
 def test_CauerLowPassAnalog():
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
-        model="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
+    mod.model(
+        name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
         libraries=["Modelica"],
     )
     tmp = mod.getWorkDirectory()
@@ -19,8 +19,8 @@ def test_CauerLowPassAnalog():
 
 def test_DrumBoiler():
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
-        model="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler",
+    mod.model(
+        name="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler",
         libraries=["Modelica"],
     )
     tmp = mod.getWorkDirectory()

tests/test_ModelicaSystem.py

@@ -23,9 +23,9 @@ def test_ModelicaSystem_loop(model_firstorder):
     def worker():
         filePath = model_firstorder.as_posix()
         mod = OMPython.ModelicaSystem()
-        mod.model_definition(
+        mod.model(
             file=filePath,
-            model="M",
+            name="M",
         )
         mod.simulate()
         mod.convertMo2Fmu(fmuType="me")
@@ -37,9 +37,9 @@ def test_setParameters():
     omc = OMPython.OMCSessionZMQ()
     model_path = omc.sendExpression("getInstallationDirectoryPath()") + "/share/doc/omc/testmodels/"
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_path + "BouncingBall.mo",
-        model="BouncingBall",
+        name="BouncingBall",
     )
 
     # method 1
@@ -70,9 +70,9 @@ def test_setSimulationOptions():
     omc = OMPython.OMCSessionZMQ()
     model_path = omc.sendExpression("getInstallationDirectoryPath()") + "/share/doc/omc/testmodels/"
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_path + "BouncingBall.mo",
-        model="BouncingBall",
+        name="BouncingBall",
     )
 
     # method 1
@@ -107,9 +107,9 @@ def test_relative_path(model_firstorder):
         assert "/" not in model_relative
 
         mod = OMPython.ModelicaSystem()
-        mod.model_definition(
+        mod.model(
             file=model_relative,
-            model="M",
+            name="M",
         )
         assert float(mod.getParameters("a")[0]) == -1
     finally:
@@ -121,9 +121,9 @@ def test_customBuildDirectory(tmp_path, model_firstorder):
     tmpdir = tmp_path / "tmpdir1"
     tmpdir.mkdir()
     mod = OMPython.ModelicaSystem(customBuildDirectory=tmpdir)
-    mod.model_definition(
+    mod.model(
         file=filePath,
-        model="M",
+        name="M",
     )
     assert mod.getWorkDirectory().resolve() == tmpdir.resolve()
     result_file = tmpdir / "a.mat"
@@ -135,9 +135,9 @@ def test_customBuildDirectory(tmp_path, model_firstorder):
 def test_getSolutions(model_firstorder):
     filePath = model_firstorder.as_posix()
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=filePath,
-        model="M",
+        name="M",
     )
     x0 = 1
     a = -1
@@ -176,9 +176,9 @@ def test_getters(tmp_path):
 end M_getters;
 """)
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_file.as_posix(),
-        model="M_getters",
+        name="M_getters",
     )
 
     q = mod.getQuantities()
@@ -372,9 +372,9 @@ def test_simulate_inputs(tmp_path):
 end M_input;
 """)
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_file.as_posix(),
-        model="M_input",
+        name="M_input",
     )
 
     mod.setSimulationOptions(simOptions={"stopTime": 1.0})

tests/test_ModelicaSystemCmd.py

@@ -18,9 +18,9 @@ def model_firstorder(tmp_path):
 @pytest.fixture
 def mscmd_firstorder(model_firstorder):
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_firstorder.as_posix(),
-        model="M",
+        name="M",
     )
     mscmd = OMPython.ModelicaSystemCmd(runpath=mod.getWorkDirectory(), modelname=mod._model_name)
     return mscmd

tests/test_OMSessionCmd.py

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

tests/test_linearization.py

@@ -25,9 +25,9 @@ def model_linearTest(tmp_path):
 
 def test_example(model_linearTest):
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_linearTest,
-        model="linearTest",
+        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]]
@@ -60,9 +60,9 @@ def test_getters(tmp_path):
 end Pendulum;
 """)
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_file.as_posix(),
-        model="Pendulum",
+        name="Pendulum",
         libraries=["Modelica"],
     )
 

tests/test_optimization.py

@@ -34,9 +34,9 @@ def test_optimization_example(tmp_path):
 """)
 
     mod = OMPython.ModelicaSystem()
-    mod.model_definition(
+    mod.model(
         file=model_file.as_posix(),
-        model="BangBang2021",
+        name="BangBang2021",
     )
 
     mod.setOptimizationOptions(optimizationOptions={"numberOfIntervals": 16,