bapsf-motion 0.2.1__tar.gz → 0.2.2__tar.gz

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: bapsf_motion
-Version: 0.2.1
+Version: 0.2.2
 Summary: Package for controlling motion devices in a BaPSF DAQ system
 Author: Basic Plasma Science Facility
 Keywords: plasma physics,plasma,science,bapsf,motion
@@ -30,6 +30,7 @@ Requires-Dist: tomli_w
 Requires-Dist: tqdm
 Requires-Dist: xarray
 Provides-Extra: gui
+Requires-Dist: pygame; extra == "gui"
 Requires-Dist: PySide6; python_version >= "3.10" and extra == "gui"
 Requires-Dist: PySide6<=6.3.1; python_version < "3.10" and extra == "gui"
 Requires-Dist: qtawesome; extra == "gui"
@@ -62,6 +63,7 @@ Provides-Extra: extras
 Requires-Dist: black; extra == "extras"
 Requires-Dist: isort; extra == "extras"
 Provides-Extra: developer
+Requires-Dist: pygame; extra == "developer"
 Requires-Dist: PySide6; python_version >= "3.10" and extra == "developer"
 Requires-Dist: PySide6<=6.3.1; python_version < "3.10" and extra == "developer"
 Requires-Dist: qtawesome; extra == "developer"

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/actors/axis_.py

@@ -354,10 +354,10 @@ class Axis(EventActor):
         """
         return self.send_command("move_to", *args)
 
-    def stop(self):
+    def stop(self, soft=False):
         """
         Quick access command for ``send_command("stop")``.
         """
         # not sending STOP command through send_command() since using
         # motor.stop() should result in faster execution
-        return self.motor.stop()
+        return self.motor.stop(soft=soft)

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/actors/drive_.py

@@ -292,7 +292,7 @@ class Drive(EventActor):
             Any arguments to the ``command`` that will be sent with the
             motor command.
         axis: int, optional
-            Axis index the comment is directed to.  If `None`, then the
+            Axis index the command is directed to.  If `None`, then the
             command is sent to all axes. (DEFAULT: `NONE`)
         """
         if axis is None:
@@ -365,14 +365,20 @@ class Drive(EventActor):
 
         return rtn
 
-    def stop(self):
+    def stop(self, soft=False):
         """Stop all axes from moving."""
         # TODO: should I really be construct a return here?
         # TODO: is there a quicker/more efficient way of stopping the motors?
 
         rtn = []
         for ax in self.axes:
-            _rtn = ax.stop()
+            if ax.motor.terminated:
+                self.logger.warning(
+                    f"Motor for axis {ax.name} has been terminated, can NOT "
+                    f"perform STOP command."
+                )
+                continue
+            _rtn = ax.stop(soft=soft)
             rtn.append(_rtn)
 
         return rtn

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/actors/motion_group_.py

@@ -924,9 +924,9 @@ class MotionGroup(EventActor):
         ).squeeze()
         return pos * dr_pos.unit
 
-    def stop(self):
+    def stop(self, soft=False):
         """Immediately stop the probe drive motion."""
-        self.drive.stop()
+        self.drive.stop(soft=soft)
 
     def move_to(self, pos, axis: Optional[int] = None):
         """

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/actors/motor_.py

@@ -275,6 +275,12 @@ class Motor(EventActor):
             recv=re.compile(r"BS=(?P<return>[0-9]\.?[0-9]?)"),
             recv_processor=int,
         ),
+        "commence_jogging": CommandEntry("commence_jogging", send="CJ"),
+        "continuous_jog": CommandEntry(
+            "continuous_jog",
+            send="",
+            method_command=True,
+        ),
         "current": CommandEntry(
             "change_current",
             send="CC",
@@ -341,6 +347,33 @@ class Motor(EventActor):
             recv_processor=float,
             two_way=True,
         ),
+        "jog_acceleration": CommandEntry(
+            "jog_acceleration",
+            send="JA",
+            send_processor=lambda value: f"{float(value):.3f}",
+            recv=re.compile(r"JA=(?P<return>[0-9]+\.?[0-9]*)"),
+            recv_processor=float,
+            two_way=True,
+            units=u.rev / u.s / u.s,
+        ),
+        "jog_deceleration": CommandEntry(
+            "jog_deceleration",
+            send="JL",
+            send_processor=lambda value: f"{float(value):.3f}",
+            recv=re.compile(r"JL=(?P<return>[0-9]+\.?[0-9]*)"),
+            recv_processor=float,
+            two_way=True,
+            units=u.rev / u.s / u.s,
+        ),
+        "jog_speed": CommandEntry(
+            "jog_speed",
+            send="JS",
+            send_processor=lambda value: f"{float(value):.4f}",
+            recv=re.compile(r"JS=(?P<return>[0-9]+\.?[0-9]*)"),
+            recv_processor=float,
+            two_way=True,
+            units=u.rev / u.s,
+        ),
         "kill": CommandEntry(
             "stop_and_kill",  # immediately stop moving and erase queue
             send="SK",
@@ -418,7 +451,11 @@ class Motor(EventActor):
             two_way=True,
             units=u.rev / u.s,
         ),
-        "stop": CommandEntry("stop", send="SK"),
+        "stop": CommandEntry(
+            "stop",
+            send="SK",
+            send_processor=lambda soft: "D" if bool(soft) else "",
+        ),
         "target_distance": CommandEntry(
             "target_distance",
             send="DI",
@@ -699,7 +736,7 @@ class Motor(EventActor):
 
     def _lost_connection(self, rtn: Any = None):
         """
-        Check if the motor connection as lost by examining the return
+        Check if the motor connection was lost by examining the return
         value from send_command.
         """
         if rtn is None:
@@ -732,6 +769,7 @@ class Motor(EventActor):
 
         # set a slower speed
         self.send_command("speed", 4.0)
+        self.send_command("jog_speed", 4.0)
 
     def _read_and_set_protocol(self):
         """
@@ -1627,9 +1665,32 @@ class Motor(EventActor):
         except AttributeError:
             pass
 
-    def stop(self):
+    def continuous_jog(self, direction="forward"):
+        """
+        Start a continuous jog.  The motor will not stop until
+        commanded to.
+        """
+        if self.status["alarm"]:
+            self.send_command("alarm_reset")
+            alarm_msg = self.retrieve_motor_alarm(defer_status_update=True)
+
+            if self._lost_connection(alarm_msg) or alarm_msg["alarm_message"]:
+                self.logger.error(
+                    f"Motor alarm could not be reset. -- {alarm_msg}"
+                )
+                return None
+
+        self.enable()
+
+        # The direction of the commence_jogging is defined by the side
+        # of the target_distance (DI) command
+        direction = -1 if direction == "backward" else 1
+        self.send_command("target_distance", direction)
+        self.send_command("commence_jogging")
+
+    def stop(self, soft=False):
         """Stop motor movement."""
-        self.send_command("stop")
+        self.send_command("stop", soft)
 
     def move_to(self, pos: int):
         """

bapsf_motion-0.2.2/bapsf_motion/gui/__init__.py

@@ -0,0 +1,14 @@
+"""Subpackage containing GUI's for `bapsf_motion`."""
+__all__ = [
+    "ConfigureApp",
+    "get_qapplication",
+    "get_color_scheme",
+    "cast_color_to_rgba_string",
+]
+
+from bapsf_motion.gui.configure.configure_ import ConfigureApp
+from bapsf_motion.gui.helpers import (
+    get_qapplication,
+    get_color_scheme,
+    cast_color_to_rgba_string,
+)

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/gui/configure/__init__.py

@@ -5,7 +5,8 @@ if __name__ == "__main__":
     import argparse
     import pathlib
 
-    from PySide6.QtWidgets import QApplication
+    # from PySide6.QtWidgets import QApplication
+    from bapsf_motion.gui.configure.configure_ import ConfigureApp
 
     parser = argparse.ArgumentParser(
         description="Launch the bapsf_motion Configuration GUI (ConfigureGUI)",
@@ -36,12 +37,17 @@ if __name__ == "__main__":
     elif args.config_file is not None:
         args.config_file = args.config_file.resolve()
 
-    app = QApplication([])
+    # app = QApplication([])
+    #
+    # window = ConfigureGUI(
+    #     config=args.config_file,
+    #     defaults=args.defaults_file,
+    # )
+    # window.show()
 
-    window = ConfigureGUI(
+    app = ConfigureApp(
+        [],
         config=args.config_file,
         defaults=args.defaults_file,
     )
-    window.show()
-
     app.exec()

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/gui/configure/bases.py

@@ -4,13 +4,13 @@ import logging
 
 from abc import abstractmethod
 from PySide6.QtCore import Qt, Signal
-from PySide6.QtGui import QColor, QPainter
+from PySide6.QtGui import QColor, QPainter, QPen
 from PySide6.QtWidgets import QWidget, QSizePolicy
 from typing import Union
 
 from bapsf_motion.actors import MotionGroup
 from bapsf_motion.gui.configure.helpers import gui_logger
-from bapsf_motion.gui.widgets import StyleButton
+from bapsf_motion.gui.widgets import DiscardButton, DoneButton
 from bapsf_motion.gui.configure import motion_group_widget as mgw
 
 
@@ -24,13 +24,15 @@ class _OverlayWidget(QWidget):
         # self.setWindowFlags(Qt.WindowType.FramelessWindowHint)
         self.setAttribute(Qt.WidgetAttribute.WA_TranslucentBackground)
         self.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Expanding)
-        self.setStyleSheet("_OverlayWidget{ border: 2px solid black }")
 
-        self.background_fill_color = QColor(30, 30, 30, 120)
-        self.background_pen_color = QColor(30, 30, 30, 120)
+        self.background_fill_color = QColor(30, 30, 30, 100)
+        self.background_pen_color = QColor(30, 30, 30, 200)
 
-        self.overlay_fill_color = QColor(50, 50, 50)
-        self.overlay_pen_color = QColor(90, 90, 90)
+        _palette = self.style().standardPalette()
+        self.overlay_fill_color = _palette.color(_palette.ColorRole.Window)
+
+        self.overlay_pen = QPen(QColor(60, 60, 60))
+        self.overlay_pen.setWidth(3)
 
         self._margins = [0.01, 0.01]  # [ w_margin / width, h_margin / height]
         self._set_contents_margins(*self._margins)
@@ -55,7 +57,9 @@ class _OverlayWidget(QWidget):
         qp.drawRoundedRect(0, 0, s.width(), s.height(), 3, 3)
 
         # draw overlay
-        qp.setPen(self.overlay_pen_color)
+        _pen = QPen(self.overlay_pen)
+        _pen.setWidth(3)
+        qp.setPen(_pen)
         qp.setBrush(self.overlay_fill_color)
 
         self.contentsRect().width()
@@ -89,25 +93,11 @@ class _ConfigOverlay(_OverlayWidget):
 
         # Define BUTTONS
 
-        _btn = StyleButton("Add / Update", parent=self)
-        _btn.setFixedWidth(200)
-        _btn.setFixedHeight(48)
-        font = _btn.font()
-        font.setPointSize(24)
-        _btn.setFont(font)
+        _btn = DoneButton("Add / Update", parent=self)
         _btn.setEnabled(False)
         self.done_btn = _btn
 
-        _btn = StyleButton("Discard", parent=self)
-        _btn.setFixedWidth(250)
-        _btn.setFixedHeight(48)
-        font = _btn.font()
-        font.setPointSize(24)
-        font.setBold(True)
-        _btn.setFont(font)
-        _btn.update_style_sheet(
-            {"background-color": "rgb(255, 110, 110)"}
-        )
+        _btn = DiscardButton(parent=self)
         self.discard_btn = _btn
 
     def _connect_signals(self):

bapsf_motion-0.2.2/bapsf_motion/gui/configure/configure.qss

@@ -0,0 +1,11 @@
+/* This is the QSS (similar to CSS) Style Sheet for the ConfigureGUI
+ *
+ * Useful links:
+ *
+ * - Qt Style Sheets
+ *   https://doc.qt.io/qt-6/stylesheet.html
+ * - Style Sheet Syntax
+ *   https://doc.qt.io/qt-6/stylesheet-syntax.html
+ * - Style Sheet Reference
+ *   https://doc.qt.io/qt-6/stylesheet-reference.html
+ */

{bapsf_motion-0.2.1 → bapsf_motion-0.2.2}/bapsf_motion/gui/configure/configure_.py

@@ -1,7 +1,7 @@
 """
 This module defines the configuration GUI for construction data runs.
 """
-__all__ = ["ConfigureGUI"]
+__all__ = ["ConfigureGUI", "ConfigureApp"]
 
 import logging
 import logging.config
@@ -16,6 +16,7 @@ from PySide6.QtCore import (
 )
 from PySide6.QtGui import QCloseEvent, QIcon
 from PySide6.QtWidgets import (
+    QApplication,
     QMainWindow,
     QHBoxLayout,
     QLabel,
@@ -30,7 +31,7 @@ from PySide6.QtWidgets import (
     QStackedWidget,
     QListWidgetItem,
 )
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Union
 
 # noqa
 # import of qtawesome must happen after the PySide6 imports
@@ -39,10 +40,19 @@ import qtawesome as qta
 from bapsf_motion.actors import RunManager, RunManagerConfig, MotionGroup
 from bapsf_motion.gui.configure.helpers import gui_logger, gui_logger_config_dict
 from bapsf_motion.gui.configure.motion_group_widget import MGWidget
-from bapsf_motion.gui.widgets import QLogger, StyleButton, VLinePlain
+from bapsf_motion.gui.widgets import (
+    DiscardButton,
+    DoneButton,
+    QLogger,
+    StyleButton,
+    VLinePlain,
+)
 from bapsf_motion.utils import toml, _deepcopy_dict
 
 
+_HERE = Path(__file__).parent
+
+
 class RunWidget(QWidget):
     def __init__(self, parent: "ConfigureGUI"):
         super().__init__(parent=parent)
@@ -51,68 +61,47 @@ class RunWidget(QWidget):
 
         # Define BUTTONS
 
-        _btn = StyleButton("DONE")
-        _btn.setFixedWidth(200)
-        _btn.setFixedHeight(48)
-        font = _btn.font()
-        font.setPointSize(24)
-        _btn.setFont(font)
-        self.done_btn = _btn
+        self.done_btn = DoneButton(parent=self)
+        self.quit_btn = DiscardButton("Discard && Quit", parent=self)
 
-        _btn = StyleButton("Discard && Quit")
-        _btn.setFixedWidth(200)
+        _btn = StyleButton("IMPORT", parent=self)
         _btn.setFixedHeight(48)
-        font = _btn.font()
-        font.setPointSize(24)
-        font.setBold(True)
-        _btn.setFont(font)
-        _btn.update_style_sheet({"background-color": "rgb(255, 110, 110)"})
-        self.quit_btn = _btn
-
-        _btn = StyleButton("IMPORT")
-        _btn.setFixedHeight(28)
-        font = _btn.font()
-        font.setPointSize(16)
-        _btn.setFont(font)
+        _btn.setPointSize(16)
+        _btn.setEnabled(False)
         self.import_btn = _btn
 
-        _btn = StyleButton("EXPORT")
-        _btn.setFixedHeight(28)
-        font = _btn.font()
-        font.setPointSize(16)
-        _btn.setFont(font)
+        _btn = StyleButton("EXPORT", parent=self)
+        _btn.setFixedHeight(48)
+        _btn.setPointSize(16)
+        _btn.setEnabled(False)
         self.export_btn = _btn
 
-        _btn = StyleButton("ADD")
-        _btn.setFixedHeight(32)
-        font = _btn.font()
-        font.setPointSize(16)
-        _btn.setFont(font)
-        _btn.setEnabled(True)
+        _btn = StyleButton("ADD", parent=self)
+        _btn.setFixedHeight(38)
+        _btn.setPointSize(16)
         self.add_mg_btn = _btn
 
-        _btn = StyleButton("REMOVE")
-        _btn.setFixedHeight(32)
-        font = _btn.font()
-        font.setPointSize(16)
-        _btn.setFont(font)
+        _btn = StyleButton("REMOVE", parent=self)
+        _btn.setFixedHeight(38)
+        _btn.setPointSize(16)
         _btn.setEnabled(False)
         self.remove_mg_btn = _btn
 
-        _btn = StyleButton("Edit / Control")
-        _btn.setFixedHeight(32)
-        font = _btn.font()
-        font.setPointSize(16)
-        _btn.setFont(font)
+        _btn = StyleButton("Edit / Control", parent=self)
+        _btn.setFixedHeight(38)
+        _btn.setPointSize(16)
         _btn.setEnabled(False)
         self.modify_mg_btn = _btn
 
         # Define TEXT WIDGETS
 
-        self.config_widget = QTextEdit()
-        self.mg_list_widget = QListWidget()
+        self.config_widget = QTextEdit(parent=self)
+        self.mg_list_widget = QListWidget(parent=self)
+        _font = self.mg_list_widget.font()
+        _font.setPointSize(14)
+        self.mg_list_widget.setFont(_font)
 
-        _txt_widget = QLineEdit()
+        _txt_widget = QLineEdit(parent=self)
         font = _txt_widget.font()
         font.setPointSize(16)
         _txt_widget.setFont(font)
@@ -128,14 +117,14 @@ class RunWidget(QWidget):
         banner_layout = self._define_banner_layout()
 
         # Create layout for toml window
-        toml_widget = QWidget()
+        toml_widget = QWidget(parent=self)
         toml_widget.setLayout(self._define_toml_layout())
         toml_widget.setMinimumWidth(400)
         toml_widget.setMinimumWidth(500)
         toml_widget.sizeHint().setWidth(450)
 
         # Create layout for controls
-        control_widget = QWidget()
+        control_widget = QWidget(parent=self)
         control_widget.setLayout(self._define_control_layout())
 
         # Construct layout below top banner
@@ -153,7 +142,7 @@ class RunWidget(QWidget):
 
     def _define_toml_layout(self):
         layout = QGridLayout()
-        label = QLabel("Run Configuration")
+        label = QLabel("Run Configuration", parent=self)
         label.setAlignment(
             Qt.AlignmentFlag.AlignCenter | Qt.AlignmentFlag.AlignBottom
         )
@@ -171,8 +160,8 @@ class RunWidget(QWidget):
 
         layout.addWidget(label, 0, 0, 1, 2)
         layout.addWidget(self.config_widget, 1, 0, 1, 2)
-        layout.addWidget(self.import_btn, 2, 0, 1, 1)
-        layout.addWidget(self.export_btn, 2, 1, 1, 1)
+        layout.addWidget(self.import_btn, 2, 0)
+        layout.addWidget(self.export_btn, 2, 1)
 
         return layout
 
@@ -188,7 +177,7 @@ class RunWidget(QWidget):
     def _define_control_layout(self):
         layout = QVBoxLayout()
 
-        run_label = QLabel("Run Name:  ")
+        run_label = QLabel("Run Name:  ", parent=self)
         run_label.setAlignment(
             Qt.AlignmentFlag.AlignVCenter | Qt. AlignmentFlag.AlignLeft
         )
@@ -197,7 +186,7 @@ class RunWidget(QWidget):
         font.setPointSize(16)
         run_label.setFont(font)
 
-        mg_label = QLabel("Defined Motion Groups")
+        mg_label = QLabel("Defined Motion Groups", parent=self)
         mg_label.setAlignment(
             Qt.AlignmentFlag.AlignVCenter | Qt.AlignmentFlag.AlignCenter
         )
@@ -237,7 +226,7 @@ class RunWidget(QWidget):
 
     @property
     def rm(self) -> Union[RunManager, None]:
-        parent = self.parent()  # type: "ConfigureGUI"
+        parent = self.parentWidget()  # type: "ConfigureGUI"
         try:
             return parent.rm
         except AttributeError:
@@ -277,7 +266,7 @@ class ConfigureGUI(QMainWindow):
 
         # define "important" qt widgets
         self._log_widget = QLogger(self._logger, parent=self)
-        self._run_widget = RunWidget(self)
+        self._run_widget = RunWidget(parent=self)
         self._mg_widget = None  # type: Union[MGWidget, None]
 
         self._stacked_widget = QStackedWidget(parent=self)
@@ -324,7 +313,8 @@ class ConfigureGUI(QMainWindow):
     def _define_main_window(self):
         self.setWindowTitle("Run Configuration")
         self.resize(1760, 990)
-        self.setMinimumHeight(600)
+        self.setMinimumHeight(990)
+        self.setMinimumWidth(1760)
 
     def _define_layout(self):
 
@@ -368,7 +358,7 @@ class ConfigureGUI(QMainWindow):
         return self._logging_config_dict
 
     def replace_rm(self, config):
-        if isinstance(self.rm, RunManager) and not self.rm.terminate():
+        if isinstance(self.rm, RunManager) and not self.rm.terminated:
             self.rm.terminate()
 
         self.logger.info(f"Replacing the run manager with new config: {config}.")
@@ -603,3 +593,30 @@ class ConfigureGUI(QMainWindow):
         self._run_widget.close()
 
         event.accept()
+
+
+class ConfigureApp(QApplication):
+    qss_file_path = (_HERE / "configure.qss").resolve()
+
+    def __init__(
+        self,
+        *args,
+        config: Union[Path, str, Dict[str, Any], RunManagerConfig] = None,
+        defaults: Union[Path, str, Dict[str, Any], None] = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(*args, **kwargs)
+
+        self.setStyle("Fusion")
+        self.styleHints().setColorScheme(Qt.ColorScheme.Light)
+        self.reload_style_sheet()
+
+        self._window = ConfigureGUI(config=config, defaults=defaults)
+        self._window.show()
+        self._window.activateWindow()
+
+    def reload_style_sheet(self):
+        with open(self.qss_file_path, "r") as f:
+            qss_style = f.read()
+
+        self.setStyleSheet(qss_style)