bec-widgets 0.100.0__py3-none-any.whl → 0.102.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## v0.102.0 (2024-09-04)
+
+### Documentation
+
+* docs(buttons): buttons section of docs split to appearance and queue buttons ([`047aa26`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/047aa26a60220c826cc1375cf81daf11d1f3ab5c))
+
+* docs(tests): added tests tutorial for widget ([`18d8561`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/18d8561c965d149a7662085f7dbe2a39a8c4a475))
+
+### Feature
+
+* feat(queue): BECQueue controls extended with Resume, Stop, Abort, Reset buttons ([`0d7c10e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0d7c10e670e4937787e1afaa19ca8259ac752486))
+
+### Fix
+
+* fix(queue_reset_button): queue reset has to be confirmed with msgBox ([`9dd43aa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9dd43aa1fd3991368002605df4389a7a7271011b))
+
+### Refactor
+
+* refactor(tests): positioner box test changed to use create_widget fixture ([`df5eff3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df5eff3147c79ff0278e6a5a09c8f73d5236aed3))
+
+## v0.101.0 (2024-09-02)
+
+### Feature
+
+* feat: add Dap dialog widget ([`9781b77`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9781b77de27b2810fbb1047a61b1832dd186db01))
+
+### Refactor
+
+* refactor: add docs, cleanup ([`61ecf49`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/61ecf491e52bfbfa0d5a84764a9095310659043d))
+
 ## v0.100.0 (2024-09-01)
 
 ### Documentation
@@ -124,30 +154,6 @@
 
 * docs(buttons): added missing buttons docs ([`4e5520a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4e5520aee2115d2fc0cebb3865433478a5ec8253))
 
-* docs(developer): tutorial for BECWidget base class ([`ac2cb51`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ac2cb5197deef4d51e26ee5beb070eba3ffc210d))
-
 ### Fix
 
 * fix(theme): apply theme to all pyqtgraph widgets on manual updates ([`c550186`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c5501860e8e07a53f4bce144d44ed39eda6290ef))
-
-### Refactor
-
-* refactor(buttons): changed grid and thumbnail fig in gallery ([`4591ba8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4591ba8f73e22aba7258cad93c073f1387cb74a0))
-
-* refactor(icons): removed toolbar icons from assets ([`f335763`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f335763280adb1d83ba31f073ce206e4cb5d15ef))
-
-* refactor(icons): moved widget icons to class attribute ICON_NAME ([`e890091`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e890091d862e42317c7a54fc414ba37c85f268b0))
-
-## v0.99.3 (2024-08-27)
-
-### Build
-
-* build: updated min version of bec qthemes ([`d482434`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d48243483ef8228cc5eb85e40a6b8f5da3b45520))
-
-### Fix
-
-* fix(cmaps): unified all defaults to magma cmap ([`1ca9499`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1ca9499edd334c19fe1e7aac71d3940a80a1ec95))
-
-* fix(color maps): color maps should take the background color into account; fixed min colors to 10 ([`060935f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/060935ffc5472a958c337bf60834c5291f104ece))
-
-## v0.99.2 (2024-08-27)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.100.0
+Version: 0.102.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -26,6 +26,7 @@ class Widgets(str, enum.Enum):
     DeviceBrowser = "DeviceBrowser"
     DeviceComboBox = "DeviceComboBox"
     DeviceLineEdit = "DeviceLineEdit"
+    LMFitDialog = "LMFitDialog"
     PositionerBox = "PositionerBox"
     PositionerControlLine = "PositionerControlLine"
     ResetButton = "ResetButton"
@@ -1811,6 +1812,15 @@ class BECWaveform(RPCBase):
             BECCurve: The curve object.
         """
 
+    @rpc_call
+    def get_dap_params(self) -> "dict":
+        """
+        Get the DAP parameters of all DAP curves.
+
+        Returns:
+            dict: DAP parameters of all DAP curves.
+        """
+
     @rpc_call
     def set_x(self, x_name: "str", x_entry: "str | None" = None):
         """
@@ -1825,15 +1835,6 @@ class BECWaveform(RPCBase):
             x_entry(str): Entry of the x signal.
         """
 
-    @rpc_call
-    def get_dap_params(self) -> "dict":
-        """
-        Get the DAP parameters of all DAP curves.
-
-        Returns:
-            dict: DAP parameters of all DAP curves.
-        """
-
     @rpc_call
     def remove_curve(self, *identifiers):
         """
@@ -2096,10 +2097,10 @@ class BECWaveformWidget(RPCBase):
         self,
         x_name: "str",
         y_name: "str",
+        dap: "str",
         x_entry: "str | None" = None,
         y_entry: "str | None" = None,
         color: "str | None" = None,
-        dap: "str" = "GaussianModel",
         validate_bec: "bool" = True,
         **kwargs,
     ) -> "BECCurve":
@@ -2313,7 +2314,7 @@ class BECWaveformWidget(RPCBase):
 
 class DarkModeButton(RPCBase):
     @rpc_call
-    def toggle_dark_mode(self) -> None:
+    def toggle_dark_mode(self) -> "None":
         """
         Toggle the dark mode state. This will change the theme of the entire
         application to dark or light mode.
@@ -2392,6 +2393,24 @@ class DeviceLineEdit(RPCBase):
         """
 
 
+class LMFitDialog(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
 class PositionerBox(RPCBase):
     @rpc_call
     def set_positioner(self, positioner: "str | Positioner"):

bec_widgets/qt_utils/toolbar.py

@@ -162,6 +162,7 @@ class WidgetAction(ToolBarAction):
     def add_to_toolbar(self, toolbar, target):
         widget = QWidget()
         layout = QHBoxLayout(widget)
+        layout.setContentsMargins(0, 0, 0, 0)
         if self.label is not None:
             label = QLabel(f"{self.label}")
             layout.addWidget(label)

bec_widgets/widgets/bec_queue/bec_queue.py

@@ -1,11 +1,18 @@
 from __future__ import annotations
 
 from bec_lib.endpoints import MessageEndpoints
-from qtpy.QtCore import Qt, Slot
-from qtpy.QtWidgets import QHBoxLayout, QHeaderView, QTableWidget, QTableWidgetItem, QWidget
+from bec_qthemes import material_icon
+from qtpy.QtCore import Property, Qt, Slot
+from qtpy.QtGui import QColor
+from qtpy.QtWidgets import QHeaderView, QLabel, QTableWidget, QTableWidgetItem, QVBoxLayout, QWidget
 
+from bec_widgets.qt_utils.toolbar import ModularToolBar, SeparatorAction, WidgetAction
 from bec_widgets.utils.bec_connector import ConnectionConfig
 from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.widgets.button_abort.button_abort import AbortButton
+from bec_widgets.widgets.button_reset.button_reset import ResetButton
+from bec_widgets.widgets.button_resume.button_resume import ResumeButton
+from bec_widgets.widgets.stop_button.stop_button import StopButton
 
 
 class BECQueue(BECWidget, QWidget):
@@ -14,6 +21,15 @@ class BECQueue(BECWidget, QWidget):
     """
 
     ICON_NAME = "edit_note"
+    status_colors = {
+        "STOPPED": "red",
+        "PENDING": "orange",
+        "IDLE": "gray",
+        "PAUSED": "yellow",
+        "DEFERRED_PAUSE": "lightyellow",
+        "RUNNING": "green",
+        "COMPLETED": "blue",
+    }
 
     def __init__(
         self,
@@ -21,19 +37,79 @@ class BECQueue(BECWidget, QWidget):
         client=None,
         config: ConnectionConfig = None,
         gui_id: str = None,
+        refresh_upon_start: bool = True,
     ):
         super().__init__(client, config, gui_id)
         QWidget.__init__(self, parent=parent)
+        self.layout = QVBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+
+        # Set up the toolbar
+        self.set_toolbar()
+
+        # Set up the table
         self.table = QTableWidget(self)
-        self.layout = QHBoxLayout(self)
         self.layout.addWidget(self.table)
-
-        self.table.setColumnCount(3)
-        self.table.setHorizontalHeaderLabels(["Scan Number", "Type", "Status"])
+        self.table.setColumnCount(4)
+        self.table.setHorizontalHeaderLabels(["Scan Number", "Type", "Status", "Cancel"])
         header = self.table.horizontalHeader()
         header.setSectionResizeMode(QHeaderView.Stretch)
+
         self.bec_dispatcher.connect_slot(self.update_queue, MessageEndpoints.scan_queue_status())
         self.reset_content()
+        if refresh_upon_start:
+            self.refresh_queue()
+
+    def set_toolbar(self):
+        """
+        Set the toolbar.
+        """
+        widget_label = QLabel("Live Queue")
+        widget_label.setStyleSheet("font-weight: bold;")
+        self.toolbar = ModularToolBar(
+            actions={
+                "widget_label": WidgetAction(widget=widget_label),
+                "separator_1": SeparatorAction(),
+                "resume": WidgetAction(widget=ResumeButton(toolbar=False)),
+                "stop": WidgetAction(widget=StopButton(toolbar=False)),
+                "reset": WidgetAction(widget=ResetButton(toolbar=False)),
+            },
+            target_widget=self,
+        )
+
+        self.layout.addWidget(self.toolbar)
+
+    @Property(bool)
+    def hide_toolbar(self):
+        """Property to hide the BEC Queue toolbar."""
+        return not self.toolbar.isVisible()
+
+    @hide_toolbar.setter
+    def hide_toolbar(self, hide: bool):
+        """
+        Setters for the hide_toolbar property.
+
+        Args:
+            hide(bool): Whether to hide the toolbar.
+        """
+        self._hide_toolbar(hide)
+
+    def _hide_toolbar(self, hide: bool):
+        """
+        Hide the toolbar.
+
+        Args:
+            hide(bool): Whether to hide the toolbar.
+        """
+        self.toolbar.setVisible(not hide)
+
+    def refresh_queue(self):
+        """
+        Refresh the queue.
+        """
+        msg = self.client.connector.get(MessageEndpoints.scan_queue_status())
+        self.update_queue(msg.content, msg.metadata)
 
     @Slot(dict, dict)
     def update_queue(self, content, _metadata):
@@ -57,6 +133,7 @@ class BECQueue(BECWidget, QWidget):
             blocks = item.get("request_blocks", [])
             scan_types = []
             scan_numbers = []
+            scan_ids = []
             status = item.get("status", "")
             for request_block in blocks:
                 scan_type = request_block.get("content", {}).get("scan_type", "")
@@ -65,13 +142,18 @@ class BECQueue(BECWidget, QWidget):
                 scan_number = request_block.get("scan_number", "")
                 if scan_number:
                     scan_numbers.append(str(scan_number))
+                scan_id = request_block.get("scan_id", "")
+                if scan_id:
+                    scan_ids.append(scan_id)
             if scan_types:
                 scan_types = ", ".join(scan_types)
             if scan_numbers:
                 scan_numbers = ", ".join(scan_numbers)
-            self.set_row(index, scan_numbers, scan_types, status)
+            if scan_ids:
+                scan_ids = ", ".join(scan_ids)
+            self.set_row(index, scan_numbers, scan_types, status, scan_ids)
 
-    def format_item(self, content: str) -> QTableWidgetItem:
+    def format_item(self, content: str, status=False) -> QTableWidgetItem:
         """
         Format the content of the table item.
 
@@ -85,9 +167,17 @@ class BECQueue(BECWidget, QWidget):
             content = ""
         item = QTableWidgetItem(content)
         item.setTextAlignment(Qt.AlignHCenter | Qt.AlignVCenter)
+        # item.setFlags(item.flags() & ~Qt.ItemFlag.ItemIsEditable)
+
+        if status:
+            try:
+                color = self.status_colors.get(content, "black")  # Default to black if not found
+                item.setForeground(QColor(color))
+            except:
+                return item
         return item
 
-    def set_row(self, index: int, scan_number: str, scan_type: str, status: str):
+    def set_row(self, index: int, scan_number: str, scan_type: str, status: str, scan_id: str):
         """
         Set the row of the table.
 
@@ -97,10 +187,42 @@ class BECQueue(BECWidget, QWidget):
             scan_type (str): The scan type.
             status (str): The status.
         """
+        abort_button = self._create_abort_button(scan_id)
+        abort_button.button.clicked.connect(self.delete_selected_row)
 
         self.table.setItem(index, 0, self.format_item(scan_number))
         self.table.setItem(index, 1, self.format_item(scan_type))
-        self.table.setItem(index, 2, self.format_item(status))
+        self.table.setItem(index, 2, self.format_item(status, status=True))
+        self.table.setCellWidget(index, 3, abort_button)
+
+    def _create_abort_button(self, scan_id: str) -> AbortButton:
+        """
+        Create an abort button with styling for BEC Queue widget for certain scan_id.
+
+        Args:
+            scan_id(str): The scan id to abort.
+
+        Returns:
+            AbortButton: The abort button.
+        """
+        abort_button = AbortButton(scan_id=scan_id)
+
+        abort_button.button.setText("")
+        abort_button.button.setIcon(
+            material_icon("cancel", color="#cc181e", filled=True, convert_to_pixmap=False)
+        )
+        abort_button.button.setStyleSheet("background-color:  rgba(0,0,0,0) ")
+        abort_button.button.setFlat(True)
+
+        return abort_button
+
+    def delete_selected_row(self):
+
+        button = self.sender()
+        row = self.table.indexAt(button.pos()).row()
+        self.table.removeRow(row)
+
+        button.deleteLater()
 
     def reset_content(self):
         """
@@ -108,7 +230,7 @@ class BECQueue(BECWidget, QWidget):
         """
 
         self.table.setRowCount(1)
-        self.set_row(0, "", "", "")
+        self.set_row(0, "", "", "", "")
 
 
 if __name__ == "__main__":  # pragma: no cover

bec_widgets/widgets/button_abort/button_abort.py

@@ -11,7 +11,9 @@ class AbortButton(BECWidget, QWidget):
 
     ICON_NAME = "cancel"
 
-    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+    def __init__(
+        self, parent=None, client=None, config=None, gui_id=None, toolbar=False, scan_id=None
+    ):
         super().__init__(client=client, config=config, gui_id=gui_id)
         QWidget.__init__(self, parent=parent)
 
@@ -25,17 +27,19 @@ class AbortButton(BECWidget, QWidget):
         if toolbar:
             icon = material_icon("cancel", color="#666666", filled=True)
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.abort_scan)
+            self.button.setToolTip("Abort the scan")
         else:
             self.button = QPushButton()
             self.button.setText("Abort")
             self.button.setStyleSheet(
                 "background-color:  #666666; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.abort_scan)
+        self.button.clicked.connect(self.abort_scan)
 
         self.layout.addWidget(self.button)
 
+        self.scan_id = scan_id
+
     @SafeSlot()
     def abort_scan(
         self,
@@ -46,4 +50,8 @@ class AbortButton(BECWidget, QWidget):
         Args:
             scan_id(str|None): The scan id to abort. If None, the current scan will be aborted.
         """
-        self.queue.request_scan_abortion()
+        if self.scan_id is not None:
+            print(f"Aborting scan with scan_id: {self.scan_id}")
+            self.queue.request_scan_abortion(scan_id=self.scan_id)
+        else:
+            self.queue.request_scan_abortion()

bec_widgets/widgets/button_reset/button_reset.py

@@ -1,13 +1,13 @@
 from bec_qthemes import material_icon
 from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+from qtpy.QtWidgets import QHBoxLayout, QMessageBox, QPushButton, QToolButton, QWidget
 
 from bec_widgets.qt_utils.error_popups import SafeSlot
 from bec_widgets.utils.bec_widget import BECWidget
 
 
 class ResetButton(BECWidget, QWidget):
-    """A button that reset the scan queue."""
+    """A button that resets the scan queue."""
 
     ICON_NAME = "restart_alt"
 
@@ -23,20 +23,37 @@ class ResetButton(BECWidget, QWidget):
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
         if toolbar:
-            icon = material_icon("restart_alt", color="#F19E39", filled=True)
+            icon = material_icon(
+                "restart_alt", color="#F19E39", filled=True, convert_to_pixmap=False
+            )
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.reset_queue)
+            self.button.setToolTip("Reset the scan queue")
         else:
             self.button = QPushButton()
             self.button.setText("Reset Queue")
             self.button.setStyleSheet(
                 "background-color:  #F19E39; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.reset_queue)
+        self.button.clicked.connect(self.confirm_reset_queue)
 
         self.layout.addWidget(self.button)
 
+    @SafeSlot()
+    def confirm_reset_queue(self):
+        """Prompt the user to confirm the queue reset."""
+        msg_box = QMessageBox()
+        msg_box.setIcon(QMessageBox.Warning)
+        msg_box.setWindowTitle("Confirm Reset")
+        msg_box.setText(
+            "Are you sure you want to reset the scan queue? This action cannot be undone."
+        )
+        msg_box.setStandardButtons(QMessageBox.Yes | QMessageBox.No)
+        msg_box.setDefaultButton(QMessageBox.No)
+
+        if msg_box.exec_() == QMessageBox.Yes:
+            self.reset_queue()
+
     @SafeSlot()
     def reset_queue(self):
-        """Stop the scan."""
+        """Reset the scan queue."""
         self.queue.request_queue_reset()

bec_widgets/widgets/button_resume/button_resume.py

@@ -23,16 +23,16 @@ class ResumeButton(BECWidget, QWidget):
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
         if toolbar:
-            icon = material_icon("resume", color="#2793e8", filled=True)
+            icon = material_icon("resume", color="#2793e8", filled=True, convert_to_pixmap=False)
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.continue_scan)
+            self.button.setToolTip("Resume the scan queue")
         else:
             self.button = QPushButton()
             self.button.setText("Resume")
             self.button.setStyleSheet(
                 "background-color:  #2793e8; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.continue_scan)
+        self.button.clicked.connect(self.continue_scan)
 
         self.layout.addWidget(self.button)
 

bec_widgets/widgets/figure/plots/waveform/waveform.py

@@ -49,8 +49,8 @@ class BECWaveform(BECPlotBase):
         "_config_dict",
         "plot",
         "add_dap",
-        "set_x",
         "get_dap_params",
+        "set_x",
         "remove_curve",
         "scan_history",
         "curves",
@@ -74,8 +74,8 @@ class BECWaveform(BECPlotBase):
     ]
     scan_signal_update = pyqtSignal()
     async_signal_update = pyqtSignal()
-    dap_params_update = pyqtSignal(dict)
-    dap_summary_update = pyqtSignal(dict)
+    dap_params_update = pyqtSignal(dict, dict)
+    dap_summary_update = pyqtSignal(dict, dict)
     autorange_signal = pyqtSignal()
     new_scan = pyqtSignal()
 
@@ -1085,8 +1085,9 @@ class BECWaveform(BECPlotBase):
                     curve.setData(x, y)
                     curve.dap_params = msg["data"][1]["fit_parameters"]
                     curve.dap_summary = msg["data"][1]["fit_summary"]
-                    self.dap_params_update.emit(curve.dap_params)
-                    self.dap_summary_update.emit(curve.dap_summary)
+                    metadata.update({"curve_id": curve_id_request})
+                    self.dap_params_update.emit(curve.dap_params, metadata)
+                    self.dap_summary_update.emit(curve.dap_summary, metadata)
                 break
 
     @Slot(dict, dict)

bec_widgets/widgets/lmfit_dialog/lm_fit_dialog.pyproject

@@ -0,0 +1 @@
+{'files': ['lmfit_dialog.py']}

bec_widgets/widgets/lmfit_dialog/lm_fit_dialog_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.lmfit_dialog.lmfit_dialog import LMFitDialog
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='LMFitDialog' name='lm_fit_dialog'>
+    </widget>
+</ui>
+"""
+
+
+class LMFitDialogPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = LMFitDialog(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Utils"
+
+    def icon(self):
+        return designer_material_icon(LMFitDialog.ICON_NAME)
+
+    def includeFile(self):
+        return "lm_fit_dialog"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "LMFitDialog"
+
+    def toolTip(self):
+        return "LMFitDialog"
+
+    def whatsThis(self):
+        return self.toolTip()