pySimBlocks 0.1.0__py3-none-any.whl

pySimBlocks/gui/dialogs/plot_dialog.py

@@ -0,0 +1,230 @@
+# ******************************************************************************
+#                                  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 numpy as np
+import matplotlib.pyplot as plt
+
+from PySide6.QtWidgets import (
+    QDialog, QHBoxLayout, QVBoxLayout,
+    QLabel, QListWidget, QListWidgetItem,
+    QPushButton, QSizePolicy, QMessageBox
+)
+from PySide6.QtCore import Qt
+
+from matplotlib.backends.backend_qtagg import FigureCanvasQTAgg
+from matplotlib.figure import Figure
+
+from pySimBlocks.gui.models.project_state import ProjectState
+from pySimBlocks.core.config import PlotConfig
+from pySimBlocks.project.plot_from_config import plot_from_config
+
+
+class PlotDialog(QDialog):
+    def __init__(self, project_state: ProjectState, parent=None):
+        super().__init__(parent)
+        self.setWindowTitle("Plot signals")
+        self.resize(900, 500)
+
+        self.project_state = project_state
+        self.selected_signals: set[str] = set()
+
+        self._build_ui()
+        self._populate_signals()
+
+    # ------------------------------------------------------------
+    # UI
+    # ------------------------------------------------------------
+    def _build_ui(self):
+        main_layout = QHBoxLayout(self)
+
+        # ---------- Left panel ----------
+        left_layout = QVBoxLayout()
+
+        title = QLabel("<b>Signals (logged)</b>")
+        left_layout.addWidget(title)
+
+        self.signal_list = QListWidget()
+        self.signal_list.setSelectionMode(QListWidget.NoSelection)
+        self.signal_list.itemChanged.connect(self._on_signal_toggled)
+        left_layout.addWidget(self.signal_list)
+
+        self.plot_defined_btn = QPushButton("Plot defined plots")
+        self.plot_defined_btn.clicked.connect(self._plot_defined_plots)
+        left_layout.addWidget(self.plot_defined_btn)
+
+        main_layout.addLayout(left_layout, 0)
+
+        # ---------- Plot preview ----------
+        self.figure = Figure()
+        self.canvas = FigureCanvasQTAgg(self.figure)
+        self.canvas.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+
+        main_layout.addWidget(self.canvas, 1)
+
+    # ------------------------------------------------------------
+    # Populate signals
+    # ------------------------------------------------------------
+    def _populate_signals(self):
+        self.signal_list.clear()
+
+        for sig in sorted(self.project_state.logs.keys()):
+            if sig == "time":
+                continue
+
+            item = QListWidgetItem(sig)
+            item.setFlags(item.flags() | Qt.ItemIsUserCheckable)
+            item.setCheckState(Qt.Unchecked)
+            self.signal_list.addItem(item)
+
+    # ------------------------------------------------------------
+    # Interactive plot
+    # ------------------------------------------------------------
+    def _on_signal_toggled(self, item: QListWidgetItem):
+        sig = item.text()
+
+        if item.checkState() == Qt.Checked:
+            self.selected_signals.add(sig)
+        else:
+            self.selected_signals.discard(sig)
+
+        self._update_preview_plot()
+
+
+    def _stack_logged_signal_2d(self, sig: str) -> np.ndarray:
+        """
+        Stack a logged signal over time, preserving its 2D shape.
+
+        Returns:
+            data: np.ndarray of shape (T, m, n)
+
+        Raises:
+            ValueError if samples are not 2D arrays of consistent shape.
+        """
+        samples = self.project_state.logs.get(sig, None)
+        if not isinstance(samples, list) or len(samples) == 0:
+            raise ValueError(f"Signal '{sig}' has no samples in logs.")
+
+        # Find first non-None sample to define shape
+        first = None
+        for s in samples:
+            if s is not None:
+                first = np.asarray(s)
+                break
+
+        if first is None:
+            raise ValueError(f"Signal '{sig}' is always None; cannot plot.")
+
+        if first.ndim != 2:
+            raise ValueError(f"Signal '{sig}' must be 2D. Got ndim={first.ndim} with shape {first.shape}.")
+
+        shape0 = first.shape
+
+        stacked = []
+        for k, s in enumerate(samples):
+            if s is None:
+                raise ValueError(f"Signal '{sig}' contains None at index {k}; cannot plot.")
+            a = np.asarray(s)
+            if a.ndim != 2:
+                raise ValueError(
+                    f"Signal '{sig}' sample {k} must be 2D. Got ndim={a.ndim} with shape {a.shape}."
+                )
+            if a.shape != shape0:
+                raise ValueError(
+                    f"Signal '{sig}' shape changed over time: expected {shape0}, got {a.shape} at sample {k}."
+                )
+            stacked.append(a)
+
+        return np.stack(stacked, axis=0)  # (T, m, n)
+
+
+    def _update_preview_plot(self):
+        self.figure.clear()
+        ax = self.figure.add_subplot(111)
+
+        if not self.selected_signals:
+            self.canvas.draw()
+            return
+
+        time = np.asarray(self.project_state.logs["time"]).flatten()
+        T = len(time)
+
+        try:
+            for sig in sorted(self.selected_signals):
+                data = self._stack_logged_signal_2d(sig)  # (T, m, n)
+
+                if data.shape[0] != T:
+                    raise ValueError(
+                        f"Time length mismatch for '{sig}': time has {T} samples but signal has {data.shape[0]}."
+                    )
+
+                m, n = data.shape[1], data.shape[2]
+
+                # scalar
+                if (m, n) == (1, 1):
+                    ax.step(time, data[:, 0, 0], where="post", label=sig)
+                    continue
+
+                # vector column (m,1)
+                if n == 1:
+                    for i in range(m):
+                        ax.step(time, data[:, i, 0], where="post", label=f"{sig}[{i}]")
+                    continue
+
+                # matrix (m,n)
+                for r in range(m):
+                    for c in range(n):
+                        ax.step(time, data[:, r, c], where="post", label=f"{sig}[{r},{c}]")
+
+            ax.set_xlabel("Time [s]")
+            ax.grid(True)
+            ax.legend()
+
+        except Exception as e:
+            # Keep the UI responsive; show the error inside the plot area.
+            ax.text(
+                0.01, 0.99,
+                f"Plot preview error:\n{e}",
+                transform=ax.transAxes,
+                va="top",
+                ha="left",
+                wrap=True,
+            )
+            ax.set_axis_off()
+
+        self.canvas.draw()
+
+    # ------------------------------------------------------------
+    # Plot defined plots (matplotlib windows)
+    # ------------------------------------------------------------
+    def _plot_defined_plots(self):
+        if not self.project_state.plots:
+            QMessageBox.information(
+                self,
+                "No plots defined",
+                "No plots are defined in the project settings."
+            )
+            return
+
+        plot_from_config(
+            logs=self.project_state.logs,
+            plot_cfg=PlotConfig(self.project_state.plots),
+            show=True,
+            block=False
+        )

pySimBlocks/gui/dialogs/settings/plots.py

@@ -0,0 +1,187 @@
+# ******************************************************************************
+#                                  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 PySide6.QtWidgets import (
+    QWidget, QHBoxLayout, QVBoxLayout, QListWidget, QListWidgetItem,
+    QLabel, QLineEdit, QPushButton, QMessageBox
+)
+from PySide6.QtCore import Qt
+
+from pySimBlocks.gui.models.project_state import ProjectState
+from pySimBlocks.gui.project_controller import ProjectController
+
+
+class PlotSettingsWidget(QWidget):
+    def __init__(self, project_state: ProjectState, project_controller: ProjectController):
+        super().__init__()
+        self.project_state = project_state
+        self.project_controller = project_controller
+        self.edit_index = None
+
+        main = QHBoxLayout(self)
+
+        # ==================================================
+        # Left: plot list + actions
+        # ==================================================
+        left = QVBoxLayout()
+
+        left.addWidget(QLabel("Plots"))
+
+        self.plot_list = QListWidget()
+        self.plot_list.currentRowChanged.connect(self.load_plot)
+        left.addWidget(self.plot_list)
+
+        self.new_btn = QPushButton("New")
+        self.save_btn = QPushButton("Save")
+        self.del_btn = QPushButton("Delete")
+
+        self.new_btn.clicked.connect(self.new_plot)
+        self.save_btn.clicked.connect(self.save_plot)
+        self.del_btn.clicked.connect(self.delete_plot)
+
+        left.addWidget(self.new_btn)
+        left.addWidget(self.save_btn)
+        left.addWidget(self.del_btn)
+
+        main.addLayout(left, 1)
+
+        # ==================================================
+        # Right: editor
+        # ==================================================
+        right = QVBoxLayout()
+
+        right.addWidget(QLabel("Title:"))
+        self.title_edit = QLineEdit()
+        right.addWidget(self.title_edit)
+
+        right.addWidget(QLabel("Signals:"))
+        self.signal_list = QListWidget()
+        self.signal_list.setSelectionMode(QListWidget.NoSelection)
+        right.addWidget(self.signal_list)
+
+        main.addLayout(right, 2)
+
+        self.refresh_plot_list()
+        self.populate_signal_list()
+        self.update_buttons_state()
+
+    # ==================================================
+    # Helpers
+    # ==================================================
+    def refresh_from_project(self):
+        """Synchronize the plot editor with the current project state."""
+        self.edit_index = None
+        self.refresh_plot_list()
+        self.plot_list.clearSelection()
+        self.populate_signal_list()
+        self.title_edit.clear()
+        self.update_buttons_state()
+
+    def refresh_plot_list(self):
+        self.plot_list.clear()
+        for plot in self.project_state.plots:
+            self.plot_list.addItem(plot["title"])
+
+    def populate_signal_list(self, checked=None):
+        """
+        Populate signal list.
+        checked: optional set/list of signals to check.
+        """
+        self.signal_list.clear()
+        checked = set(checked or [])
+
+        for sig in self.project_state.get_output_signals():
+            item = QListWidgetItem(sig)
+            item.setFlags(item.flags() | Qt.ItemIsUserCheckable)
+            item.setCheckState(Qt.Checked if sig in checked else Qt.Unchecked)
+            self.signal_list.addItem(item)
+
+    def collect_selected_signals(self) -> list[str]:
+        return [
+            self.signal_list.item(i).text()
+            for i in range(self.signal_list.count())
+            if self.signal_list.item(i).checkState() == Qt.Checked
+        ]
+
+    def reset_form(self):
+        self.title_edit.clear()
+        self.populate_signal_list()
+
+    def update_buttons_state(self):
+        has_selection = self.plot_list.currentRow() >= 0
+        self.del_btn.setEnabled(has_selection)
+
+    # ==================================================
+    # Selection handling
+    # ==================================================
+    def load_plot(self, index):
+        if index < 0:
+            self.edit_index = None
+            self.reset_form()
+            self.update_buttons_state()
+            return
+
+        self.edit_index = index
+        plot = self.project_state.plots[index]
+        self.title_edit.setText(plot["title"])
+        self.populate_signal_list(plot["signals"])
+        self.update_buttons_state()
+
+
+    # ==================================================
+    # Actions
+    # ==================================================
+    def new_plot(self):
+        self.edit_index = None
+        self.plot_list.clearSelection()
+        self.reset_form()
+        self.update_buttons_state()
+
+    def save_plot(self):
+        title = self.title_edit.text().strip()
+        if not title:
+            QMessageBox.warning(self, "Invalid plot", "Plot title cannot be empty.")
+            return
+
+        signals = self.collect_selected_signals()
+        if not signals:
+            QMessageBox.warning(self, "Invalid plot", "No signal selected.")
+            return
+
+        if self.edit_index is None:
+            self.project_controller.create_plot(title, signals)
+            self.refresh_plot_list()
+        else:
+            self.project_controller.update_plot(self.edit_index, title, signals)
+            self.plot_list.item(self.edit_index).setText(title)
+
+        self.update_buttons_state()
+
+
+    def delete_plot(self):
+        if self.edit_index is None:
+            return
+
+        self.project_controller.delete_plot(self.edit_index)
+        self.edit_index = None
+        self.refresh_plot_list()
+        self.plot_list.clearSelection()
+        self.reset_form()
+        self.update_buttons_state()

pySimBlocks/gui/dialogs/settings/project.py

@@ -0,0 +1,146 @@
+# ******************************************************************************
+#                                  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
+import os
+from PySide6.QtWidgets import (
+    QWidget, QFormLayout, QLabel, QLineEdit, QMessageBox, QPushButton, QFileDialog, QHBoxLayout
+)
+
+from pySimBlocks.gui.models.project_state import ProjectState
+from pySimBlocks.gui.project_controller import ProjectController
+from pySimBlocks.gui.services.project_loader import ProjectLoaderYaml
+
+
+class ProjectSettingsWidget(QWidget):
+
+    def __init__(self, project_state: ProjectState, project_controller: ProjectController, settings_dialg):
+        super().__init__()
+        self.project_state = project_state
+        self.project_controller = project_controller
+        self.settings_dialog = settings_dialg
+
+        layout = QFormLayout(self)
+        layout.addRow(QLabel("<b>Project Settings</b>"))
+
+        self.dir_edit = QLineEdit(str(project_state.directory_path))
+        self.dir_browse_btn = QPushButton("...")
+        self.dir_browse_btn.setToolTip("Select a project directory from disk")
+        self.dir_browse_btn.clicked.connect(self.browse_project_directory)
+
+        dir_layout = QHBoxLayout()
+        dir_layout.setContentsMargins(0, 0, 0, 0)
+        dir_layout.addWidget(self.dir_edit)
+        dir_layout.addWidget(self.dir_browse_btn)
+
+        layout.addRow("Directory path:", dir_layout)
+
+        load_btn = QPushButton("Load")
+        load_btn.clicked.connect(self.load_project)
+        label = QLabel("Load Project:")
+        label.setToolTip("Auto load project from directory containing project.yaml.")
+        layout.addRow(label, load_btn)
+
+        ext = project_state.external or ""
+        self.external_edit = QLineEdit(ext)
+        self.external_browse_btn = QPushButton("...")
+        self.external_browse_btn.setToolTip("Select a Python file from disk")
+        self.external_browse_btn.clicked.connect(self.browse_external_file)
+
+        external_layout = QHBoxLayout()
+        external_layout.setContentsMargins(0, 0, 0, 0)
+        external_layout.addWidget(self.external_edit)
+        external_layout.addWidget(self.external_browse_btn)
+
+        label = QLabel("Python file:")
+        label.setToolTip("Relative path from project directory")
+        layout.addRow(label, external_layout)
+
+
+
+    def apply(self) -> bool:
+        path = Path(self.dir_edit.text())
+        if not path.exists():
+            QMessageBox.warning(
+                self,
+                "Invalid directory",
+                f"The directory does not exist:\n{path}",
+            )
+            return False
+        ext = self.external_edit.text().strip()
+        self.project_controller.update_project_param(path, ext)
+        return True
+
+    def browse_external_file(self):
+        base_dir = Path(self.dir_edit.text()).expanduser()
+        if not base_dir.is_dir():
+            QMessageBox.warning(
+                self,
+                "Invalid directory",
+                f"The directory does not exist:\n{base_dir}",
+            )
+            return
+
+        selected_file, _ = QFileDialog.getOpenFileName(
+            self,
+            "Select Python file",
+            str(base_dir),
+            "Python files (*.py);;All files (*)",
+        )
+
+        if not selected_file:
+            return
+
+        selected_path = Path(selected_file).resolve()
+        try:
+            relative_path = selected_path.relative_to(base_dir.resolve())
+        except ValueError:
+            try:
+                relative_path = Path(os.path.relpath(str(selected_path), str(base_dir.resolve())))
+            except ValueError:
+                # Windows cross-drive case (e.g. C: -> D:): keep absolute path.
+                relative_path = selected_path
+
+        self.external_edit.setText(relative_path.as_posix())
+
+    def browse_project_directory(self):
+        current_dir = Path(self.dir_edit.text()).expanduser()
+        start_dir = current_dir if current_dir.is_dir() else Path.cwd()
+
+        selected_dir = QFileDialog.getExistingDirectory(
+            self,
+            "Select project directory",
+            str(start_dir),
+        )
+
+        if not selected_dir:
+            return
+
+        self.dir_edit.setText(str(Path(selected_dir).resolve()))
+
+    def load_project(self):
+        main_window = self.settings_dialog.parent()
+        if not main_window.confirm_discard_or_save("loading a new project"):
+            return 
+        self.apply()
+        self.project_controller.load_project(ProjectLoaderYaml())
+        ext = self.project_state.external
+        self.external_edit.setText("" if ext is None else ext)
+        self.settings_dialog.refresh_tabs_from_project()

pySimBlocks/gui/dialogs/settings/simulation.py

@@ -0,0 +1,137 @@
+# ******************************************************************************
+#                                  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 PySide6.QtWidgets import (
+    QWidget, QFormLayout, QLabel, QLineEdit, QComboBox,
+    QListWidget, QListWidgetItem, QMessageBox
+)
+from PySide6.QtCore import Qt
+
+from pySimBlocks.gui.models.project_state import ProjectState
+from pySimBlocks.gui.project_controller import ProjectController
+
+
+class SimulationSettingsWidget(QWidget):
+    def __init__(self, project_state: ProjectState, project_controller: ProjectController):
+        super().__init__()
+        self.project_state = project_state
+        self.project_controller = project_controller
+        self._logs_dirty = False
+
+        layout = QFormLayout(self)
+        layout.addRow(QLabel("<b>Simulation Settings</b>"))
+
+        self.dt_edit = QLineEdit(str(project_state.simulation.dt))
+        layout.addRow("Step time:", self.dt_edit)
+
+
+        self.T_edit = QLineEdit(str(project_state.simulation.T))
+        layout.addRow("Stop time:", self.T_edit)
+
+        self.solver_combo = QComboBox()
+        self.solver_combo.addItems(["fixed", "variable"])
+        self.solver_combo.setCurrentText(project_state.simulation.solver)
+        layout.addRow("Solver:", self.solver_combo)
+
+        value = self.project_state.simulation.clock
+        self.clock_combo = QComboBox()
+        self.clock_combo.addItem("internal")
+        self.clock_combo.addItem("external")
+        if value is not None:
+            self.clock_combo.setCurrentText(str(value))
+        layout.addRow("Simulation clock:", self.clock_combo)
+
+        # -------- Logs --------
+        self.logs_list = QListWidget()
+        self.logs_list.itemChanged.connect(self._on_log_changed)
+        self._define_log_list()
+        layout.addRow("Signals logged:", self.logs_list)
+
+    def apply(self):
+
+        params = {}
+        try:
+            params["dt"] = float(self.dt_edit.text())
+        except ValueError:
+            params["dt"] = self.dt_edit.text()
+        try:
+            params["T"] = float(self.T_edit.text())
+        except ValueError:
+            params["T"] = self.T_edit.text()
+        params["solver"] = self.solver_combo.currentText()
+        params["clock"] = self.clock_combo.currentText()
+
+        selected_signals = [
+            self.logs_list.item(i).text()
+            for i in range(self.logs_list.count())
+            if self.logs_list.item(i).checkState() == Qt.Checked
+        ]
+
+        self.project_controller.update_simulation_params(params)
+        if self._logs_dirty:
+            self.project_controller.set_logged_signals(selected_signals)
+            self._logs_dirty = False
+
+    def refresh_from_project(self):
+        """
+        Synchronize the log checkbox list with project_state.logging.
+        Called when the Simulation tab becomes active.
+        """
+        self._define_log_list()
+        selected = set(self.project_state.logging)
+        self.logs_list.blockSignals(True)
+
+        for i in range(self.logs_list.count()):
+            item = self.logs_list.item(i)
+            should_be_checked = item.text() in selected
+            item.setCheckState(
+                Qt.Checked if should_be_checked else Qt.Unchecked
+            )
+
+        self.logs_list.blockSignals(False)
+        self._logs_dirty = False
+
+    def _define_log_list(self):
+        self.logs_list.blockSignals(True)
+        self.logs_list.clear()
+        available = self.project_state.get_output_signals()
+        selected = set(self.project_state.logging)
+        for sig in available:
+            item = QListWidgetItem(sig)
+            item.setFlags(item.flags() | Qt.ItemIsUserCheckable)
+            item.setCheckState(Qt.Checked if sig in selected else Qt.Unchecked)
+            self.logs_list.addItem(item)
+        self.logs_list.blockSignals(False)
+        self._logs_dirty = False
+
+    def _on_log_changed(self, item: QListWidgetItem):
+        self._logs_dirty = True
+        if item.checkState() == Qt.Unchecked:
+            used = any(
+                item.text() in plot["signals"]
+                for plot in self.project_state.plots
+            )
+            if used:
+                QMessageBox.warning(
+                    self,
+                    "Signal in use",
+                    f"The signal '{item.text()}' is used in a plot."
+                )
+                item.setCheckState(Qt.Checked)