pySimBlocks 0.1.0__py3-none-any.whl

pySimBlocks/gui/addons/sofa/sofa_dialog.py

@@ -0,0 +1,190 @@
+# ******************************************************************************
+#                                  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 PySide6.QtWidgets import (
+    QHBoxLayout,
+    QDialog,
+    QLabel,
+    QVBoxLayout,
+    QLineEdit,
+    QPushButton,
+    QFormLayout,
+    QComboBox,
+    QMessageBox,
+    QPlainTextEdit
+)
+
+from pySimBlocks.gui.addons.sofa.sofa_service import SofaService
+
+
+class SofaDialog(QDialog):
+    def __init__(self, sofa_service: SofaService, parent=None):
+        super().__init__(parent)
+        self.setWindowTitle("Edit block")
+        self.setMinimumWidth(300)
+
+        self.sofa_service = sofa_service
+
+        main_layout = QVBoxLayout(self)
+        self.build_form(main_layout)
+
+        # --- Buttons row ---
+        buttons_layout = QHBoxLayout()
+        buttons_layout.addStretch()
+
+        ok_btn = QPushButton("Ok")
+        ok_btn.setDefault(True)
+        ok_btn.setAutoDefault(True)
+        ok_btn.clicked.connect(self.ok)
+        buttons_layout.addWidget(ok_btn)
+
+        apply_btn = QPushButton("Apply")
+        apply_btn.clicked.connect(self.apply)
+        buttons_layout.addWidget(apply_btn)
+        main_layout.addLayout(buttons_layout)
+
+    # ------------------------------------------------------------
+    # Form
+    def build_form(self, layout):
+        form = QFormLayout()
+
+        # --- Block name ---
+        self.run_edit = QLineEdit(self.sofa_service.sofa_path)
+        self.run_edit.setText(self.sofa_service.sofa_path)
+        label  = QLabel("runSofa:")
+        label.setToolTip("runSofa path")
+        form.addRow(label, self.run_edit)
+
+        self.gui_combo = QComboBox()
+        self.gui_combo.addItems(["imgui", "qglviewer", "qt", "custom"])
+        self.gui_combo.setCurrentText(self.sofa_service.gui)
+        self.gui_combo.currentTextChanged.connect(lambda val: self._on_gui_changed(val))
+        form.addRow(QLabel("Sofa GUI:"), self.gui_combo)
+
+        label = QLabel("Run diagram from Sofa:")
+        label.setToolTip("Run simulation with sofa gui")
+        run_btn = QPushButton("runSofa")
+        run_btn.clicked.connect(self.run)
+        form.addRow(label, run_btn)
+
+        label = QLabel("Export Controller")
+        label.setToolTip("Modify Sofa controller to run on cli.")
+        export_btn = QPushButton("Export Controller")
+        export_btn.clicked.connect(self.export)
+        form.addRow(label, export_btn)
+
+        layout.addLayout(form)
+
+    # ------------------------------------------------------------
+    # Buttons
+    def apply(self):
+        sofa_path = self.run_edit.text()
+        if not Path(sofa_path).exists():
+            QMessageBox.warning(
+                self,
+                "Invalid sofa path",
+                f"The run sofa exec not exist:\n{sofa_path}",
+            )
+            return False
+        self.sofa_service.sofa_path = sofa_path
+        return True
+
+    def ok(self):
+        if not self.apply():
+            return
+        self.accept()
+
+    def run(self):
+        if not self.apply():
+            return
+        if not self._update_scene_file():
+            return
+
+        progress = QDialog(self)
+        progress.setWindowTitle("SOFA running")
+        progress.setModal(True)
+        progress.setMinimumWidth(300)
+
+        layout = QVBoxLayout(progress)
+        layout.addWidget(QLabel(
+            "SOFA is running.\n\n"
+            "Close the SOFA GUI to return to pySimBlocks."
+        ))
+
+        progress.show()
+        try:
+            ok, title, details = self.sofa_service.run()
+        except Exception as e:
+            ok, title, details = False, "Error launching SOFA", str(e)
+        finally:
+            progress.close()
+        if not ok:
+            dialog = LogDialog(
+                title=f"SOFA error – {title}",
+                content=details,
+                parent=self
+            )
+            dialog.exec()
+
+    def export(self):
+        if not self.apply():
+            return
+        if not self._update_scene_file():
+            return
+        window = self.parent()
+        self.sofa_service.export_controller(window, window.saver)
+
+    # ------------------------------------------------------------
+    # internal methods
+    def _on_gui_changed(self, value):
+        self.sofa_service.gui = value
+
+    def _update_scene_file(self):
+        ok, msg, details = self.sofa_service.get_scene_file()
+        if not ok:
+            QMessageBox.warning(
+                self,
+                msg,
+                details,
+                QMessageBox.Ok
+            )
+        return ok
+
+
+
+class LogDialog(QDialog):
+    def __init__(self, title: str, content: str, parent=None):
+        super().__init__(parent)
+        self.setWindowTitle(title)
+        self.resize(800, 500)
+
+        layout = QVBoxLayout(self)
+
+        self.text = QPlainTextEdit()
+        self.text.setReadOnly(True)
+        self.text.setPlainText(content)
+        self.text.setLineWrapMode(QPlainTextEdit.NoWrap)
+
+        layout.addWidget(self.text)
+
+        close_btn = QPushButton("Close")
+        close_btn.clicked.connect(self.accept)
+        layout.addWidget(close_btn)

pySimBlocks/gui/addons/sofa/sofa_service.py

@@ -0,0 +1,209 @@
+# ******************************************************************************
+#                                  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 os
+import shutil
+from pathlib import Path
+
+from PySide6.QtCore import QProcess, QProcessEnvironment
+
+from pySimBlocks.gui.models.project_state import ProjectState
+from pySimBlocks.gui.project_controller import ProjectController
+from pySimBlocks.gui.services.yaml_tools import (
+    cleanup_runtime_project_yaml,
+    runtime_project_yaml_path,
+    save_yaml,
+)
+from pySimBlocks.project.generate_sofa_controller import generate_sofa_controller
+
+
+class SofaService:
+    def __init__(self, project_state: ProjectState, project_controller: ProjectController):
+        self.project_state = project_state
+        self.project_controller = project_controller
+
+        self.sofa_path = ""
+        self.gui = "imgui"
+        self.scene_file = ""
+
+        self._detect_sofa()
+
+
+    # --------------------------------------------------------------------------
+    # Public methods
+    # --------------------------------------------------------------------------
+    def get_scene_file(self):
+        flag, msg, details = self.can_use_sofa()
+        if flag:
+            sofa_block =  [b for b in self.project_state.blocks if b.meta.type in ["sofa_plant", "sofa_exchange_i_o"]]
+            scene_param = sofa_block[0].parameters.get("scene_file")
+            if not scene_param:
+                return False, "No scene file", "scene_file parameter is missing."
+
+            try:
+                scene_path = self._resolve_scene_file(scene_param)
+            except Exception as e:
+                return False, "Invalid scene file", str(e)
+
+            if not scene_path.exists():
+                return False, "Incorrect Scene File", "The scene file does not exist."
+
+            self.scene_file = str(scene_path)
+            return True, "Scene File set", ""
+        else:
+            return flag, msg, details
+
+    # ------------------------------------------------------------------
+    def can_use_sofa(self):
+        sofa_block =  [b for b in self.project_state.blocks if b.meta.type in ["sofa_plant", "sofa_exchange_i_o"]]
+        if len(sofa_block) == 0:
+            return False, "No SOFA block", "Please Add at least one sofa system."
+        elif len(sofa_block) > 1:
+            return False, "Multiple SOFA blocks", "Only one sofa system can be set to run sofa."
+        else:
+            return True, "Sofa can be master", "Only one system found. Diagram can be used from controller."
+
+    # ------------------------------------------------------------------
+    def export_controller(self, window, saver):
+        if window.confirm_discard_or_save("exporting sofa"):
+            saver.save(self.project_controller.project_state, self.project_controller.view.block_items)
+        if self.project_state.directory_path is None:
+            raise ValueError("Project directory is not set.\nPlease define it in settings.")
+        generate_sofa_controller(self.project_state.directory_path)
+
+    # ------------------------------------------------------------------
+    def run(self):
+        env_ok, msg = self._check_sofa_environnment()
+        if not env_ok:
+            return False, "Environment error", msg
+
+        if not self.sofa_path or not os.path.exists(self.sofa_path):
+            return False, "runSofa not found", ""
+
+        if not self.scene_file or not os.path.exists(self.scene_file):
+            return False, "scene file not found", ""
+
+        project_dir = self.project_state.directory_path
+        if project_dir is None:
+            return {}, False, "Project directory is not set.\nPlease define it in settings."
+
+        runtime_yaml = runtime_project_yaml_path(project_dir)
+        cleanup_runtime_project_yaml(project_dir)
+        save_yaml(project_state=self.project_state, runtime=True)
+        try:
+            generate_sofa_controller(project_yaml=runtime_yaml)
+        except Exception as e:
+            cleanup_runtime_project_yaml(project_dir)
+            return False, "Could not update SOFA controller", str(e)
+
+        # set command
+        plugins = "SofaPython3"
+        if self.gui == "imgui":
+            plugins += ",SofaImgui"
+        args = ["-l", plugins, "-g", self.gui, self.scene_file]
+
+        self._full_log = ""
+
+        self.process = QProcess()
+        env = QProcessEnvironment.systemEnvironment()
+        self.process.setProcessEnvironment(env)
+        self.process.setWorkingDirectory(str(Path(self.scene_file).parent))
+        self.process.setProgram(self.sofa_path)
+        self.process.setArguments(args)
+
+        self.process.setProcessChannelMode(QProcess.MergedChannels)
+        self.process.readyReadStandardOutput.connect(
+            lambda: self._accumulate_output()
+        )
+
+        try:
+            self.process.start()
+            if not self.process.waitForStarted():
+                return False, "Launch failed", "runSofa could not start"
+            self.process.waitForFinished(-1)
+
+            try:
+                generate_sofa_controller(project_dir)
+            except Exception as e:
+                return False, "Could not regenerate controller", "project.yaml does not exist.\n" + str(e)
+
+            # get output results
+            full_log = self._full_log
+            exit_code = self.process.exitCode()
+            if exit_code != 0:
+                return False, "SOFA exited with error", f"exit code = {exit_code}\n\n{full_log}"
+            pysimblocks_errors = [
+                line for line in full_log.splitlines()
+                if "[pySimBlocks] ERROR" in line
+            ]
+            if pysimblocks_errors:
+                return False, "pySimBlocks configuration error", "\n".join(pysimblocks_errors)
+            return True, "SOFA finished", "Process terminated correctly"
+        finally:
+            cleanup_runtime_project_yaml(project_dir)
+
+    # --------------------------------------------------------------------------
+    # Internal methods
+    # --------------------------------------------------------------------------
+    def _accumulate_output(self):
+        chunk = self.process.readAllStandardOutput().data().decode()
+        print(chunk, end="")
+        self._full_log += chunk
+
+    # ------------------------------------------------------------------
+    def _check_sofa_environnment(self):
+        sofa_root = os.environ.get("SOFA_ROOT")
+        if not sofa_root:
+            return False, "SOFA_ROOT is not set."
+
+        return True, "OK"
+
+    # ------------------------------------------------------------------
+    def _detect_sofa(self):
+        detected = None
+        sofa_root = os.environ.get("SOFA_ROOT")
+        if sofa_root:
+            bin_dir = Path(sofa_root) / "bin"
+            for candidate in ("runSofa", "runSofa.exe"):
+                potential_path = bin_dir / candidate
+                if potential_path.exists():
+                    detected = str(potential_path)
+                    break
+
+        if not detected:
+            detected = shutil.which("runSofa")
+        
+        if not detected:
+            detected = shutil.which("runsofa")
+
+        if detected:
+            self.sofa_path = detected
+
+    # ------------------------------------------------------------------
+    def _resolve_scene_file(self, scene_file: str) -> Path:
+        project_dir = self.project_state.directory_path
+        if project_dir is None:
+            raise RuntimeError("Project directory is not set")
+
+        path = Path(scene_file).expanduser()
+        if not path.is_absolute():
+            path = (project_dir / path).resolve()
+
+        return path

pySimBlocks/gui/blocks/block_dialog_session.py

@@ -0,0 +1,47 @@
+# ******************************************************************************
+#                                  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 typing import TYPE_CHECKING
+
+from PySide6.QtWidgets import QLineEdit
+
+from pySimBlocks.gui.models.block_instance import BlockInstance
+
+if TYPE_CHECKING:
+    from pySimBlocks.gui.blocks.block_meta import BlockMeta
+
+
+class BlockDialogSession:
+    def __init__(
+        self,
+        meta: "BlockMeta",
+        instance: BlockInstance,
+        project_dir: Path | None = None,
+    ):
+        self.meta = meta              
+        self.instance = instance
+        self.project_dir = project_dir
+
+        # --- STATE UI (par dialog) ---
+        self.local_params = dict(instance.parameters)   
+        self.param_widgets = {}
+        self.param_labels = {}         
+        self.name_edit: QLineEdit | None = None