pySimBlocks 0.1.0__py3-none-any.whl

pySimBlocks/gui/models/__init__.py

@@ -0,0 +1,31 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program is distributed in the hope that it will be useful, but WITHOUT
+#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+#  for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from pySimBlocks.gui.models.block_instance import BlockInstance
+from pySimBlocks.gui.models.connection_instance import ConnectionInstance
+from pySimBlocks.gui.models.port_instance import PortInstance
+from pySimBlocks.gui.models.project_state import ProjectState
+
+__all__ = [
+    "BlockInstance",
+    "ConnectionInstance",
+    "PortInstance",
+    "ProjectState"
+]

pySimBlocks/gui/models/block_instance.py

@@ -0,0 +1,114 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program is distributed in the hope that it will be useful, but WITHOUT
+#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+#  for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+import uuid
+from typing import TYPE_CHECKING, Any, Dict, List
+
+from pySimBlocks.gui.models.port_instance import PortInstance
+
+try: # Python 3.11+
+    from typing import Self
+except ImportError: # Python <3.11
+    from typing_extensions import Self
+
+
+if TYPE_CHECKING:
+    from pySimBlocks.gui.blocks.block_meta import BlockMeta
+
+
+class BlockInstance:
+    """
+    GUI-side mutable instance of a block.
+
+    - References an immutable BlockMeta
+    - Stores instance-level data (name, parameters)
+    - Used by BlockItem and BlockDialog
+    """
+
+    @classmethod
+    def copy(cls, block: Self) -> Self:
+        cpy = BlockInstance(block.meta)
+        cpy.name = block.name
+        cpy.parameters = block.parameters.copy()
+        return cpy
+
+
+    def __init__(self, meta: 'BlockMeta'):
+        self.uid: str = uuid.uuid4().hex
+        self.meta = meta
+        self.name: str = meta.name
+        self.parameters: Dict[str, Any] = self._init_parameters()
+        self.ports: List[PortInstance] = []
+
+    def _init_parameters(self) -> dict[str, Any]:
+        """
+        Initialize instance parameters from metadata.
+        """
+        params = {}
+
+        for p in self.meta.parameters:
+            params[p.name] = p.default if p.autofill else None
+
+        return params
+
+    def update_params(self, params: dict[str, Any]):
+        for k, v in params.items():
+            if k in self.parameters:
+                self.parameters[k] = v
+
+    def resolve_ports(self) -> None:
+
+        new_ports = self.meta.build_ports(self)
+
+        if not self.ports:
+            self.ports = new_ports
+            return 
+
+        old_inputs = [p for p in self.ports if p.direction == "input"]
+        old_outputs = [p for p in self.ports if p.direction == "output"]
+
+        updated_ports = []
+
+        for np in new_ports:
+            if np.direction == "input":
+                if old_inputs:
+                    p = old_inputs.pop(0)
+                    p.name = np.name
+                    p.display_as = np.display_as
+                    updated_ports.append(p)
+                else:
+                    updated_ports.append(np)
+            else:
+                if old_outputs:
+                    p = old_outputs.pop(0)
+                    p.name = np.name
+                    p.display_as = np.display_as
+                    updated_ports.append(p)
+                else:
+                    updated_ports.append(np)
+
+        self.ports = updated_ports
+
+    def active_parameters(self) -> dict[str, Any]:
+        return  {
+            k: v
+            for k, v in self.parameters.items()
+            if self.meta.is_parameter_active(k, self.parameters)
+        }

pySimBlocks/gui/models/connection_instance.py

@@ -0,0 +1,43 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program is distributed in the hope that it will be useful, but WITHOUT
+#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+#  for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pySimBlocks.gui.graphics.port_item import PortInstance
+    from pySimBlocks.gui.project_controller import BlockInstance
+
+class ConnectionInstance:
+    def __init__(
+        self,
+        src_port: "PortInstance",
+        dst_port: "PortInstance",
+    ):
+        self.src_port = src_port
+        self.dst_port = dst_port
+
+    def src_block(self) -> "BlockInstance":
+        return self.src_port.block
+
+    def dst_block(self) -> "BlockInstance":
+        return self.dst_port.block
+
+    def is_block_involved(self, block: "BlockInstance") -> bool:
+        return block in (self.src_port.block, self.dst_port.block)

pySimBlocks/gui/models/port_instance.py

@@ -0,0 +1,52 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program is distributed in the hope that it will be useful, but WITHOUT
+#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+#  for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from typing import Literal, TYPE_CHECKING
+
+from pySimBlocks.gui.blocks.port_meta import PortMeta
+
+if TYPE_CHECKING:
+    from pySimBlocks.gui.models.connection_instance import ConnectionInstance
+    from pySimBlocks.gui.project_controller import BlockInstance
+
+class PortInstance:
+    def __init__(
+        self,
+        name: str,
+        display_as: str,
+        direction: Literal['input', 'output'],
+        block: "BlockInstance"
+    ):
+        self.name = name
+        self.display_as = display_as
+        self.direction = direction
+        self.block = block
+
+    def is_compatible(self, other: "PortInstance"):
+        return self.direction != other.direction
+
+    def can_accept_connection(self, connections: list["ConnectionInstance"]) -> bool:
+        """
+        Check whether this port can accept a new connection.
+
+        The `connections` list is expected to contain all and only the connections
+        already linked to this PortInstance.
+        """
+        return self.direction == "output" or not connections

pySimBlocks/gui/models/project_simulation_params.py

@@ -0,0 +1,50 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program is distributed in the hope that it will be useful, but WITHOUT
+#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+#  for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+class ProjectSimulationParams:
+
+    DEFAULT_DT = 0.1
+    DEFAULT_T = 10.
+    DEFAULT_SOLVER = "fixed"
+    DEFAULT_CLOCK = "internal"
+
+    def __init__(
+            self,
+            dt: float = DEFAULT_DT,
+            T: float = DEFAULT_T,
+            solver: str = DEFAULT_SOLVER,
+            clock: str = DEFAULT_CLOCK
+    ):
+        self.dt = dt
+        self.T = T
+        self.solver = solver
+        self.clock = clock
+
+    def load_from_dict(self, params: dict) -> None:
+        self.dt = params.get("dt", self.dt)
+        self.T = params.get("T", self.T)
+        self.solver = params.get("solver", self.solver)
+        self.clock = params.get("clock", self.clock)
+
+    def clear(self) -> None:
+        self.dt = self.DEFAULT_DT
+        self.T = self.DEFAULT_T
+        self.solver = self.DEFAULT_SOLVER
+        self.clock = self.DEFAULT_CLOCK

pySimBlocks/gui/models/project_state.py

@@ -0,0 +1,114 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program is distributed in the hope that it will be useful, but WITHOUT
+#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+#  for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from pathlib import Path
+
+from pySimBlocks.gui.models.block_instance import BlockInstance, PortInstance
+from pySimBlocks.gui.models.connection_instance import ConnectionInstance
+from pySimBlocks.gui.models.project_simulation_params import ProjectSimulationParams
+
+class ProjectState:
+    def __init__(self, directory_path: Path):
+        self.blocks: list[BlockInstance] = []
+        self.connections: list[ConnectionInstance] = []
+        self.simulation = ProjectSimulationParams()
+        self.external: str | None = None
+        self.directory_path = directory_path
+        self.logging: list[str] = []
+        self.logs: dict = {}
+        self.plots: list[dict[str, str | list[str]]] = []
+
+
+    def clear(self):
+        self.blocks.clear()
+        self.connections.clear()
+
+        self.logs.clear()
+        self.logging.clear()
+        self.plots.clear()
+
+        self.simulation.clear()
+
+        self.external = None
+
+    def load_simulation(self, sim_data: dict, external = None):
+        self.simulation.load_from_dict(sim_data)
+
+        if external:
+            self.external = external
+
+    # --------------------------------------------------------------------------
+    # Block management
+    # --------------------------------------------------------------------------
+    def get_block(self, name:str):
+        for block in self.blocks:
+            if name == block.name:
+                return block
+
+    def add_block(self, block_instance: BlockInstance):
+        self.blocks.append(block_instance)
+
+    def remove_block(self, block_instance: BlockInstance):
+        if block_instance in self.blocks:
+            self.blocks.remove(block_instance)
+
+    # --------------------------------------------------------------------------
+    # Connection management
+    # --------------------------------------------------------------------------
+    def add_connection(self, conn: ConnectionInstance):
+        self.connections.append(conn)
+
+    def remove_connection(self, conn: ConnectionInstance):
+        if conn in self.connections:
+            self.connections.remove(conn)
+
+    def get_connections_of_block(self, block_instance: BlockInstance) -> list[ConnectionInstance]:
+        return [
+            c for c in self.connections
+            if block_instance is c.src_block() or block_instance is c.dst_block()
+        ]
+
+    def get_connections_of_port(self, port_instance: PortInstance) -> list[ConnectionInstance]:
+        return [
+            c for c in self.connections
+            if port_instance is c.src_port or port_instance is c.dst_port
+        ]
+
+    # --------------------------------------------------------------------------
+    # Signals
+    # --------------------------------------------------------------------------
+    def get_output_signals(self) -> list[str]:
+        signals = []
+
+        for block in self.blocks:
+            for port in block.ports:
+                if port.direction == "output":
+                    signals.append(f"{block.name}.outputs.{port.name}")
+
+        return signals
+
+    def can_plot(self) -> tuple[bool, str]:
+        if not bool(self.logs):
+            return False, "Simulation has not been done.\nPlease run fist."
+
+        if not ("time" in self.logs):
+            return False, "Time is not in logs."
+
+        return True, "Plotting is available."