module-qc-database-tools 0.0.1__py3-none-any.whl

module_qc_database_tools/__init__.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+import sys
+
+from module_qc_database_tools._version import __version__
+
+if sys.version_info >= (3, 9):
+    from importlib import resources
+else:
+    import importlib_resources as resources
+data = resources.files("module_qc_database_tools") / "data"
+
+__all__ = ("__version__", "data")

module_qc_database_tools/_version.py

@@ -0,0 +1,4 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)

module_qc_database_tools/cli/__init__.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+import logging
+
+from module_qc_database_tools.cli.main import app
+
+logging.basicConfig()
+__all__ = ("app",)

module_qc_database_tools/cli/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from module_qc_database_tools.cli.main import app
+
+app()

module_qc_database_tools/cli/generate_yarr_config.py

@@ -0,0 +1,450 @@
+from __future__ import annotations
+
+import json
+import math
+from pathlib import Path
+
+import itkdb
+import pandas as pd
+import typer
+
+import module_qc_database_tools
+
+app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
+
+
+@app.command()
+def main(
+    serial_number: str = typer.Option(..., "-sn", "--sn", help="ATLAS serialNumber"),
+    chip_template: Path = typer.Option(
+        (module_qc_database_tools.data / "YARR" / "chip_template.json").resolve(),
+        "-ch",
+        "--chipTemplate",
+        help="Default chip template from which the chip configs are generated.",
+        exists=True,
+        file_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    output_dir: Path = typer.Option(
+        ...,
+        "-o",
+        "--outdir",
+        help="Path to output directory. Configs must be in Yarr/configs.",
+        exists=False,
+        writable=True,
+    ),
+):
+    """
+    Main executable for generating yarr config.
+    """
+    client = itkdb.Client()
+    module = Module(client, serial_number)
+    typer.echo("INFO: Getting layer-dependent config from module SN...")
+    layer_config = get_layer_from_serial_number(serial_number)
+
+    module.generate_config(chip_template, output_dir, layer_config, suffix="warm")
+    module.generate_config(chip_template, output_dir, layer_config, suffix="cold")
+    module.generate_config(chip_template, output_dir, layer_config, suffix="LP")
+
+
+class Module:
+    """
+    Module class.
+    """
+
+    def __init__(self, client, serial_number, name=None):
+        self.client = client
+        self.serial_number = serial_number
+        self.name = name if name else self.serial_number
+        self.module = client.get("getComponent", json={"component": serial_number})
+        self.bare_modules = []
+        for child in self.module["children"]:
+            if child["componentType"]["code"] == "BARE_MODULE":
+                self.bare_modules.append(
+                    client.get(
+                        "getComponent",
+                        json={"component": child["component"]["serialNumber"]},
+                    )
+                )
+        self.chips = []
+        for bare_module in self.bare_modules:
+            for child in bare_module["children"]:
+                if child["componentType"]["code"] == "FE_CHIP":
+                    self.chips.append(
+                        Chip(
+                            client,
+                            child["component"]["serialNumber"],
+                            module_name=self.name,
+                        )
+                    )
+        if len(self.bare_modules) == 3 and len(self.chips) == 3:
+            self.module_type = "triplet"
+            typer.echo(f"INFO: triplet {self.serial_number} initiated.")
+        else:
+            self.module_type = "quad"
+            typer.echo(f"INFO: quad module {self.serial_number} initiated.")
+
+    def generate_config(self, chip_template, outdir, layer_config, suffix):
+        """
+        Generate module config.
+        """
+        typer.echo(
+            f"INFO: generating module config for module {self.serial_number} with {layer_config}"
+        )
+
+        spec = {"chipType": "RD53B", "chips": []}
+
+        for chip_index, chip in enumerate(self.chips):
+            if self.module_type == "triplet":
+                spec["chips"].append(
+                    {
+                        "config": chip.generate_config(
+                            chip_template,
+                            outdir,
+                            chip_index,
+                            layer_config,
+                            self.module_type,
+                            suffix=suffix,
+                        ),
+                        "path": "relToCon",
+                        "tx": 0,
+                        "rx": [0, 1, 2][chip_index],
+                        "enable": 1,
+                        "locked": 0,
+                    }
+                )
+            else:
+                spec["chips"].append(
+                    {
+                        "config": chip.generate_config(
+                            chip_template,
+                            outdir,
+                            chip_index,
+                            layer_config,
+                            self.module_type,
+                            suffix=suffix,
+                        ),
+                        "path": "relToCon",
+                        "tx": 0,
+                        "rx": [2, 1, 0, 3][chip_index],
+                        "enable": 1,
+                        "locked": 0,
+                    }
+                )
+
+        output_path = Path(outdir, self.name)
+        output_path.mkdir(parents=True, exist_ok=True)
+        with output_path.joinpath(
+            f"{self.name}_{layer_config}{'_'+suffix if suffix else ''}.json"
+        ).open("w", encoding="utf-8") as serialized:
+            json.dump(spec, serialized, indent=4)
+        typer.echo(
+            f"INFO: connectivity file saved to {outdir}/{self.name}/{self.name}_{layer_config}{'_'+suffix if suffix else ''}.json"
+        )
+
+
+class Chip:
+    """
+    Chip class.
+    """
+
+    def __init__(self, client, serial_number, module_name=None):
+        self.client = client
+        self.serial_number = serial_number
+        self.chip_uid = hex(int(serial_number[-7:]))
+        self.module_name = module_name or self.serial_number
+        self.chip = client.get("getComponent", json={"component": serial_number})
+        self.test_run = None
+
+        typer.echo(f"INFO: chip {self.chip_uid} initiated.")
+
+    def load_wafer_probing_data(self):
+        """
+        Load chip wafer probing data.
+        """
+        test_id = None
+        tests = pd.DataFrame(self.chip["tests"])
+        if len(tests[tests["code"] == "FECHIP_TEST"]) > 0:
+            test_id = tests[tests["code"] == "FECHIP_TEST"]["testRuns"].iloc[-1][-1][
+                "id"
+            ]
+        if not test_id:
+            msg = (
+                f"No wafer probing data in production DB for chip {self.serial_number}!"
+            )
+            raise RuntimeError(msg)
+        self.test_run = TestRun(self.client, test_id)
+
+    def generate_config(
+        self, chip_template, outdir, chip_index, layer_config, module_type, suffix=""
+    ):
+        """
+        Generate chip config.
+        """
+        typer.echo(
+            f"INFO: generating chip config for chip {self.chip_uid} with {layer_config}"
+        )
+
+        with Path(chip_template).open(encoding="utf-8") as serialized:
+            spec = json.load(serialized)
+
+        power_config = "LP" if suffix == "LP" else layer_config
+
+        spec["RD53B"]["GlobalConfig"]["DiffPreComp"] = {
+            "R0": 350,
+            "R0.5": 350,
+            "L0": 350,
+            "L1": 350,
+            "L2": 350,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffPreampL"] = {
+            "R0": 900,
+            "R0.5": 900,
+            "L0": 900,
+            "L1": 730,
+            "L2": 550,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffPreampM"] = {
+            "R0": 900,
+            "R0.5": 900,
+            "L0": 900,
+            "L1": 730,
+            "L2": 550,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffPreampR"] = {
+            "R0": 900,
+            "R0.5": 900,
+            "L0": 900,
+            "L1": 730,
+            "L2": 550,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffPreampT"] = {
+            "R0": 900,
+            "R0.5": 900,
+            "L0": 900,
+            "L1": 730,
+            "L2": 550,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffPreampTL"] = {
+            "R0": 900,
+            "R0.5": 900,
+            "L0": 900,
+            "L1": 730,
+            "L2": 550,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffPreampTR"] = {
+            "R0": 900,
+            "R0.5": 900,
+            "L0": 900,
+            "L1": 730,
+            "L2": 550,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["DiffVff"] = {
+            "R0": 150,
+            "R0.5": 150,
+            "L0": 150,
+            "L1": 150,
+            "L2": 60,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["EnCoreCol0"] = {
+            "R0": 65535,
+            "R0.5": 65535,
+            "L0": 65535,
+            "L1": 65535,
+            "L2": 65535,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["EnCoreCol1"] = {
+            "R0": 65535,
+            "R0.5": 65535,
+            "L0": 65535,
+            "L1": 65535,
+            "L2": 65535,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["EnCoreCol2"] = {
+            "R0": 65535,
+            "R0.5": 65535,
+            "L0": 65535,
+            "L1": 65535,
+            "L2": 65535,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["GlobalConfig"]["EnCoreCol3"] = {
+            "R0": 63,
+            "R0.5": 63,
+            "L0": 63,
+            "L1": 63,
+            "L2": 63,
+            "LP": 0,
+        }[power_config]
+        spec["RD53B"]["Parameter"]["Name"] = self.chip_uid
+
+        if module_type == "triplet":
+            spec["RD53B"]["Parameter"]["ChipId"] = chip_index + 1
+            spec["RD53B"]["GlobalConfig"]["AuroraActiveLanes"] = {
+                "R0": 7,
+                "R0.5": 3,
+                "L0": 15,
+            }[
+                layer_config
+            ]  ## TODO: add source for R0 and R0.5
+            # spec["RD53B"]["GlobalConfig"]["MonitorEnable"] = 0
+            # spec["RD53B"]["GlobalConfig"]["MonitorV"] = 63
+            for index in range(4):
+                spec["RD53B"]["GlobalConfig"][f"DataMergeOutMux{index}"] = (
+                    0 + index
+                ) % 4
+            spec["RD53B"]["GlobalConfig"]["SerEnLane"] = {"R0": 7, "R0.5": 3, "L0": 15}[
+                layer_config
+            ]
+        else:
+            spec["RD53B"]["Parameter"]["ChipId"] = 12 + chip_index
+            spec["RD53B"]["GlobalConfig"]["AuroraActiveLanes"] = 1
+            for index in range(4):
+                spec["RD53B"]["GlobalConfig"][f"DataMergeOutMux{index}"] = (
+                    [2, 0, 1, 0][chip_index] + index
+                ) % 4
+            spec["RD53B"]["GlobalConfig"]["SerEnLane"] = [4, 1, 8, 1][chip_index]
+
+        if not self.test_run:
+            self.load_wafer_probing_data()
+        if self.test_run:
+            spec["RD53B"]["GlobalConfig"]["SldoTrimA"] = self.test_run.get_result(
+                "VDDA_TRIM"
+            )
+            spec["RD53B"]["GlobalConfig"]["SldoTrimD"] = self.test_run.get_result(
+                "VDDD_TRIM"
+            )
+            spec["RD53B"]["Parameter"]["ADCcalPar"][0] = (
+                self.test_run.get_result("ADC_OFFSET") * 1000
+            )
+            spec["RD53B"]["Parameter"]["ADCcalPar"][1] = (
+                self.test_run.get_result("ADC_SLOPE") * 1000
+            )
+            spec["RD53B"]["Parameter"]["InjCap"] = self.test_run.get_result(
+                "InjectionCapacitance"
+            ) * (10**15)
+
+            # For transistor sensors calibration, the ideality factor is calculated following the presentation:
+            # https://indico.cern.ch/event/1011941/contributions/4278988/attachments/2210633/3741190/RD53B_calibatrion_sensor_temperature.pdf
+            e_charge = 1.602e-19
+            kB = 1.38064852e-23
+            PC_NTC = self.test_run.get_result("PC_NTC") + 273
+            DeltaT = 2  # 2 degree difference between PC NTC and transistor sensors
+            spec["RD53B"]["Parameter"]["NfDSLDO"] = (
+                self.test_run.get_result("TEMPERATURE_D")
+                * e_charge
+                / (kB * math.log(15) * (PC_NTC + DeltaT))
+            )
+            spec["RD53B"]["Parameter"]["NfASLDO"] = (
+                self.test_run.get_result("TEMPERATURE_A")
+                * e_charge
+                / (kB * math.log(15) * (PC_NTC + DeltaT))
+            )
+            spec["RD53B"]["Parameter"]["NfACB"] = (
+                self.test_run.get_result("TEMPERATURE_C")
+                * e_charge
+                / (kB * math.log(15) * (PC_NTC + DeltaT))
+            )
+
+            spec["RD53B"]["Parameter"]["VcalPar"] = [
+                abs(self.test_run.get_result("VCAL_HIGH_LARGE_RANGE_OFFSET") * 1000),
+                self.test_run.get_result("VCAL_HIGH_LARGE_RANGE_SLOPE") * 1000,
+            ]
+            spec["RD53B"]["Parameter"]["IrefTrim"] = self.test_run.get_result(
+                "IREF_TRIM"
+            )
+            spec["RD53B"]["Parameter"]["KSenseInA"] = self.test_run.get_result(
+                "CURR_MULT_FAC_A"
+            )
+            spec["RD53B"]["Parameter"]["KSenseInD"] = self.test_run.get_result(
+                "CURR_MULT_FAC_D"
+            )
+            spec["RD53B"]["Parameter"]["KSenseShuntA"] = (
+                self.test_run.get_result("CURR_MULT_FAC_A") * 26000.0 / 21000.0
+            )
+            spec["RD53B"]["Parameter"]["KSenseShuntD"] = (
+                self.test_run.get_result("CURR_MULT_FAC_D") * 26000.0 / 21000.0
+            )
+            spec["RD53B"]["Parameter"]["KShuntA"] = self.test_run.get_result(
+                "VINA_SHUNT_KFACTOR"
+            )
+            spec["RD53B"]["Parameter"]["KShuntD"] = self.test_run.get_result(
+                "VIND_SHUNT_KFACTOR"
+            )
+
+        output_path = Path(
+            outdir, self.module_name, f"{layer_config}{'_'+suffix if suffix else ''}"
+        )
+        output_path.mkdir(parents=True, exist_ok=True)
+        output_file = output_path.joinpath(
+            f"{self.chip_uid}_{layer_config}{'_'+suffix if suffix else ''}.json"
+        )
+        with output_file.open("w", encoding="utf-8") as serialized:
+            json.dump(spec, serialized, indent=4)
+
+        typer.echo(f"INFO: chip config saved to {output_file}")
+        return str(Path(*output_file.parts[-2:]))
+
+
+class TestRun:
+    """
+    TestRun class.
+    """
+
+    def __init__(self, client, test_run_id):
+        self.client = client
+        self.identifier = test_run_id
+        self.test_run = client.get("getTestRun", json={"testRun": test_run_id})
+        self.results = pd.DataFrame(self.test_run["results"])
+
+        typer.echo(f"INFO: test run {self.identifier} initiated.")
+
+    def get_result(self, code):
+        """
+        Get test run result.
+        """
+        if len(self.results[self.results["code"] == code]) > 0:
+            return self.results[self.results["code"] == code]["value"].iloc[-1]
+        return None
+
+
+def get_layer_from_serial_number(serial_number):
+    """
+    Get the layer from the serial number.
+    """
+    if len(serial_number) != 14 or not serial_number.startswith("20U"):
+        typer.echo("Error: Please enter a valid ATLAS SN.")
+        raise typer.Exit(code=1)
+
+    if "PIMS" in serial_number or "PIR6" in serial_number:
+        return "L0"
+
+    if "PIM0" in serial_number or "PIR7" in serial_number:
+        return "R0"
+
+    if "PIM5" in serial_number or "PIR8" in serial_number:
+        return "R0.5"
+
+    if "PIM1" in serial_number or "PIRB" in serial_number:
+        return "L1"
+
+    if "PG" in serial_number:
+        return "L2"
+
+    typer.echo("Error: invalid module SN.")
+    raise typer.Exit(code=1)
+
+
+if __name__ == "__main__":
+    typer.run(main)

module_qc_database_tools/cli/main.py

@@ -0,0 +1,40 @@
+"""
+Top-level entrypoint for the command line interface.
+"""
+from __future__ import annotations
+
+import typer
+
+import module_qc_database_tools
+from module_qc_database_tools.cli.generate_yarr_config import (
+    main as generate_yarr_config,
+)
+from module_qc_database_tools.cli.register_component import main as register_component
+
+# subcommands
+app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
+
+
+@app.callback(invoke_without_command=True)
+def main(
+    version: bool = typer.Option(False, "--version", help="Print the current version."),
+    prefix: bool = typer.Option(
+        False, "--prefix", help="Print the path prefix for data files."
+    ),
+) -> None:
+    """
+    Manage top-level options
+    """
+    if version:
+        typer.echo(f"module-qc-database-tools v{module_qc_database_tools.__version__}")
+        raise typer.Exit()
+    if prefix:
+        typer.echo(module_qc_database_tools.data.resolve())
+        raise typer.Exit()
+
+
+app.command("generate-yarr-config")(generate_yarr_config)
+app.command("register-component")(register_component)
+
+# for generating documentation using mkdocs-click
+typer_click_object = typer.main.get_command(app)

module_qc_database_tools/cli/register_component.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+
+import itkdb
+import typer
+
+import module_qc_database_tools
+
+app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
+
+
+@app.command()
+def main(
+    serial_number: str = typer.Option(..., "-sn", "--sn", help="ATLAS serialNumber"),
+    config_path: Path = typer.Option(
+        (module_qc_database_tools.data / "componentConfigs.json").resolve(),
+        "-c",
+        "--config",
+        help="component configs for registering components",
+        exists=True,
+        file_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    component: str = typer.Option(
+        ...,
+        "-cp",
+        "--component",
+        help="Component to register",
+    ),
+    institution: str = typer.Option("", "-i", "--institution", help="Institution"),
+):
+    """
+    Main executable for registering components.
+    """
+    with config_path.open() as fpointer:
+        config = json.load(fpointer)[component]
+
+    institution = institution or os.environ.get("INSTITUTION")
+    if not institution:
+        msg = "Must specify institution from commandline or set the appropriate environment variable."
+        raise ValueError(msg)
+
+    client = itkdb.Client()
+    register_component(client, institution, config, serial_number)
+
+
+def register_component(client, institution, config, serial_number):
+    """
+    Register a component in production database using institution, config, and serial number
+    """
+    config["institution"] = institution
+    config["serialNumber"] = serial_number
+    client.post("registerComponent", json=config)
+
+
+if __name__ == "__main__":
+    typer.run(main)

module_qc_database_tools/data/YARR/chip_template.json

@@ -0,0 +1,19 @@
+{
+  "RD53B": {
+    "GlobalConfig": {
+      "AuroraActiveLanes": 1,
+      "CmlBias0": 800,
+      "CmlBias1": 200,
+      "CmlBias2": 0,
+      "SerEnTap": 1,
+      "SerInvTap": 1,
+      "MonitorEnable": 1,
+      "MonitorI": 63,
+      "MonitorV": 1,
+      "ServiceBlockEn": 1
+    },
+    "Parameter": {
+      "ADCcalPar": [5.894350051879883, 0.1920430064201355, 10000.0]
+    }
+  }
+}

module_qc_database_tools/data/componentConfigs.json

@@ -0,0 +1,34 @@
+{
+  "quad_PCB_2_4": {
+    "project": "P",
+    "subproject": "PG",
+    "componentType": "PCB",
+    "type": "QUAD_PCB",
+    "properties": {
+      "VERSION_OF_HYBRID_DESIGN": 2.4,
+      "FECHIP_VERSION": "2"
+    }
+  },
+  "quad_PCB_1_5": {
+    "project": "P",
+    "subproject": "PG",
+    "componentType": "PCB",
+    "type": "QUAD_PCB",
+    "properties": {
+      "VERSION_OF_HYBRID_DESIGN": 1.5,
+      "FECHIP_VERSION": "2"
+    }
+  },
+  "digital_quad_bare_module": {
+    "project": "P",
+    "subproject": "PG",
+    "componentType": "BARE_MODULE",
+    "type": "DIGITAL_QUAD_BARE_MODULE",
+    "properties": {
+      "FECHIP_VERSION": "2",
+      "SENSOR_TYPE": "0",
+      "THICKNESS": "1",
+      "VENDOR": "1"
+    }
+  }
+}

module_qc_database_tools-0.0.1.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: module-qc-database-tools
+Version: 0.0.1
+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
+Project-URL: Source, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools
+Author-email: Jay Chan <jay.chan@cern.ch>
+Maintainer-email: Giordon Stark <kratsg@gmail.com>, Elisabetta Pianori <elisabetta.pianori@cern.ch>, Lingxin Meng <lingxin.meng@cern.ch>
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.7
+Requires-Dist: importlib-resources>=1.4.0; python_version < '3.9'
+Requires-Dist: itkdb>=0.4.0
+Requires-Dist: pandas
+Requires-Dist: typer
+Description-Content-Type: text/markdown
+
+# Module QC Database Tools v0.0.1
+
+The package to regisiter ITkPixV1.1 modules, and generate YARR configs from ITk
+production database using `itkdb` API.
+
+## Set-Up and First-time Installation
+
+A minimum of python version 3.7+ is required.
+
+### Virtual Python Environment
+
+Creating the python virtual environment the standard way used the python version
+available on the operating system. For CentOS 7 this is version 3.6. If using
+CentOS 7, you can install python 3.8 following these
+[instructions](https://tecadmin.net/install-python-3-8-centos/).
+
+After installing python 3.8, create the virtual environment:
+
+```
+$ python3 -m venv venv
+$ source venv/bin/activate
+```
+
+For future use:
+
+```
+$ source venv/bin/activate
+```
+
+Alternatively, [anaconda](https://docs.anaconda.com/anaconda/install/index.html)
+or [miniconda](https://docs.conda.io/en/latest/miniconda.html) can also be
+installed.
+
+For future use:
+
+```
+$ conda activate
+```
+
+### Install
+
+```
+$ python -m pip install module-qc-database-tools
+```
+
+### Environment Variables
+
+If not already set elsewhere (e.g. `~/.bashrc`), copy `.env.template` to `.env`
+and update the values of the shell variables. Essentially, the following
+variables regarding the production database should be available, shown below as
+an example of environmental variables in `~/.bashrc`:
+
+```bash
+export INSTITUTION="LBNL_PIXEL_MODULES"
+export ITKDB_ACCESS_CODE1="accesscode1"
+export ITKDB_ACCESS_CODE2="accesscode2"
+```
+
+## Module registration
+
+Under construction...
+
+## Generate YARR configuration
+
+This script has been tested on python 3.7+.
+
+To generate YARR configuration for a given module, run `generateYARRConfig` or
+`mqdbt generate-yarr-config`:
+
+```
+$ generateYARRConfig -sn [ATLAS SN] -o [outdir]
+$ mqdbt generate-yarr-config -sn [ATLAS SN] -o [outdir]
+
+Parameters:
+-sn, --sn, required=True: ATLAS serial number of the module
+-ch, --chipTemplate, default="configs/YARR/chip_template.json": provide the path of a chip config template to generate the new chip configs from
+-o, --outdir, required=True: Path to output directory config folder will be placed in
+```
+
+For example, to generate the YARR configs for the module `20UPGR91301046` with
+all power configs:
+
+```
+$ generateYARRConfig -sn 20UPGR91301046 -o ~/module_data/.
+$ mqdbt generate-yarr-config -sn 20UPGR91301046 -o ~/module_data/.
+```
+
+The time needed to generate warm and cold L2 configs for a quad module is about
+4 seconds.

module_qc_database_tools-0.0.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+module_qc_database_tools/__init__.py,sha256=Ug7pRtlzlDzQFNexHqET-BnZxOh4qbIHdOoDE0CvjqA,319
+module_qc_database_tools/_version.py,sha256=0E2q3bbXSYHV7qQaXVj0To-J2XdlP2Roo0TsM8oQtR4,160
+module_qc_database_tools/cli/__init__.py,sha256=1W6Ei7U8ZHuCUe_qNkzr7-no5RJHBhVGGr0XzMCNkEs,144
+module_qc_database_tools/cli/__main__.py,sha256=FMkuLcxfugwbVz6KD0R0DEUamhpgCJCAsD_CbadKltI,93
+module_qc_database_tools/cli/generate_yarr_config.py,sha256=bQjkAozFNIOXL4dRyfcqD9drSkeV7Iv0CQt71rrBADI,15476
+module_qc_database_tools/cli/main.py,sha256=aZR8tHF7qZk6T5oaX6bTlRm6rCn0wrPLCm_to3JTQW0,1180
+module_qc_database_tools/cli/register_component.py,sha256=QDROimbJafcIAFRcjTkYZzU8_qZA1ynPuUqFfiNDVx4,1694
+module_qc_database_tools/data/componentConfigs.json,sha256=6XWYBjrT5It7CM0IA_6tYTB4mDXFSph5ncwgsvvYYlE,713
+module_qc_database_tools/data/YARR/chip_template.json,sha256=CysMQxQYav_kKzhDt--tbpuWW5JKNLCK-WRhXuZDPv4,378
+module_qc_database_tools-0.0.1.dist-info/METADATA,sha256=XpqqEtQXDiEhslCE4rckFV1td5RgB_GYPrwcLV5UXfI,4032
+module_qc_database_tools-0.0.1.dist-info/WHEEL,sha256=EI2JsGydwUL5GP9t6kzZv7G3HDPi7FuZDDf9In6amRM,87
+module_qc_database_tools-0.0.1.dist-info/entry_points.txt,sha256=VYCepcugT-1ZbTRVDGXyF59PTTGKYEIYLpSv6rmlw6Q,266
+module_qc_database_tools-0.0.1.dist-info/RECORD,,

module_qc_database_tools-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.14.0
+Root-Is-Purelib: true
+Tag: py3-none-any

module_qc_database_tools-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+generateYARRConfig = module_qc_database_tools.cli.generate_yarr_config:app
+module-qc-database-tools = module_qc_database_tools.cli:app
+mqdbt = module_qc_database_tools.cli:app
+registerComponent = module_qc_database_tools.cli.register_component:app