module-qc-tools 2.4.0__tar.gz → 2.4.1__tar.gz

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: module_qc_tools
-Version: 2.4.0
+Version: 2.4.1
 Summary: Module qc tools
 Project-URL: Homepage, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-tools
 Project-URL: Bug Tracker, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-tools/-/issues
@@ -45,7 +45,7 @@ Requires-Dist: typer>=0.9.0
 Requires-Dist: urllib3<2,>=1.26.20; 'el7.x86_64' in platform_release
 Description-Content-Type: text/markdown
 
-# module-qc-tools v2.4.0
+# module-qc-tools v2.4.1
 
 A general python tool for running ITkPixV1.1 and ITkPixV2 module QC tests
 

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/README.md

@@ -1,4 +1,4 @@
-# module-qc-tools v2.4.0
+# module-qc-tools v2.4.1
 
 A general python tool for running ITkPixV1.1 and ITkPixV2 module QC tests
 

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/docs/config.md

@@ -52,20 +52,20 @@ corresponding YARR configuration files.
 
 **Configuration settings**
 
-| Name                     | Description                                                                                                                                                                                                                         |
-| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `run_dir`                | path (relative or absolute) to the directory where `YARR` commands should be run                                                                                                                                                    |
-| `controller`             | path (relative to `run_dir` or absolute) to the controller file                                                                                                                                                                     |
-| `scanConsole_exe`        | path (relative to `run_dir` or absolute) to the `scanConsole` executable                                                                                                                                                            |
-| `write_register_exe`     | path (relative to `run_dir` or absolute) to the `write_register` executable                                                                                                                                                         |
-| `read_register_exe`      | path (relative to `run_dir` or absolute) to the `read_register` executable                                                                                                                                                          |
-| `read_adc_exe`           | path (relative to `run_dir` or absolute) to the `read_adc` executable                                                                                                                                                               |
-| `switchLPM_exe`          | path (relative to `run_dir` or absolute) to the `switchLPM` executable                                                                                                                                                              |
-| `lpm_digitalscan`        | path (relative to `run_dir` or absolute) to the low-power mode digital scan in YARR; for ITkPix v2, make sure that the path points to the correct scan config directory, e.g. `"configs/scans/itkpixv2/lpm_digitalscan.json"`       |
-| `read_ringosc_exe`       | path (relative to `run_dir` or absolute) to the `Rd53bReadRingosc` or `Itkpixv2ReadRingosc` executable in YARR; for ITkPix v2, make sure the path points to the executable for the correct chip, e.g. `"./bin/Itkpixv2ReadRingosc"` |
-| `eyeDiagram_exe`         | path (relative to `run_dir` or absolute) to the `eyeDiagram` executable in YARR                                                                                                                                                     |
-| `"dataMergingCheck_exe"` | path (relative to `run_dir` or absolute) to the `dataMergingCheck` executable in YARR                                                                                                                                               |
-| `success_code`           | exit status that indicates success. The default is 0 besides `configure`, which has exit status 1 for success. The user do not need to set the `success_code` as the default in QC software is synchronized with YARR.              |
+| Name                   | Description                                                                                                                                                                                                                         |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `run_dir`              | path (relative or absolute) to the directory where `YARR` commands should be run                                                                                                                                                    |
+| `controller`           | path (relative to `run_dir` or absolute) to the controller file                                                                                                                                                                     |
+| `scanConsole_exe`      | path (relative to `run_dir` or absolute) to the `scanConsole` executable                                                                                                                                                            |
+| `write_register_exe`   | path (relative to `run_dir` or absolute) to the `write_register` executable                                                                                                                                                         |
+| `read_register_exe`    | path (relative to `run_dir` or absolute) to the `read_register` executable                                                                                                                                                          |
+| `read_adc_exe`         | path (relative to `run_dir` or absolute) to the `read_adc` executable                                                                                                                                                               |
+| `switchLPM_exe`        | path (relative to `run_dir` or absolute) to the `switchLPM` executable                                                                                                                                                              |
+| `lpm_digitalscan`      | path (relative to `run_dir` or absolute) to the low-power mode digital scan in YARR; for ITkPix v2, make sure that the path points to the correct scan config directory, e.g. `"configs/scans/itkpixv2/lpm_digitalscan.json"`       |
+| `read_ringosc_exe`     | path (relative to `run_dir` or absolute) to the `Rd53bReadRingosc` or `Itkpixv2ReadRingosc` executable in YARR; for ITkPix v2, make sure the path points to the executable for the correct chip, e.g. `"./bin/Itkpixv2ReadRingosc"` |
+| `eyeDiagram_exe`       | path (relative to `run_dir` or absolute) to the `eyeDiagram` executable in YARR                                                                                                                                                     |
+| `dataMergingCheck_exe` | path (relative to `run_dir` or absolute) to the `dataMergingCheck` executable in YARR                                                                                                                                               |
+| `success_code`         | exit status that indicates success. The default is 0 besides `configure`, which has exit status 1 for success. The user do not need to set the `success_code` as the default in QC software is synchronized with YARR.              |
 
 ### power_supply
 

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/docs/history.md

@@ -16,6 +16,16 @@ and this project adheres to
 
 **_Fixed:_**
 
+## [2.4.1](https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-tools/-/tags/v2.4.1) - 2025-xx-yy ## {: #mqt-v2.4.1 }
+
+**_Changed:_**
+
+**_Added:_**
+
+**_Fixed:_**
+
+- eye diagram parsing (!228)
+
 ## [2.4.0](https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-tools/-/tags/v2.4.0) - 2025-03-11 ## {: #mqt-v2.4.0 }
 
 **_Changed:_**
@@ -29,6 +39,12 @@ and this project adheres to
 - add BOM information to output of SLDO, LP and ADC calibration (!220)
 - add ability to enable/disable LPM on targeted TX channels (!207)
 - add data merging substest to data transmission test (!218)
+
+<!-- prettier-ignore -->
+> [!IMPORTANT]
+> Requires update of the `yarr` section in the hardware config file:
+> `"dataMergingCheck_exe": "./bin/dataMergingCheck",`
+
 - add Iref trim information to output of the AR test (!221)
 - add protection when ramping HV down (!211)
 - CLI to retrieve input current based on chip version (!210)

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/docs/install.md

@@ -92,7 +92,7 @@ package.
 $ python -m venv venv
 $ source venv/bin/activate
 $ python -m pip install -U pip
-$ python -m pip install -U pip module-qc-tools==2.4.0
+$ python -m pip install -U pip module-qc-tools==2.4.1
 ```
 
 ### via uv
@@ -101,7 +101,7 @@ $ python -m pip install -U pip module-qc-tools==2.4.0
 $ python -m venv venv
 $ source venv/bin/activate
 $ python -m pip install uv
-$ uv pip install module-qc-tools==2.4.0
+$ uv pip install module-qc-tools==2.4.1
 ```
 
 # Usage

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/pyproject.toml

@@ -88,6 +88,11 @@ dependencies = [
 ]
 installer = "uv"
 
+[tool.hatch.envs.hatch-uv]
+dependencies = [
+  "uv!=0.6.7", # https://github.com/astral-sh/uv/issues/12260
+]
+
 [tool.hatch.envs.default.scripts]
 tag = "tbump {args}"
 lint = "pylint src"

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/src/module_qc_tools/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.4.0'
-__version_tuple__ = version_tuple = (2, 4, 0)
+__version__ = version = '2.4.1'
+__version_tuple__ = version_tuple = (2, 4, 1)

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/src/module_qc_tools/cli/hardware_emulator.py

@@ -844,8 +844,14 @@ def eye_diagram(
         if chip_position != -1 and lane is not chip_position:
             string += f"[{get_yarr_logging_timestamp()}][  info  ][  eyeDiagram   ]: No good delay setting for lane {lane}"
         else:
-            eyewidth = round(31 * rng.random(), 0)
-            delay = round(31 * rng.random(), 0)
+            ## comment 20250320
+            ## format used to be the format to be `Delay setting for lane 0 with eye width 7.0: 3.0`
+            ## but format is currently `Delay setting for lane 0 with eye width 7: 3`
+            ## see https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-tools/-/merge_requests/228
+            # eyewidth = round(31 * rng.random(), 0)
+            # delay = round(31 * rng.random(), 0)
+            eyewidth = int(31 * rng.random())
+            delay = int(31 * rng.random())
             string += f"[{get_yarr_logging_timestamp()}][  info  ][  eyeDiagram   ]: Delay setting for lane {lane} with eye width {eyewidth}: {delay}"
         string += "\n"
 

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/src/module_qc_tools/measurements/data_transmission.py

@@ -88,10 +88,11 @@ def run_eyediagram(config, ps, yr, layer, n_lanes_per_chip, dryrun):
 
     logger.info("Running eye-diagram scan...")
     yarr_output = yr.eyeDiagram(dryrun=dryrun)[0]
-    logger.info(f"Result:\n{yarr_output}")
+    logger.debug(f"Result:\n{yarr_output}")
 
     ansi_escape = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
     yarr_output_cleaned = ansi_escape.sub("", yarr_output)
+    logger.info(f"Result (cleaned): \n{yarr_output_cleaned}")
     assert (
         "Done scanning" in yarr_output_cleaned
     ), "Could not find the right place to split for parsing the eye-diagram. There should be an indication of 'All done' completion."
@@ -116,16 +117,28 @@ def run_eyediagram(config, ps, yr, layer, n_lanes_per_chip, dryrun):
     )
 
     # TODO: maybe use this info ? [16:24:49:371][  info  ][    SpecRx     ][31126]: Active Rx channels: 0x8
-    pattern = re.compile(
-        r"Delay setting for lane (?P<lane>\d+) with eye width (?P<width>\d+)\.0: (?P<delay>\d+)\.0"
-    )
 
     delay_setting = {k: None for k in range(num_lanes)}
     eye_width = {k: None for k in range(num_lanes)}
+    logger.debug(
+        f"yarr_output_cleaned(end_of_eye_diagram:)\n {yarr_output_cleaned[end_of_eye_diagram:]}"
+    )
+
+    ## 2025.03.20, see https://mattermost.web.cern.ch/itkpixel/pl/5js9ikpng3rybc5ry9a8afbbfo
+    ## checking for both cases:
+    ## Delay setting for lane 0 with eye width 7: 3
+    ## Delay setting for lane 0 with eye width 7.0: 3.0
+    pattern = re.compile(
+        r"Delay setting for lane (?P<lane>\d+) with eye width (?P<width>\d+)(?:.0)?: (?P<delay>\d+)(?:.0)?"
+    )
     for match in pattern.finditer(yarr_output_cleaned[end_of_eye_diagram:]):
+        logger.debug(f"match {match}")
         lane = int(match["lane"])
         eye_width[lane] = int(match["width"])
         delay_setting[lane] = int(match["delay"])
+        logger.debug(
+            f"lane {lane} eye_width {eye_width[lane]} delay {delay_setting[lane]}"
+        )
 
     for chip in yr._enabled_chip_positions:
         meas[chip]["Delay"] = testdata["Delay"].tolist()

{module_qc_tools-2.4.0 → module_qc_tools-2.4.1}/tbump.toml

@@ -1,5 +1,5 @@
 [version]
-current = "2.4.0"
+current = "2.4.1"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before
@@ -17,7 +17,7 @@ regex = '''
 
 [git]
 # The current version will get updated when tbump is run
-message_template = "Bump version: 2.4.0 → {new_version}"
+message_template = "Bump version: 2.4.1 → {new_version}"
 tag_template = "v{new_version}"
 
 # For each file to patch, add a [[file]] config