REL: merge development into main, change CI

.github/workflows/documentation.yml

@@ -13,17 +13,15 @@ jobs:
       - uses: actions/setup-python@v5
       - name: Install dependencies
         run: |
-          pip install -e .
-          pip install pydata-sphinx-theme
-          pip install sphinx sphinx_rtd_theme myst_parser sphinx_mdinclude
+          pip install -e .[doc]
       - name: Sphinx build
         run: |
-          sphinx-build docs/source _build
+          sphinx-build docs/source build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{github.event_name == 'push' && github.ref == 'refs/heads/main'}}
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: _build/
+          publish_dir: build/
           force_orphan: true

.github/workflows/pre_commit.yml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main, development]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/action@v3.0.1

.github/workflows/workflows.yml → .github/workflows/tests.yml

@@ -1,23 +1,21 @@
-name: standard tests
+name: tests
 
 on:
   pull_request:
   push:
     branches: [main, development]
 
 jobs:
-  pre-commit:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-    - uses: pre-commit/action@v3.0.1
-
-  installation:
+  tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
       - name: Install dependencies
         run: |
-          pip install -e .
+          pip install -e .[test]
+          pip install pytest
+
+      - name: Test with pytest
+        run: |
+          pytest -sv

.gitignore

@@ -1,8 +1,7 @@
 #debugging and data  files
 test.ipynb
 *.h5
-!/aidatlu/test/interpreted_data.h5
-!/aidatlu/test/raw_data_test.h5
+!aidatlu/test/fixtures/*
 .vscode
 
 # Byte-compiled / optimized / DLL files

README.md

@@ -1,11 +1,14 @@
 # AIDA-TLU
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![tests](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/tests.yml/badge.svg)](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/tests.yml)
+[![pre-commit](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/pre-commit.yml)
+[![documentation](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/documentation.yml/badge.svg)](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/documentation.yml)
 
 Repository for controlling the AIDA-2020 Trigger Logic Unit (TLU) with Python using uHAL bindings from [IPbus](https://ipbus.web.cern.ch/).
 The Python control software is based on [EUDAQ2](https://github.com/eudaq/eudaq/tree/master/user/tlu).
 The software is a lightweight version written in Python with a focus on readability and user-friendliness.
 Most user cases can be set with a .yaml configuration file and started by executing a single Python script.
 For a more in-depth look at the hardware components please take a look at the official [AIDA-2020 TLU project](https://ohwr.org/project/fmc-mtlu).
+Additionally, take a look at the [documentation](https://silab-bonn.github.io/aidatlu/) for this software.
 # Installation
 ## IPbus
 You need to install [IPbus](https://ipbus.web.cern.ch/doc/user/html/software/install/compile.html) and its Python bindings to the desired interpreter.
@@ -77,5 +80,23 @@ For more commands take a look at the python script aidatlu.py.
 
 All configurations are done by the use of a yaml file (tlu_configuration.yaml).
 
+# Tests
+With pytest (https://docs.pytest.org/en/7.4.x/) the AIDA TLU control program can be tested.
+There is also an implemented AIDA-TLU mock, to allow tests and software development without hardware,
+which also allows software development and testing without a working IPbus installation.
+The mock is used as a default.
 
-Additionally, take a look at the [documentation](https://silab-bonn.github.io/aidatlu/).
+```bash
+    pytest -sv
+```
+To test with connected hardware set an environment variable ```HW=True````:
+
+```bash
+    HW=True pytest -sv
+```
+
+You can also set the variable ```HW=False```` to test the mock TLU:
+
+```bash
+    HW=False pytest -sv
+```

aidatlu/README.md

@@ -29,7 +29,8 @@ These operators are used in conjunction with the input channels CH1-CH6 and inte
 For example "(CH1 & ~CH2) & (CH3 | CH4 | CH5 | CH6)" produces a valid trigger, when CH1 and not CH2 triggers and when one of CH3, CH4, CH5 or CH6 triggers.
 An input channel that is not explicitly set to 'veto' or 'enabled' is automatically set to 'do not care'.
 
-Trigger polarity controls if the TLU should trigger on a rising (0) or falling (1) edge of an incoming trigger signal.
+TLU can trigger on a rising or falling edge. Trigger polarity is set using a string or boolean,
+'rising' corresponds to false (0) and 'falling' to true (1)
 
 Each trigger input signal can be delayed and stretched by a given number of clock cycles.
 This is set with a list containing the number of clock cycles for every different trigger input.

aidatlu/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

aidatlu/hardware/ioexpander_controller.py

@@ -58,46 +58,6 @@ def init_output_expander(self) -> None:
 
     ### LED Control ###
 
-    def test_leds(self, single=True) -> None:
-        """Test the 11 LEDs
-
-        Args:
-            single (bool, optional): Test all possible RGB combinations for all LEDs. Defaults to True.
-        """
-        self.log.info("Testing LEDs colors")
-        if single:
-            for color in [
-                [0, 1, 1],
-                [1, 0, 1],
-                [1, 1, 0],
-                [1, 0, 0],
-                [0, 1, 0],
-                [0, 0, 1],
-                [0, 0, 0],
-            ]:
-                for i in range(11):
-                    if i + 1 == 5:
-                        pass
-                    else:
-                        self._set_led(i + 1, color)
-                        time.sleep(0.1)
-                        self.all_off()
-                        time.sleep(0.05)
-            for color in [[0, 0, 1], [0, 1, 1], [1, 0, 1]]:
-                self._set_led(5, color)
-                time.sleep(0.15)
-                self.all_off()
-                time.sleep(0.1)
-
-        else:
-            for color in ["w", "r", "g", "b"]:
-                self.log.info("Testing LEDs color: %s" % color)
-
-                self.all_on(color)
-                time.sleep(1)
-                self.all_off()
-                time.sleep(1)
-
     def all_on(self, color: str = "w") -> None:
         """Set all LEDs to same color
 

aidatlu/main/config_parser.py

@@ -4,11 +4,10 @@
 
 
 class TLUConfigure:
-    def __init__(self, TLU, io_control, config_path) -> None:
+    def __init__(self, TLU, config_path) -> None:
         self.log = logger.setup_main_logger(__class__.__name__)
 
         self.tlu = TLU
-        self.io_control = io_control
 
         with open(config_path, "r") as file:
             self.conf = yaml.full_load(file)
@@ -18,15 +17,7 @@ def configure(self) -> None:
         self.conf_dut()
         self.conf_trigger_inputs()
         self.conf_trigger_logic()
-        self.tlu.io_controller.clock_lemo_output(
-            self.conf["clock_lemo"]["enable_clock_lemo_output"]
-        )
-        [
-            self.tlu.dac_controller.set_voltage(
-                i + 1, self.conf["pmt_control"]["pmt_%s" % (i + 1)]
-            )
-            for i in range(len(self.conf["pmt_control"]))
-        ]
+        self.conf_auxillary()
         self.tlu.set_enable_record_data(1)
         self.log.success("TLU configured")
 
@@ -95,7 +86,7 @@ def get_data_handling(self) -> tuple:
             tuple: two bools, save and interpret data.
         """
 
-        return self.conf["save_data"], self.conf["save_data"]
+        return self.conf["save_data"]
 
     def get_stop_condition(self) -> tuple:
         """Information about tlu stop condition.
@@ -131,6 +122,18 @@ def get_zmq_connection(self) -> str:
         """
         return self.conf["zmq_connection"]
 
+    def conf_auxillary(self):
+        """Configures PMT power outputs and clock LEMO I/O"""
+        self.tlu.io_controller.clock_lemo_output(
+            self.conf["clock_lemo"]["enable_clock_lemo_output"]
+        )
+        [
+            self.tlu.dac_controller.set_voltage(
+                i + 1, self.conf["pmt_control"]["pmt_%s" % (i + 1)]
+            )
+            for i in range(len(self.conf["pmt_control"]))
+        ]
+
     def conf_dut(self) -> None:
         """Parse the configuration for the DUT interface to the AIDATLU."""
         dut = [0, 0, 0, 0]
@@ -181,7 +184,11 @@ def conf_dut(self) -> None:
         self.tlu.dut_logic.set_dut_mask_mode(
             dut_mode[0] | dut_mode[1] | dut_mode[2] | dut_mode[3]
         )
-
+        self.log.debug("Set DUT mask: %s" % (dut[0] | dut[1] | dut[2] | dut[3]))
+        self.log.debug(
+            "Set DUT mask mode: %s"
+            % (dut_mode[0] | dut_mode[1] | dut_mode[2] | dut_mode[3])
+        )
         # Special configs
         self.tlu.dut_logic.set_dut_mask_mode_modifier(0)
         self.tlu.dut_logic.set_dut_ignore_busy(0)
@@ -190,9 +197,18 @@ def conf_dut(self) -> None:
     def conf_trigger_logic(self) -> None:
         """Configures the trigger logic. So the trigger polarity and the trigger pulse length and stretch."""
 
-        self.tlu.trigger_logic.set_trigger_polarity(
-            self.conf["trigger_inputs"]["trigger_polarity"]["polarity"]
-        )
+        if self.conf["trigger_inputs"]["trigger_polarity"]["polarity"] in [
+            0,
+            "0",
+            "rising",
+        ]:
+            self.tlu.trigger_logic.set_trigger_polarity(0)
+        elif self.conf["trigger_inputs"]["trigger_polarity"]["polarity"] in [
+            1,
+            "1",
+            "falling",
+        ]:
+            self.tlu.trigger_logic.set_trigger_polarity(1)
 
         self.tlu.trigger_logic.set_pulse_stretch_pack(
             self.conf["trigger_inputs"]["trigger_signal_shape"]["stretch"]
@@ -234,9 +250,9 @@ def conf_trigger_inputs(self) -> None:
         if trigger_configuration is not None:
             for trigger_led in range(6):
                 if "~CH%i" % (trigger_led + 1) in trigger_configuration:
-                    self.io_control.switch_led(trigger_led + 6, "r")
+                    self.tlu.io_controller.switch_led(trigger_led + 6, "r")
                 elif "CH%i" % (trigger_led + 1) in trigger_configuration:
-                    self.io_control.switch_led(trigger_led + 6, "g")
+                    self.tlu.io_controller.switch_led(trigger_led + 6, "g")
 
             long_word = 0x0
             # Goes through all possible trigger combinations and checks if the combination is valid with the trigger logic.