Module QC Database Tools v2.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.

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 or miniconda 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:

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, path to output directory config folder will be placed in. If not supplied, the config files will be pushed into mongoDB if connection is set up.

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.