Merge pull request #27 from SiLab-Bonn/constellation_satellite

Python updates + Constellation satellite

Author: rpartzsch

.github/workflows/tests.yml

@@ -5,29 +5,23 @@ on: push
 jobs:
   tests:
     name: Test
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
     steps:
     # Check out repo
-    - uses: actions/checkout@v3
-    - name: Setup python
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
       with:
-        python-version: "3.9"
-
-    - name: Qt5 defaults
-      run: |
-        sudo apt install qt5-default
+        python-version: ${{ matrix.python-version }}
 
     - name: Install pymosa
       run: |
         pip install --upgrade pip
         pip install -e .
         plugin_online_monitor pymosa/online_monitor
-
-    - name: Headless display setup
-      uses: pyvista/setup-headless-display-action@v1    
     
     - name: Test
-      run: pytest -s -v
+      run: pytest -s -v

VERSION

@@ -1,7 +1 @@
-# http://stackoverflow.com/questions/17583443/what-is-the-correct-way-to-share-package-version-with-setup-py-and-the-package
-from pkg_resources import get_distribution, DistributionNotFound
-
-try:
-    __version__ = get_distribution('pymosa').version
-except DistributionNotFound:
-    __version__ = '(local)'
+__version__ = "1.0.0"

pymosa/__init__.py

@@ -0,0 +1,80 @@
+---
+title: "Pymosa"
+description: "Satellite for controlling a EUDET-type beam telescope using a MMC3 readout board"
+category: "Readout Systems"
+language: "Python"
+parent_class: "TransmitterSatellite"
+---
+
+## Description
+
+This satellite controls the readout of a EUDET-type beam telescope using a [MMC3 readout board](https://hdl.handle.net/20.500.11811/7265). 
+
+## Building
+
+Clone the repository:
+
+```sh
+git clone https://github.com/SiLab-Bonn/pymosa
+```
+
+Install via:
+```sh
+cd pymosa
+pip install ConstellationDAQ
+pip install -e .
+```
+
+## Usage
+
+Set the correct IP address in [pymosa/m26.yaml](https://github.com/SiLab-Bonn/pymosa) for more information.
+
+Start the satellite with:
+
+```sh
+python pymosa/constellation/__main__.py -g testbeam -n ANEMONE
+```
+
+## Parameters
+
+| Configuration | Description | Type | Default Value |
+|-----------|-------------|------| ------|
+| `no_data_timeout` | (Required) No data timeout after which the scan will be aborted, in seconds; if 0, the timeout is disabled. | String | None |
+| `send_data` | (Required) TCP address to which the telescope data is send; to allow incoming connections on all interfaces use 0.0.0.0 | String | None |
+| `max_triggers` | (Required) Maximum number of triggers; if 0, there is no limit on the number of triggers. | Integer | None |
+| `scan_timeout` | (Optional) Timeout after which the scan will be stopped, in seconds; if 0, the timeout is disabled. | Integer | 0 |
+| `run_number` | (Optional) Base run number, will be automatically increased; if none is given, generate filename | Integer | None |
+| `output_folder` | (Optional) Output folder for the telescope data; if none is given, the current working directory is used. | String | None |
+| `m26_configuration_file` | (Optional) Configuration file for Mimosa26 sensors, if note stated a default one is used. | String | 'm26_config/m26_threshold_8.yaml' |
+| `m26_jtag_configuration` | (Optional) Send Mimosa26 configuration via JTAG. | String | True |
+| `enabled_m26_channels` | (Optional) Enabled RX channels, eg. ["M26_RX1", "M26_RX2", "M26_RX6"]; default None (=all planes) | String | None |
+
+
+### Configuration Example
+
+An example configuration for the TJ-Monopix2 satellite which could be dropped into a Constellation configuration as a starting point:
+
+```toml
+[pymosa.ANEMONE]
+run_number = "None"  
+output_folder = "None"  
+m26_configuration_file = "None"  
+m26_jtag_configuration = true  
+no_data_timeout = 30 
+scan_timeout = 0 
+max_triggers = 0 
+send_data = 'tcp://127.0.0.1:8500'
+enabled_m26_channels = "None"
+```
+
+## Metrics
+
+The following metrics are distributed by this satellite and can be subscribed to. Timed metrics provide an interval in units of time, triggered metrics in number of calls.
+
+| Metric | Description | Value Type | Interval |
+|--------|-------------|------------|----------|
+| `TRIGGER_NUMBER` | Number of received triggers | Int | 1s |
+
+## Data
+
+Data is saved in HDF5 format in the `output_folder`.

pymosa/constellation/READMDE.md

@@ -0,0 +1,13 @@
+from constellation.core.logging import setup_cli_logging
+from constellation.core.satellite import SatelliteArgumentParser
+from pymosa_satellite import Pymosa
+
+def main(args=None):
+    parser = SatelliteArgumentParser()
+    args = vars(parser.parse_args(args))
+    setup_cli_logging(args.pop("level"))
+    s = Pymosa(**args)
+    s.run_satellite()
+
+if __name__ == "__main__":
+    main()

pymosa/constellation/__main__.py

@@ -0,0 +1,6 @@
+[Pymosa]
+
+[Pymosa.ANEMONE]
+no_data_timeout = 30
+send_data = 'tcp://127.0.0.1:8500'
+max_triggers = 1000000

pymosa/constellation/pymosa_conf.toml

@@ -0,0 +1,135 @@
+from constellation.core.configuration import Configuration
+from constellation.core.satellite import Satellite
+import time
+from constellation.core.cmdp import MetricsType
+from constellation.core.fsm import SatelliteState
+from constellation.core.monitoring import schedule_metric
+import os
+import yaml
+import pymosa
+from pymosa.m26 import m26
+import logging
+from pymosa.m26_raw_data import save_configuration_dict
+from time import sleep, strftime, time
+from tqdm import tqdm
+from typing import Any
+
+
+class Pymosa(Satellite):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def do_initializing(self, config: Configuration) -> str:
+        # Open Mimosa26 std. configuration
+        pymosa_path = os.path.dirname(pymosa.__file__)
+        with open(os.path.join(pymosa_path, 'm26_configuration.yaml'), 'r') as f:
+            self.yaml_config = yaml.safe_load(f)
+        self._load_config(config)
+        # Create telescope object and load hardware configuration
+        self.telescope = m26(conf=None)  # None: use default hardware configuration
+        return "init done"
+
+    def do_launching(self) -> str:
+        # Initialize telescope hardware and set up parameters
+        self.telescope.init(init_conf=self.yaml_config)
+        return "launching done"
+
+    def do_run(self, payload=None) -> str:
+        self._pre_run()
+        with self.telescope.access_file():
+            save_configuration_dict(self.telescope.raw_data_file.h5_file, 'configuration', self.telescope.telescope_conf)
+            with self.telescope.readout(enabled_m26_channels=self.telescope.enabled_m26_channels):
+                got_data = False
+                start = time()
+                while not self.stop_scan and not self._state_thread_evt.is_set():
+                    sleep(1.0)
+                    if not got_data:
+                        if self.telescope.m26_readout.data_words_per_second()[0] > 0:
+                            got_data = True
+                            logging.info('Taking data...')
+                            if self.telescope.max_triggers:
+                                self.pbar = tqdm(total=self.telescope.max_triggers, ncols=80)
+                            else:
+                                self.pbar = tqdm(total=self.telescope.scan_timeout, ncols=80)
+                    else:
+                        triggers = self.telescope.dut['TLU']['TRIGGER_COUNTER']
+                        try:
+                            if self.telescope.max_triggers:
+                                self.pbar.update(triggers - self.pbar.n)
+                            else:
+                                self.pbar.update(time() - start - self.pbar.n)
+                        except ValueError:
+                            pass
+                        if self.telescope.max_triggers and triggers >= self.telescope.max_triggers:
+                            self.stop_scan = True
+                            self.pbar.close()
+                            logging.info('Trigger limit was reached: %i' % self.telescope.max_triggers)
+        logging.info('Total amount of triggers collected: %d', self.telescope.dut['TLU']['TRIGGER_COUNTER'])
+        self.logger.removeHandler(self.fh)
+        logging.info('Data Output Filename: %s', self.telescope.run_filename + '.h5')
+        self.telescope.analyze()
+        return "running done"
+
+    def do_landing(self) -> str:
+        # Close the resources
+        self.telescope.close()
+        return "landing done"
+
+    def _pre_run(self) -> None:
+        self.stop_scan = False
+        # signal.signal(signal.SIGINT, self.telescope._signal_handler)
+        logging.info('Press Ctrl-C to stop run')
+
+        # check for filename that is not in use
+        while True:
+            if not self.telescope.output_filename and self.telescope.run_number:
+                filename = 'run_' + str(self.telescope.run_number) + '_' + self.telescope.run_id
+
+            else:
+                if self.telescope.output_filename:
+                    filename = self.telescope.output_filename
+                else:
+                    filename = strftime("%Y%m%d-%H%M%S") + '_' + self.telescope.run_id
+            if filename in [os.path.splitext(f)[0] for f in os.listdir(self.telescope.working_dir) if os.path.isfile(os.path.join(self.telescope.working_dir, f))]:
+                if not self.telescope.output_filename and self.telescope.run_number:
+                    self.telescope.run_number += 1  # increase run number and try again
+                    continue
+                else:
+                    raise IOError("Filename %s already exists." % filename)
+            else:
+                self.telescope.run_filename = os.path.join(self.telescope.working_dir, filename)
+                break
+
+        # set up logger
+        self.fh = logging.FileHandler(self.telescope.run_filename + '.log')
+        self.fh.setLevel(logging.DEBUG)
+        FORMAT = '%(asctime)s [%(name)-17s] - %(levelname)-7s %(message)s'
+        self.fh.setFormatter(logging.Formatter(FORMAT))
+        self.logger = logging.getLogger()
+        self.logger.addHandler(self.fh)
+        self.telescope.dut['TLU']['TRIGGER_COUNTER'] = 0
+
+    def _load_config(self, config: Configuration) -> None:
+        config.set_default(key='scan_timeout', value=None)
+        config.set_default(key='run_number', value=None)
+        config.set_default(key='output_folder', value=None)
+        config.set_default(key='m26_configuration_file', value=None)
+        config.set_default(key='m26_jtag_configuration', value=True)
+        config.set_default(key='enabled_m26_channels', value=None)
+
+        self.yaml_config['no_data_timeout'] = config.get(key='no_data_timeout')
+        self.yaml_config['send_data'] = config.get(key='send_data')
+        self.yaml_config['max_triggers'] = config.get(key='max_triggers')
+        self.yaml_config['scan_timeout'] = config.get(key='scan_timeout')
+        self.yaml_config['run_number'] = config.get(key='run_number')
+        self.yaml_config['output_folder'] = config.get(key='output_folder')
+        self.yaml_config['m26_configuration_file'] = config.get(key='m26_configuration_file')
+        self.yaml_config['m26_jtag_configuration'] = config.get(key='m26_jtag_configuration')
+        self.yaml_config['enabled_m26_channels'] = config.get(key='enabled_m26_channels')
+
+    @schedule_metric("", MetricsType.LAST_VALUE, 1)
+    def trigger_number(self) -> int | None:
+        if self.fsm.current_state_value == SatelliteState.RUN:
+            return self.telescope.dut['TLU']['TRIGGER_COUNTER']
+        else:
+            return None

pymosa/constellation/pymosa_satellite.py

@@ -2,7 +2,8 @@
 import datetime
 from time import sleep, time, mktime
 from threading import Thread, Event, Lock, Condition
-from collections import deque, Iterable
+from collections import deque
+from collections.abc import Iterable
 import sys
 
 import numpy as np

pymosa/m26_readout.py

@@ -9,7 +9,7 @@
 import subprocess
 
 import psutil
-from PyQt5.QtWidgets import QApplication
+from PyQt6.QtWidgets import QApplication
 
 from online_monitor.OnlineMonitor import OnlineMonitorApplication
 from online_monitor.utils import utils