bec-widgets 0.52.0__py3-none-any.whl → 0.53.0__py3-none-any.whl

docs/user/installation.md

@@ -0,0 +1,46 @@
+(user.installation)=
+# Installation
+
+
+**Prerequisites**
+
+Before installing BEC Widgets, please ensure the following requirements are met:
+
+1. **Python Version:** BEC Widgets requires Python version 3.10 or higher. Verify your Python version to ensure compatibility.
+2. **BEC Installation:** BEC Widgets works in conjunction with BEC. While BEC is a dependency and will be installed automatically, you can find more information about BEC and its installation process in the [BEC documentation](https://beamline-experiment-control.readthedocs.io/en/latest/).
+
+**Standard Installation**
+
+Install BEC Widgets using the pip package manager. Open your terminal and execute:
+
+```bash
+pip install bec_widgets
+```
+
+This command installs BEC Widgets along with its dependencies, including the default PyQt6.
+
+**Selecting a PyQt Version**
+
+BEC Widgets supports both PyQt5 and PyQt6. To install a specific version, use:
+
+For PyQt6:
+
+```bash
+pip install bec_widgets[pyqt6]
+```
+
+For PyQt5:
+
+```bash
+pip install bec_widgets[pyqt5]
+```
+
+**Troubleshooting**
+
+If you encounter issues during installation, particularly with PyQt, try purging the pip cache:
+
+```bash
+pip cache purge
+```
+
+This can resolve conflicts or issues with package installations.

docs/user/user.md

@@ -0,0 +1,38 @@
+(user)=
+# User
+
+**Overview**
+
+Welcome to the User section of the BEC Widgets documentation! BEC Widgets is a versatile GUI framework tailored for beamline scientists, enabling efficient and intuitive interaction with beamline experiments. This section is designed to guide both new and experienced users through the essential aspects of utilizing BEC Widgets.
+
+**Key Topics**
+
+- [Installing BEC Widgets](#user.installation): Instructions for installing BEC Widgets on your system.
+
+- [Example Applications](#user.apps): Overview of bespoke applications and demonstrations of BEC Widgets in action, showcasing its use in real-world beamline scenarios.
+
+- [Widgets Overview](#user.widgets): Detailed information on the variety of widgets available, their functions, and how to use them effectively.
+
+- [Customization and Configuration](#user.customisation): Tips on customizing and configuring BEC Widgets to suit your specific experimental needs using Qt Designer.
+
+**Bug Reports and Feature Requests**
+
+We value your feedback and contributions to improving BEC Widgets. If you encounter any issues or have ideas for new features, we encourage you to report them.
+
+- **Bug Reports:** If you find a bug or an issue, please report it on our repository's [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened). We have a template for bug reporting to help you provide all necessary information.
+- **Feature Requests:** Have an idea for a new feature or an enhancement? Share it with us on the [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened) of our repository. We have a feature request template that you can use to describe your proposal.
+
+**Development**
+
+For advanced details about BEC Widgets’ internal architecture, development contributions, or customization techniques, please explore the [Developer](#developer) section. 
+
+```{toctree}
+---
+maxdepth: 3
+hidden: true
+---
+
+installation
+apps
+widgets
+customisation

docs/user/widgets.md

@@ -0,0 +1,41 @@
+(user.widgets)=
+# Widgets
+
+## Visualization Widgets
+
+BEC Widgets includes a variety of visualization widgets designed to cater to diverse data representation needs in beamline experiments. These widgets enhance the user experience by providing intuitive and interactive data visualizations.
+
+### 1D Waveform Widget
+
+**Purpose:** This widget provides a straightforward visualization of 1D data. It is particularly useful for plotting positioner movements against detector readings, enabling users to observe correlations and patterns in a simple, linear format.
+
+**Key Features:**
+- Real-time plotting of positioner versus detector values.
+- Interactive controls for zooming and panning through the data.
+- Customizable visual elements such as line color and style.
+
+**Example of Use:**
+![Waveform 1D](./widgets/w1D.gif)
+### 2D Scatter Plot
+
+**Purpose:** The 2D scatter plot widget is designed for more complex data visualization. It employs a false color map to represent a third dimension (z-axis), making it an ideal tool for visualizing multidimensional data sets.
+
+**Key Features:**
+
+- 2D scatter plot with color-coded data points based on a third variable (two positioners for x/y vs. one detector for colormap).
+- Interactive false color map for enhanced data interpretation.
+- Tools for selecting and inspecting specific data points.
+
+**Example of Use:**
+![Waveform 1D](./widgets/scatter_2D.gif)
+### Motor Position Map
+
+**Purpose:** A specialized component derived from the Motor Alignment Tool. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans.
+
+**Key Features:**
+- Real-time tracking of motor positions.
+- Visual representation of motor trajectories, aiding in alignment tasks.
+- Ability to record and recall specific motor positions for repetitive tasks.
+
+**Example of Use:**
+![Waveform 1D](./widgets/motor.gif)

pyproject.toml

@@ -0,0 +1,94 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bec_widgets"
+version = "0.53.0"
+description = "BEC Widgets"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "pydantic",
+    "qtconsole",
+    "jedi",
+    "qtpy",
+    "pyqtgraph",
+    "bec_lib",
+    "zmq",
+    "h5py",
+    "pyqtdarktheme",
+    "black",
+]
+
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-random-order",
+    "pytest-timeout",
+    "coverage",
+    "pytest-qt",
+    "isort",
+    "fakeredis",
+]
+pyqt5 = ["PyQt5>=5.9"]
+pyqt6 = ["PyQt6>=6.7"]
+
+[project.urls]
+"Bug Tracker" = "https://gitlab.psi.ch/bec/bec_widgets/issues"
+Homepage = "https://gitlab.psi.ch/bec/bec_widgets"
+
+[tool.hatch.build.targets.wheel]
+include = ["*"]
+
+[tool.black]
+line-length = 100
+skip-magic-trailing-comma = true
+
+[tool.isort]
+profile = "black"
+line_length = 100
+multi_line_output = 3
+include_trailing_comma = true
+
+[tool.semantic_release]
+build_command = "python -m build"
+version_toml = ["pyproject.toml:project.version"]
+
+[tool.semantic_release.commit_author]
+env = "GIT_COMMIT_AUTHOR"
+default = "semantic-release <semantic-release>"
+
+[tool.semantic_release.commit_parser_options]
+allowed_tags = [
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "style",
+    "refactor",
+    "test",
+]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]
+default_bump_level = 0
+
+[tool.semantic_release.remote]
+name = "origin"
+type = "gitlab"
+ignore_token_for_push = false
+
+[tool.semantic_release.remote.token]
+env = "GL_TOKEN"
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true

tests/unit_tests/test_bec_dispatcher.py

@@ -41,14 +41,7 @@ def send_msg_event():
 
 
 @pytest.mark.parametrize(
-    "topics_msg_list",
-    [
-        (
-            ("topic1", dummy_msg),
-            ("topic2", dummy_msg),
-            ("topic3", dummy_msg),
-        )
-    ],
+    "topics_msg_list", [(("topic1", dummy_msg), ("topic2", dummy_msg), ("topic3", dummy_msg))]
 )
 def test_dispatcher_disconnect_all(bec_dispatcher_w_connector, qtbot, send_msg_event):
     bec_dispatcher = bec_dispatcher_w_connector
@@ -70,15 +63,7 @@ def test_dispatcher_disconnect_all(bec_dispatcher_w_connector, qtbot, send_msg_e
     assert len(bec_dispatcher.client.connector._topics_cb) == 0
 
 
-@pytest.mark.parametrize(
-    "topics_msg_list",
-    [
-        (
-            ("topic1", dummy_msg),
-            ("topic2", dummy_msg),
-        )
-    ],
-)
+@pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg), ("topic2", dummy_msg))])
 def test_dispatcher_disconnect_one(bec_dispatcher_w_connector, qtbot, send_msg_event):
     # test for BEC issue #276
     bec_dispatcher = bec_dispatcher_w_connector
@@ -115,15 +100,7 @@ def test_dispatcher_2_cb_same_topic(bec_dispatcher_w_connector, qtbot, send_msg_
     cb2.assert_called_once()
 
 
-@pytest.mark.parametrize(
-    "topics_msg_list",
-    [
-        (
-            ("topic1", dummy_msg),
-            ("topic2", dummy_msg),
-        )
-    ],
-)
+@pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg), ("topic2", dummy_msg))])
 def test_dispatcher_2_topic_same_cb(bec_dispatcher_w_connector, qtbot, send_msg_event):
     # test for BEC issue #276
     bec_dispatcher = bec_dispatcher_w_connector

tests/unit_tests/test_bec_figure.py

@@ -26,11 +26,7 @@ def test_bec_figure_init(bec_figure):
 
 
 def test_bec_figure_init_with_config(mocked_client):
-    config = {
-        "widget_class": "BECFigure",
-        "gui_id": "test_gui_id",
-        "theme": "dark",
-    }
+    config = {"widget_class": "BECFigure", "gui_id": "test_gui_id", "theme": "dark"}
     widget = BECFigure(client=mocked_client, config=config)
     assert widget.config.gui_id == "test_gui_id"
     assert widget.config.theme == "dark"

tests/unit_tests/test_bec_motor_map.py

@@ -29,10 +29,7 @@ def test_motor_map_change_motors(bec_motor_map):
 
 
 def test_motor_map_get_limits(bec_motor_map):
-    expected_limits = {
-        "samx": [-10, 10],
-        "samy": [-5, 5],
-    }
+    expected_limits = {"samx": [-10, 10], "samy": [-5, 5]}
 
     for motor_name, expected_limit in expected_limits.items():
         actual_limit = bec_motor_map._get_motor_limit(motor_name)

tests/unit_tests/test_config_dialog.py

@@ -43,11 +43,7 @@ def test_load_config(config_dialog, config_name):
 
 @pytest.mark.parametrize(
     "config_name, scan_mode",
-    [
-        ("config_device", False),
-        ("config_scan", True),
-        ("config_device_no_entry", False),
-    ],
+    [("config_device", False), ("config_scan", True), ("config_device_no_entry", False)],
 )
 def test_initialization(config_dialog, config_name, scan_mode):
     config = load_test_config(config_name)

tests/unit_tests/test_configs/config_device.yaml

@@ -0,0 +1,33 @@
+plot_settings:
+  background_color: "black"
+  num_columns: 1
+  colormap: "plasma"
+  scan_types: false
+plot_data:
+- plot_name: "BPM4i plots vs samx"
+  x_label: "Motor X"
+  y_label: "bpm4i"
+  sources:
+    - type: "scan_segment"
+      signals:
+        x:
+          - name : "samx"
+            entry: "samx"
+        y:
+          - name : "bpm4i"
+            entry: "bpm4i"
+
+- plot_name: "Gauss plots vs samx"
+  x_label: "Motor X"
+  y_label: "Gauss"
+  sources:
+    - type: "scan_segment"
+      signals:
+        x:
+          - name: "samx"
+            entry: "samx"
+        y:
+          - name: "gauss_adc1"
+            entry: "gauss_adc1"
+          - name: "gauss_adc2"
+            entry: "gauss_adc2"

tests/unit_tests/test_configs/config_device_no_entry.yaml

@@ -0,0 +1,27 @@
+plot_settings:
+  background_color: "black"
+  num_columns: 1
+  colormap: "plasma"
+  scan_types: false
+plot_data:
+- plot_name: "BPM4i plots vs samx"
+  x_label: "Motor X"
+  y_label: "bpm4i"
+  sources:
+    - type: "scan_segment"
+      signals:
+        x:
+          - name : "samx"
+        y:
+          - name : "bpm4i"
+
+- plot_name: "Gauss plots vs samx"
+  x_label: "Motor X"
+  y_label: "Gauss"
+  sources:
+    - type: "scan_segment"
+      signals:
+        x:
+          - name: "samx"
+        y:
+          - name: "gauss_bpm"

tests/unit_tests/test_configs/config_scan.yaml

@@ -0,0 +1,82 @@
+plot_settings:
+  background_color: "white"
+  num_columns: 3
+  colormap: "plasma"
+  scan_types: true
+plot_data:
+  grid_scan:
+  - plot_name: "Grid plot 1"
+    x_label: "Motor X"
+    y_label: "BPM"
+    sources:
+      - type: "scan_segment"
+        signals:
+          x:
+            - name: "samx"
+              entry: "samx"
+          y:
+            - name: "gauss_bpm"
+              entry: "gauss_bpm"
+  - plot_name: "Grid plot 2"
+    x_label: "Motor X"
+    y_label: "BPM"
+    sources:
+      - type: "scan_segment"
+        signals:
+          x:
+            - name: "samx"
+              entry: "samx"
+          y:
+            - name: "gauss_adc1"
+              entry: "gauss_adc1"
+  - plot_name: "Grid plot 3"
+    x_label: "Motor X"
+    y_label: "BPM"
+    sources:
+      - type: "scan_segment"
+        signals:
+          x:
+            - name: "samx"
+              entry: "samx"
+          y:
+            - name: "gauss_adc2"
+              entry: "gauss_adc2"
+  - plot_name: "Grid plot 4"
+    x_label: "Motor X"
+    y_label: "BPM"
+    sources:
+      - type: "scan_segment"
+        signals:
+          x:
+            - name: "samx"
+              entry: "samx"
+          y:
+            - name: "bpm4i"
+              entry: "bpm4i"
+  line_scan:
+    - plot_name: "Multiple Gauss Plot"
+      x_label: "Motor X"
+      y_label: "BPM"
+      sources:
+        - type: "scan_segment"
+          signals:
+            x:
+              - name: "samx"
+            y:
+              - name: "gauss_bpm"
+                entry: "gauss_bpm"
+              - name: "gauss_adc1"
+                entry: "gauss_adc1"
+              - name: "gauss_adc2"
+                entry: "gauss_adc2"
+    - plot_name: "BPM Plot"
+      x_label: "Motor X"
+      y_label: "BPM"
+      sources:
+        - type: "scan_segment"
+          signals:
+            x:
+              - name: "samx"
+            y:
+              - name: "bpm4i"
+                entry: "bpm4i"

tests/unit_tests/test_motor_control.py

@@ -50,7 +50,7 @@ CONFIG_DEFAULT = {
                 "x": [{"name": "samx", "entry": "samx"}],
                 "y": [{"name": "samy", "entry": "samy"}],
             },
-        },
+        }
     ],
 }
 

tests/unit_tests/test_motor_map.py

@@ -58,7 +58,7 @@ CONFIG_ONE_DEVICE = {
                 "x": [{"name": "samx", "entry": "samx"}],
                 "y": [{"name": "samy", "entry": "samy"}],
             },
-        },
+        }
     ],
 }
 
@@ -73,10 +73,7 @@ def motor_map(qtbot, mocked_client):
 
 def test_motor_limits_initialization(motor_map):
     # Example test to check if motor limits are correctly initialized
-    expected_limits = {
-        "samx": [-10, 10],
-        "samy": [-5, 5],
-    }
+    expected_limits = {"samx": [-10, 10], "samy": [-5, 5]}
     for motor_name, expected_limit in expected_limits.items():
         actual_limit = motor_map._get_motor_limit(motor_name)
         assert actual_limit == expected_limit
@@ -99,13 +96,7 @@ def test_motor_initial_position(motor_map):
         assert actual_position == expected_position
 
 
-@pytest.mark.parametrize(
-    "config, number_of_plots",
-    [
-        (CONFIG_DEFAULT, 2),
-        (CONFIG_ONE_DEVICE, 1),
-    ],
-)
+@pytest.mark.parametrize("config, number_of_plots", [(CONFIG_DEFAULT, 2), (CONFIG_ONE_DEVICE, 1)])
 def test_initialization(motor_map, config, number_of_plots):
     config_load = config
     motor_map.on_config_update(config_load)
@@ -131,16 +122,10 @@ def test_motor_movement_updates_position_and_database(motor_map):
     motor_map.on_device_readback({"signals": {"samx": {"value": new_position_samx}}})
 
     # Verify database update for 'samx'
-    assert motor_map.database["samx"]["samx"] == [
-        initial_position_samx,
-        new_position_samx,
-    ]
+    assert motor_map.database["samx"]["samx"] == [initial_position_samx, new_position_samx]
 
     # Verify 'samy' retains its last known position
-    assert motor_map.database["samy"]["samy"] == [
-        initial_position_samy,
-        initial_position_samy,
-    ]
+    assert motor_map.database["samy"]["samy"] == [initial_position_samy, initial_position_samy]
 
 
 def test_scatter_plot_rendering(motor_map):

tests/unit_tests/test_stream_plot.py

@@ -85,12 +85,7 @@ def test_1d_plotting_data(qtbot, stream_app):
 def test_flip_even_rows(qtbot, stream_app):
     # Create a numpy array with some known data
     original_array = np.array(
-        [
-            [1, 2, 3, 4, 5],
-            [6, 7, 8, 9, 10],
-            [11, 12, 13, 14, 15],
-            [16, 17, 18, 19, 20],
-        ]
+        [[1, 2, 3, 4, 5], [6, 7, 8, 9, 10], [11, 12, 13, 14, 15], [16, 17, 18, 19, 20]]
     )
 
     # Call flip_even_rows on the original array
@@ -98,12 +93,7 @@ def test_flip_even_rows(qtbot, stream_app):
 
     # Expected array flipped along the rows with even indices
     expected_array = np.array(
-        [
-            [1, 2, 3, 4, 5],
-            [10, 9, 8, 7, 6],
-            [11, 12, 13, 14, 15],
-            [20, 19, 18, 17, 16],
-        ]
+        [[1, 2, 3, 4, 5], [10, 9, 8, 7, 6], [11, 12, 13, 14, 15], [20, 19, 18, 17, 16]]
     )
 
     # Check that flip_even_rows returned the expected result

bec_widgets/utils/ctrl_c.py

@@ -1,39 +0,0 @@
-# TODO haven't found yet how to deal with QAbstractSocket in qtpy
-# import signal
-# import socket
-# from PyQt5.QtNetwork import QAbstractSocket
-#
-#
-# def setup(app):
-#     app.signalwatchdog = SignalWatchdog()  # need to store to keep socket pair alive
-#     signal.signal(signal.SIGINT, make_quit_handler(app))
-#
-#
-# def make_quit_handler(app):
-#     def handler(*args):
-#         print()  # make ^C appear on its own line
-#         app.quit()
-#
-#     return handler
-#
-#
-# class SignalWatchdog(QAbstractSocket):
-#     def __init__(self):
-#         """
-#         Propagates system signals from Python to QEventLoop
-#         adapted from https://stackoverflow.com/a/65802260/655404
-#         """
-#         super().__init__(QAbstractSocket.SctpSocket, None)
-#
-#         self.writer, self.reader = writer, reader = socket.socketpair()
-#         writer.setblocking(False)
-#
-#         fd_writer = writer.fileno()
-#         fd_reader = reader.fileno()
-#
-#         signal.set_wakeup_fd(fd_writer)  # Python hook
-#         self.setSocketDescriptor(fd_reader)  # Qt hook
-#
-#         self.readyRead.connect(
-#             lambda: None
-#         )  # dummy function call that lets the Python interpreter run