Merge pull request #19 from dnv-opensource/eis

Updated code base with latest changes in python_project_template v0.2.6

Author: ClaasRostock

CHANGELOG.md

@@ -8,13 +8,18 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 * -/-
 
 
-## [0.3.2] - 2026-01-16
+## [0.3.2] - 2026-02-02
 
 ### Added
+* Added new module unit.py, containing class `Unit`, a helper class to store and manage units and display units. One `Unit` object represents one scalar variable.
+* Added new module range.py, containing class `Range`, a utility class to store and handle the variable range of a single-valued variable.
 * Sphinx documentation:
-  * Added docs for modules variable_naming.py, enums.py, analytic.py and plotter.py
+  * Added docs for modules variable_naming.py, unit.py, range.py, enums.py and analytic.py
 * Added Visual Studio Code settings
 
+### Removed
+* Removed module plotter.py
+
 ### Changed
 * Updated code base with latest changes in python_project_template v0.2.6
 * pyproject.toml:

docs/source/component_model.rst

@@ -23,6 +23,7 @@ Modules
    component_model.model
    component_model.variable
    component_model.variable_naming
+   component_model.unit
+   component_model.range
    component_model.enums
    component_model.analytic
-   component_model.plotter

examples/DrivingForce.fmu

@@ -29,7 +29,7 @@ def init_drive(self):
         self.wheels[0].pos = np.array([0.0, 0.0], float)
         self.wheels[1].pos = np.array([self.a, 0.0], float)
         for i in range(2):
-            self.wheels[i].track = None
+            self.wheels[i].track_reset()
         self.times = []
 
     def drive(self, time: float, dt: float):
@@ -90,22 +90,21 @@ def pos(self) -> np.ndarray:
         return self._pos
 
     @pos.setter
-    def pos(self, newpos: list[float] | np.ndarray):
-        self.track = newpos
+    def pos(self, newpos: np.ndarray):
+        self.track_add(newpos)
         self._pos = np.array(newpos, float)
 
     @property
     def track(self) -> list[list[float]]:
         return self._track
 
-    @track.setter
-    def track(self, newpos: list[float] | np.ndarray | None):
-        """Remember the track. None: start new track."""
-        if newpos is None:  # reset
-            self._track = [[], []]
-        else:
-            for i in range(2):
-                self._track[i].append(newpos[i])
+    def track_reset(self):
+        self._track = [[], []]
+
+    def track_add(self, newpos: np.ndarray):
+        """Remember the track."""
+        for i in range(2):
+            self._track[i].append(newpos[i])
 
 
 class Motor:

examples/DrivingForce6D.fmu

@@ -1,6 +1,5 @@
-# pyright: reportAttributeAccessIssue=false
-# pyright: reportOptionalMemberAccess=false
 from math import sqrt
+from typing import Any
 
 import numpy as np
 
@@ -30,26 +29,29 @@ class BouncingBall3D(Model):
     def __init__(
         self,
         name: str = "BouncingBall3D",
-        description="Another Python-based BouncingBall model, using Model and Variable to construct a FMU",
-        pos: tuple = ("0 m", "0 m", "10 inch"),
-        speed: tuple = ("1 m/s", "0 m/s", "0 m/s"),
-        g="9.81 m/s^2",
-        e=0.9,
+        description: str = "Another Python-based BouncingBall model, using Model and Variable to construct a FMU",
+        pos: tuple[str | float, ...] = ("0 m", "0 m", "10 inch"),
+        speed: tuple[str | float, ...] = ("1 m/s", "0 m/s", "0 m/s"),
+        g: str | float = "9.81 m/s^2",
+        e: float = 0.9,
         min_speed_z: float = 1e-6,
-        **kwargs,
+        **kwargs: Any,
     ):
         super().__init__(name, description, author="DNV, SEACo project", **kwargs)
+        self.pos: np.ndarray
         self._pos = self._interface("pos", pos)
         self._speed = self._interface("speed", speed)
+        self.g: float
         self._g = self._interface("g", g)
         self.a = np.array((0, 0, -self.g), float)
+        self.e: float
         self._e = self._interface("e", e)
         self.min_speed_z = min_speed_z
         self.stopped = False
         self.time = 0.0
         self._p_bounce = self._interface("p_bounce", ("0m", "0m", "0m"))  # Note: 3D, but z always 0
         # provoke an update at simulation start:
-        self.t_bounce, self.p_bounce = (-1.0, self.pos)  # type: ignore
+        self.t_bounce, self.p_bounce = (-1.0, self.pos)
 
     def do_step(self, current_time: float, step_size: float) -> bool:
         """Perform a simulation step from `self.time` to `self.time + step_size`.
@@ -110,7 +112,7 @@ def exit_initialization_mode(self):
         super().exit_initialization_mode()
         self.a = np.array((0, 0, -self.g), float)
 
-    def _interface(self, name: str, start: str | float | tuple) -> Variable:
+    def _interface(self, name: str, start: str | float | tuple[str | float, ...]) -> Variable:
         """Define a FMU2 interface variable, using the variable interface.
 
         Args:

examples/HarmonicOscillator.fmu

@@ -1,4 +1,5 @@
 from math import sqrt
+from typing import Any
 
 import numpy as np
 from pythonfmu import Fmi2Causality, Fmi2Slave, Real  # type: ignore[import-untyped]
@@ -16,7 +17,7 @@ class BouncingBall3D(Fmi2Slave):
     * Internal units are assumed as SI (m,s,rad)
     """
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs: Any):
         super().__init__(
             name="BouncingBall3D",
             description="Another Python-based BouncingBall model, using Model and Variable to construct a FMU",
@@ -63,7 +64,7 @@ def __init__(self, **kwargs):
         self.accelerationY = 0.0
         self.accelerationZ = -self.g
 
-    def do_step(self, current_time, step_size) -> bool:
+    def do_step(self, current_time: float, step_size: float) -> bool:
         """Perform a simulation step from `self.time` to `self.time + step_size`.
 
         With respect to bouncing (self.t_bounce should be initialized to a negative value)

examples/HarmonicOscillator6D.fmu

@@ -66,7 +66,7 @@ def __init__(
         self.freq = np.array((1.0,) * self.dim, float)
         self.d_freq = np.array((0.0,) * self.dim, float)
         self.function = func
-        self.func: Callable
+        self.func: Callable  # type: ignore[reportMissingTypeArgument]  ## kwargs
         self.f = np.array((0.0,) * self.dim, float)
         self.v_osc = (0.0,) * self.dim
         self._ampl = Variable(self, "ampl", "The amplitude of the force in N", start=_ampl)
@@ -102,7 +102,7 @@ def exit_initialization_mode(self):
         self.func = partial(
             self.function,
             ampl=np.array(self.ampl, float),
-            omega=np.array(2 * np.pi * self.freq, float),  # type: ignore # it is an ndarray!
-            d_omega=np.array(2 * np.pi * self.d_freq, float),  # type: ignore # it is an ndarray!
+            omega=np.array(2 * np.pi * self.freq, float),
+            d_omega=np.array(2 * np.pi * self.d_freq, float),
         )
         logger.info(f"Initial settings: ampl={self.ampl}, freq={self.freq}, d_freq={self.d_freq}")