module-qc-database-tools 2.11.1__tar.gz → 2.11.2__tar.gz

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/.zenodo.json

@@ -1,8 +1,8 @@
 {
   "description": " general python tool for interfacing with databases during module QC tests for the ATLAS ITk project",
   "license": "MIT",
-  "title": "atlas-itk-pixel-modules/mqdbt: v2.11.1",
-  "version": "v2.11.1",
+  "title": "atlas-itk-pixel-modules/mqdbt: v2.11.2",
+  "version": "v2.11.2",
   "upload_type": "software",
   "creators": [
     {
@@ -80,7 +80,7 @@
   "related_identifiers": [
     {
       "scheme": "url",
-      "identifier": "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/-/tree/v2.11.1",
+      "identifier": "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/-/tree/v2.11.2",
       "relation": "isSupplementTo"
     }
   ]

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/CITATION.cff

@@ -54,6 +54,6 @@ keywords:
 license:
 - mit
 message: If you use this software, please cite it using the metadata from this file.
-title: 'atlas-itk-pixel-modules/mqdbt: v2.11.1'
+title: 'atlas-itk-pixel-modules/mqdbt: v2.11.2'
 type: software
-version: v2.11.1
+version: v2.11.2

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: module-qc-database-tools
-Version: 2.11.1
+Version: 2.11.2
 Summary: Python wrapper to interface with LocalDB and Production DB for common tasks for pixel modules.
 Project-URL: Homepage, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools
 Project-URL: Bug Tracker, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/issues
@@ -63,7 +63,7 @@ Requires-Dist: typing-extensions>=4.0; python_version < '3.10'
 Requires-Dist: urllib3<2,>=1.26.20; 'el7.x86_64' in platform_release
 Description-Content-Type: text/markdown
 
-# Module QC Database Tools v2.11.1
+# Module QC Database Tools v2.11.2
 
 The package to regisiter ITkPixV1.1 modules, and generate YARR configs from ITk
 production database using `itkdb` API.

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/README.md

@@ -1,4 +1,4 @@
-# Module QC Database Tools v2.11.1
+# Module QC Database Tools v2.11.2
 
 The package to regisiter ITkPixV1.1 modules, and generate YARR configs from ITk
 production database using `itkdb` API.

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/docs/history.md

@@ -16,6 +16,17 @@ and this project adheres to
 
 **_Fixed:_**
 
+## [2.11.2](https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/-/tags/v2.11.2) - 2026-07-07 ## {: #mqdbt-v2.11.2 }
+
+**_Changed:_**
+
+- in case of duplicated chip config, get the latest one by its `dateTime` (!166)
+
+**_Added:_**
+
+- add `--clear` or `--clear-chip-config` option to generate YARR configs with
+  untuned threshold and ToT registers (!165)
+
 ## [2.11.1](https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/-/tags/v2.11.1) - 2026-06-09 ## {: #mqdbt-v2.11.1 }
 
 **_Fixed:_**

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/docs/install.md

@@ -90,7 +90,7 @@ package.
 $ python -m venv venv
 $ source venv/bin/activate
 $ python -m pip install -U pip
-$ python -m pip install -U pip module-qc-database-tools==2.11.1
+$ python -m pip install -U pip module-qc-database-tools==2.11.2
 ```
 
 ### via uv
@@ -99,7 +99,7 @@ $ python -m pip install -U pip module-qc-database-tools==2.11.1
 $ python -m venv venv
 $ source venv/bin/activate
 $ python -m pip install uv
-$ uv pip install module-qc-database-tools==2.11.1
+$ uv pip install module-qc-database-tools==2.11.2
 ```
 
 # Usage

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/src/module_qc_database_tools/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.11.1'
-__version_tuple__ = version_tuple = (2, 11, 1)
+__version__ = version = '2.11.2'
+__version_tuple__ = version_tuple = (2, 11, 2)
 
 __commit_id__ = commit_id = None

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/src/module_qc_database_tools/cli/generate_yarr_config.py

@@ -109,6 +109,21 @@ def main(
         help="Use reversed order of chip ID, e.g. for old L0 linear triplets.",
     ),
     config_hw: Path = OPTIONS["config_hw"],
+    default_chip_config_path: Path = typer.Option(
+        (module_qc_database_tools.data / "YARR" / "default_chip_config.json").resolve(),
+        "--default-chip-config",
+        help="Default chip config values from which the chip config are generated.",
+        exists=True,
+        file_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    clear_chip_config: bool = typer.Option(
+        False,
+        "--clear",
+        "--clear-chip-config",
+        help="Clears threshold and ToT tunings from chip config.",
+    ),
 ):
     """
     Main executable for generating yarr config.
@@ -150,6 +165,9 @@ def main(
         layer_config = layer
 
     chip_template = json.loads(chip_template_path.read_text()) if not localdb else None
+    default_chip_config = (
+        json.loads(default_chip_config_path.read_text()) if not localdb else None
+    )
 
     to_generate = []
 
@@ -166,6 +184,7 @@ def main(
         )
         generated_configs = module.generate_config(
             chip_template,
+            default_chip_config,
             layer_config,
             dp_port.value,
             suffix=suffix,
@@ -173,6 +192,7 @@ def main(
             speed=speed,
             reverse=reverse,
             felix=felix,
+            clear_chip_config=clear_chip_config,
         )
 
         if output_dir:

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/src/module_qc_database_tools/core.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import collections
 import copy
 import json
 import logging
@@ -27,6 +28,7 @@ from module_qc_database_tools.utils import (
 )
 
 log = logging.getLogger(__name__)
+# pylint: disable=too-many-lines
 
 
 class Module:
@@ -153,6 +155,7 @@ class Module:
     def generate_config(
         self,
         chip_template,
+        default_chip_config,
         layer_config,
         dp_port: DPPort,
         suffix,
@@ -160,6 +163,7 @@ class Module:
         speed=1280,
         reverse=False,
         felix=False,
+        clear_chip_config=False,
     ):
         """
         Generate module config.
@@ -192,6 +196,7 @@ class Module:
                         copy.deepcopy(
                             chip_template
                         ),  # NB: make sure we copy as Chip::generate_config modifies this in-place
+                        copy.deepcopy(default_chip_config),
                         self.chip_type,
                         chip_index,
                         layer_config,
@@ -201,6 +206,7 @@ class Module:
                         version=version,
                         sensor_vendor=self.sensor_vendor,
                         felix=felix,
+                        clear_chip_config=clear_chip_config,
                     )
                 )
             except RuntimeError as snake:
@@ -326,6 +332,7 @@ class Chip:
     def generate_config(
         self,
         chip_template,
+        default_chip_config,
         chip_type,
         chip_index,
         layer_config,
@@ -335,6 +342,7 @@ class Chip:
         speed=1280,
         sensor_vendor=None,
         felix=False,
+        clear_chip_config=False,
     ):
         """
         Generate chip config.
@@ -344,6 +352,11 @@ class Chip:
         except KeyError:
             log.error("Chip template incompatible: no 'chip_type' found!")
             sys.exit(1)
+        try:
+            default_chip_config = {chip_type: default_chip_config.get("chip_type")}
+        except KeyError:
+            log.error("Default chip configs incompatible: no 'chip_type' found!")
+            sys.exit(1)
 
         data_merging = None
         ## warm or warm_4-to-1
@@ -359,8 +372,30 @@ class Chip:
             )
             sys.exit(1)
 
+        power_config = "LP" if suffix == "LP" else layer_config
+
         if version == "latest" and len(self.attachments) >= 3:
             checklist = [".json", layer_config, suffix]
+            log.debug(self.attachments)
+            ## reverse-sort attachments by date, so that we get the latest one in case of duplication
+            self.attachments = sorted(
+                self.attachments, key=lambda d: d["dateTime"], reverse=True
+            )
+            ## check for duplicates and print out warning
+            _titles = [item.get("title", None) for item in self.attachments]
+            ## remove None in case an attachment has no title
+            _titles = [_title for _title in _titles if _title is not None]
+            log.debug(_titles)
+            _duplicates = [
+                item
+                for item, count in collections.Counter(_titles).items()
+                if count > 1
+            ]
+            if _duplicates:
+                log.warning(
+                    "These FE configs have multiple entries, please fix! %s",
+                    _duplicates,
+                )
             for item in self.attachments:
                 title = item["title"] or ""
                 if all(check in title for check in checklist):
@@ -373,6 +408,7 @@ class Chip:
                     )
                     try:
                         chip_template = self.get_latest_configs(item, speed)
+                        break
                     except RuntimeError as esnake:
                         log.warning(
                             "Unable to find latest config for FE%i (chip %s): %s. Make sure all sets of configs are present in the database.",
@@ -403,7 +439,6 @@ class Chip:
                 self.uid,
                 layer_config,
             )
-            power_config = "LP" if suffix == "LP" else layer_config
             try:
                 global_config = chip_template[chip_type]
             except KeyError:
@@ -432,102 +467,65 @@ class Chip:
                 chip_template[chip_type]["GlobalConfig"]["DiffLcc"] = 200
                 chip_template[chip_type]["GlobalConfig"]["DiffLccEn"] = 1
 
-            chip_template[chip_type]["GlobalConfig"]["DiffPreComp"] = {
-                "R0": 350,
-                "R0.5": 350,
-                "L0": 350,
-                "L1": 350,
-                "L2": 350,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffPreampL"] = {
-                "R0": 900,
-                "R0.5": 900,
-                "L0": 900,
-                "L1": 730,
-                "L2": 550,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffPreampM"] = {
-                "R0": 900,
-                "R0.5": 900,
-                "L0": 900,
-                "L1": 730,
-                "L2": 550,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffPreampR"] = {
-                "R0": 900,
-                "R0.5": 900,
-                "L0": 900,
-                "L1": 730,
-                "L2": 550,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffPreampT"] = {
-                "R0": 900,
-                "R0.5": 900,
-                "L0": 900,
-                "L1": 730,
-                "L2": 550,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffPreampTL"] = {
-                "R0": 900,
-                "R0.5": 900,
-                "L0": 900,
-                "L1": 730,
-                "L2": 550,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffPreampTR"] = {
-                "R0": 900,
-                "R0.5": 900,
-                "L0": 900,
-                "L1": 730,
-                "L2": 550,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["DiffVff"] = {
-                "R0": 150,
-                "R0.5": 150,
-                "L0": 150,
-                "L1": 150,
-                "L2": 60,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["EnCoreCol0"] = {
-                "R0": 65535,
-                "R0.5": 65535,
-                "L0": 65535,
-                "L1": 65535,
-                "L2": 65535,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["EnCoreCol1"] = {
-                "R0": 65535,
-                "R0.5": 65535,
-                "L0": 65535,
-                "L1": 65535,
-                "L2": 65535,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["EnCoreCol2"] = {
-                "R0": 65535,
-                "R0.5": 65535,
-                "L0": 65535,
-                "L1": 65535,
-                "L2": 65535,
-                "LP": 0,
-            }[power_config]
-            chip_template[chip_type]["GlobalConfig"]["EnCoreCol3"] = {
-                "R0": 63,
-                "R0.5": 63,
-                "L0": 63,
-                "L1": 63,
-                "L2": 63,
-                "LP": 0,
-            }[power_config]
+            chip_template[chip_type]["GlobalConfig"]["DiffPreComp"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreComp"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffPreampL"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreampL"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffPreampM"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreampM"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffPreampR"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreampR"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffPreampT"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreampT"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffPreampTL"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreampTL"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffPreampTR"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["DiffPreampTR"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["DiffVff"] = default_chip_config[
+                chip_type
+            ]["GlobalConfig"]["DiffVff"][power_config]
+            chip_template[chip_type]["GlobalConfig"]["EnCoreCol0"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["EnCoreCol0"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["EnCoreCol1"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["EnCoreCol1"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["EnCoreCol2"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["EnCoreCol2"][
+                    power_config
+                ]
+            )
+            chip_template[chip_type]["GlobalConfig"]["EnCoreCol3"] = (
+                default_chip_config[chip_type]["GlobalConfig"]["EnCoreCol3"][
+                    power_config
+                ]
+            )
+
             chip_template[chip_type]["Parameter"]["Name"] = self.uid
 
             if module_type == "triplet":
@@ -774,6 +772,21 @@ class Chip:
                     )
                     return None
 
+        if clear_chip_config:
+            if chip_template[chip_type].get("PixelConfig"):
+                log.info("Deleting PixelConfig from chip config.")
+                del chip_template[chip_type]["PixelConfig"]
+
+            for th in ["DiffTh1L", "DiffTh1M", "DiffTh1R", "DiffVff"]:
+                if th in chip_template[chip_type]["GlobalConfig"]:
+                    log.info("Deleting %s from chip config.", th)
+                    del chip_template[chip_type]["GlobalConfig"][th]
+
+            log.info("Reset to default DiffVff for layer %s.", power_config)
+            chip_template[chip_type]["GlobalConfig"]["DiffVff"] = default_chip_config[
+                chip_type
+            ]["GlobalConfig"]["DiffVff"][power_config]
+
         return chip_template
 
 
@@ -916,10 +929,11 @@ class LocalModule:
 
         return current_stage
 
-    # speed and reverse needed to match the non-localDB module generate_config function
+    # Keywords default_chip_config, speed, reverse and clear_chip_config needed to match the non-localDB module generate_config function
     def generate_config(
         self,
         chip_template,
+        default_chip_config,
         layer_config,
         dp_port: DPPort,
         suffix,
@@ -927,6 +941,7 @@ class LocalModule:
         speed=1280,
         reverse=False,
         felix=False,
+        clear_chip_config=False,
     ):
         """
         Generate module config.
@@ -938,10 +953,12 @@ class LocalModule:
             version,
         )
         log.debug(
-            "Unused variables: chip template: %s, speed: %i MHz, reverse orientation: %s.",
+            "Unused variables: chip template: %s, default chip config: %s, speed: %i MHz, reverse orientation: %s, clear chip config: %s",
             chip_template,
+            default_chip_config,
             speed,
             reverse,
+            clear_chip_config,
         )
 
         config_api = ChipConfigAPI(self.client)

module_qc_database_tools-2.11.2/src/module_qc_database_tools/data/YARR/default_chip_config.json

@@ -0,0 +1,102 @@
+{
+  "chip_type": {
+    "GlobalConfig": {
+      "DiffPreComp": {
+        "R0": 350,
+        "R0.5": 350,
+        "L0": 350,
+        "L1": 350,
+        "L2": 350,
+        "LP": 0
+      },
+      "DiffPreampL": {
+        "R0": 900,
+        "R0.5": 900,
+        "L0": 900,
+        "L1": 730,
+        "L2": 550,
+        "LP": 0
+      },
+      "DiffPreampM": {
+        "R0": 900,
+        "R0.5": 900,
+        "L0": 900,
+        "L1": 730,
+        "L2": 550,
+        "LP": 0
+      },
+      "DiffPreampR": {
+        "R0": 900,
+        "R0.5": 900,
+        "L0": 900,
+        "L1": 730,
+        "L2": 550,
+        "LP": 0
+      },
+      "DiffPreampT": {
+        "R0": 900,
+        "R0.5": 900,
+        "L0": 900,
+        "L1": 730,
+        "L2": 550,
+        "LP": 0
+      },
+      "DiffPreampTL": {
+        "R0": 900,
+        "R0.5": 900,
+        "L0": 900,
+        "L1": 730,
+        "L2": 550,
+        "LP": 0
+      },
+      "DiffPreampTR": {
+        "R0": 900,
+        "R0.5": 900,
+        "L0": 900,
+        "L1": 730,
+        "L2": 550,
+        "LP": 0
+      },
+      "DiffVff": {
+        "R0": 150,
+        "R0.5": 150,
+        "L0": 150,
+        "L1": 150,
+        "L2": 60,
+        "LP": 0
+      },
+      "EnCoreCol0": {
+        "R0": 65535,
+        "R0.5": 65535,
+        "L0": 65535,
+        "L1": 65535,
+        "L2": 65535,
+        "LP": 0
+      },
+      "EnCoreCol1": {
+        "R0": 65535,
+        "R0.5": 65535,
+        "L0": 65535,
+        "L1": 65535,
+        "L2": 65535,
+        "LP": 0
+      },
+      "EnCoreCol2": {
+        "R0": 65535,
+        "R0.5": 65535,
+        "L0": 65535,
+        "L1": 65535,
+        "L2": 65535,
+        "LP": 0
+      },
+      "EnCoreCol3": {
+        "R0": 63,
+        "R0.5": 63,
+        "L0": 63,
+        "L1": 63,
+        "L2": 63,
+        "LP": 0
+      }
+    }
+  }
+}

{module_qc_database_tools-2.11.1 → module_qc_database_tools-2.11.2}/tbump.toml

@@ -1,5 +1,5 @@
 [version]
-current = "2.11.1"
+current = "2.11.2"
 
 # 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.11.1 → {new_version}"
+message_template = "Bump version: 2.11.2 → {new_version}"
 tag_template = "v{new_version}"
 
 # For each file to patch, add a [[file]] config