Module qc analysis tools

These details have not been verified by PyPI

Project links

Project description

module-qc-analysis-tools v2.2.5rc4

A general python tool for running ITkPixV1.1 module QC test analysis. An overview of the steps in the module QC procedure is documented in the Electrical specification and QC procedures for ITkPixV1.1 modules document and in this spreadsheet. The analysis scripts in this repository require input files with measurement data. The measurement data should be collected using the module-qc-measurement-tools package.

Requirements
Installation
Scripts
Notes
For developer

Requirements

This tool requires users to have >python3.6 with the following packages installed:

numpy
scipy
tabulate
matplotlib
jsonschema

Installation

This package may be accessed by cloning from gitlab or by installing it via pip.

via clone

Use this method if you want to use the latest version of the package from gitlab. First clone the project:

git clone https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-analysis-tools.git

Upon a successful checkout, cd to the new module-qc-analysis-tools directory and run the following to install the necessary software:

$ python3 -m venv env
$ source env/bin/activate
$ python -m pip install --upgrade pip
$ python -m pip install -e .

via pip

Use this method if you want to use the latest stable (versioned) release of the package.

$ python -m venv venv
$ source venv/bin/activate
$ python -m pip install -U pip
$ python -m pip install -U pip module-qc-analysis-tools==2.2.5rc4

Note that users should use the latest python version (check python version via python3 -V). Python3.7 is the minimum requirement for developers. See For Developer section.

Scripts

`Sensor IV Measurement`

This analysis script analyses sensor leakage current vs voltage measurement. It produces an output file with several key parameters: breakdown voltage, leakage current at operation voltage (depletion voltage + 20/50V for 3D/planar sensor), whether breakdown was observed and the absolute maximum measured bias voltage. Note that raw measurement data will be plotted and uploaded onto the production database, which uses the absolute bias voltage and leakage current regardless of the polarity. All currents will be converted to uA.

If the depletion voltage if the sensor is unknown, please do not supply anything to --vdepl. In this case either a value from the database or a default value will be used.

One analysis criterion is the change wrt the bare module stage. For this, an additional input file is required which provides the reference bare module IV with up to 3 bare modules (triplets) in the format below. This is generated in localDB. If none is supplied, the analysis will run but the module will not pass.

Bare Module IV format

``` { 'target_component' : , 'target_stage' : , 'reference_IVs' : [ { 'component' : , 'stage' : , 'Vbd' : , 'Vfd' : , 'temperature' : , 'IV_ARRAY' : { "voltage" : [ array ], "current" : [array], "temperature": [array] } }, { 'component' : , 'stage' : , 'Vbd' : , 'Vfd' : , 'temperature' : , 'IV_ARRAY' : { "voltage" : [ array ], "current" : [array], "temperature": [array] } }, { 'component' : , 'stage' : , 'Vbd' : , 'Vfd' : , 'temperature' : , 'IV_ARRAY' : { "time": [array], "voltage" : [ array ], "current" : [array], "sigma current": [array], "temperature": [array], "humidity": [array] } } ] } ```

analysis-IV-MEASURE --help

$ analysis-IV-MEASURE -h
Usage: analysis-IV-MEASURE [OPTIONS]
Options:
  -i, --input-meas PATH    path to the input measurement file or directory containing input measurement files. [default: None] [required]
  -o, --output-dir PATH           output directory  [default: outputs]
  -q, --qc-criteria PATH          path to reference IV measurement results from bare module stage. [default: None] [required]
  -l, --layer TEXT                Layer of module, used for applying correct
                                  QC criteria settings. Options: L0, L1, L2
                                  (default is automatically determined from module SN)
  -v, --verbosity [DEBUG|INFO|WARNING|ERROR]
                                  Log level [options: DEBUG, INFO (default)
                                  WARNING, ERROR]  [default: LogLevel.info]
      --site TEXT                 Your testing site. Required when submitting results. Please use same short-hand as on production DB, i.e. LBNL_PIXEL_MODULES for LBNL, IRFU for Paris-Saclay, ...
      --vdepl FLOAT               Depletion voltage [default: None]

`ADC_CALIBRATION`

This analysis script performs the ADC calibration. It produces several diagnostic plots and an output file with the ADC calibration slope and offset.

analysis-ADC-CALIBRATION --help

analysis-ADC-CALIBRATION --help
usage: analysis-ADC-CALIBRATION [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                [-f {root,numpy}] [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0, L1, L2.
  --permodule           Store results in one file per module (default: one file per chip)
  -f {root,numpy}, --fit-method {root,numpy}
                        fitting method
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`ANALOG_READBACK`

This analysis script performs the Analog Readback. It produces an output file with the calculated internal biases, temperature from the internal and external temperature sensor, and VDDA/VDDD vs Trim, including diagnostic plots with slope and offset.

analysis-ANALOG-READBACK --help

$ analysis-ANALOG-READBACK --help
usage: analysis-ANALOG-READBACK [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                [-f {root,numpy}] [-v VERBOSITY] [--verbose]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0, L1, L2.
  --permodule           Store results in one file per module (default: one file per chip)
  -f {root,numpy}, --fit-method {root,numpy}
                        fitting method
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]
  --verbose             verbose mode

`SLDO`

This script analyses the SLDO curve. It produces several diagnostic plots and an output file with several parameters extracted from the SLDO curves.

analysis-SLDO --help

$ analysis-SLDO --help
usage: analysis-SLDO [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule] [-n NCHIPS]
                     [-f {root,numpy}] [-v VERBOSITY] [--lp-enable]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0, L1, L2.
  --permodule           Store results in one file per module (default: one file per chip)
  -n NCHIPS, --nChips NCHIPS
                        Number of chips powered in parallel (e.g. 4 for a quad module, 3 for a triplet, 1 for an
                        SCC.)
  -f {root,numpy}, --fit-method {root,numpy}
                        fitting method
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]
  --lp-enable           low power mode

`VCAL_CALIBRATION`

This analysis script performs the VCal calibration. It produces several diagnostic plots and an output file with the VCal calibration slope and offset.

analysis-VCAL-CALIBRATION --help

$ analysis-VCAL-CALIBRATION --help
usage: analysis-VCAL-CALIBRATION [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                 [-f {root,numpy}] [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0, L1, L2.
  --permodule           Store results in one file per module (default: one file per chip)
  -f {root,numpy}, --fit-method {root,numpy}
                        fitting method
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`INJECTION_CAPACITANCE`

This analysis script performs the injection capacitance. It produces several diagnostic plots and an output file with the measured pixel injection capacitance.

analysis-INJECTION-CAPACITANCE --help

$ analysis-INJECTION-CAPACITANCE --help
usage: analysis-INJECTION-CAPACITANCE [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                      [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0, L1, L2.
  --permodule           Store results in one file per module (default: one file per chip)
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`LP_MODE`

This analysis script performs the Low Power mode analysis. It produces an output file with the measured internal voltages and currents in low power mode.

analysis-LP-MODE --help

$ analysis-LP-MODE --help
usage: analysis-LP-MODE [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                      [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0,
L1, L$
  --permodule           Store results in one file per module (default: one file per chip)
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`OVERVOLTAGE_PROTECTION`

This analysis script performs the Overvoltage protection analysis. It produces an output file with the measured internal voltages and currents in low power mode and when overvoltage protection mechanism is activated.

analysis-OVERVOLTAGE-PROTECTION --help

$ analysis-OVERVOLTAGE-PROTECTION --help
usage: analysis-OVERVOLTAGE-PROTECTION [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                      [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0,
L1, L$
  --permodule           Store results in one file per module (default: one file per chip)
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`UNDERSHUNT_PROTECTION`

This analysis script performs the Undershunt protection analysis. It produces an output file with the measured internal voltages and currents in when the undershunt protection mechanism is activated.

analysis-UNDERSHUNT-PROTECTION --help

$ analysis-UNDERSHUNT-PROTECTION --help
usage: analysis-UNDERSHUNT-PROTECTION [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                      [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools
--prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses
information from production database. Options: L0,
L1, L$
  --permodule           Store results in one file per module (default: one file per chip)
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`DATA_TRANSMISSION`

This analysis script performs the data transmission. It produces several diagnostic plots and an output file with the eye diagram width.

analysis-DATA-TRANSMISSION --help

analysis-DATA-TRANSMISSION --help
usage: analysis-DATA-TRANSMISSION [-h] -i INPUT_MEAS [-o OUTPUT_DIR] [-q QC_CRITERIA] [-l LAYER] [--permodule]
                                [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_MEAS, --input-meas INPUT_MEAS
                        path to the input measurement file or directory containing input measurement files.
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        output directory
  -q QC_CRITERIA, --qc-criteria QC_CRITERIA
                        path to json file with QC selection criteria (default: $(module-qc-analysis-tools --prefix)/analysis_cuts.json)
  -l LAYER, --layer LAYER
                        Layer of module, used for applying correct QC criteria settings. Default setting uses information from production database. Options: L0, L1, L2.
  --permodule           Store results in one file per module (default: one file per chip)
  -v VERBOSITY, --verbosity VERBOSITY
                        Log level [options: DEBUG, INFO (default), WARNING, ERROR]

`MIN_HEALTH_TEST`

This analysis script performs the minimum health analysis of YARR Scans. It produces an output file with key parameters (number of dead/bad pixels, ...). Note that the YARR scans to be used in the analysis should be identified with analysis-load-yarr-scans, see Load Yarr Scans.

analysis-MIN_HEALTH_TEST --help

$ analysis-MIN-HEALTH-TEST -h
Usage: analysis-MIN-HEALTH-TEST [OPTIONS]

Options:
  -i, --input-yarr-config PATH    path to the json config file containing
                                  paths to YARR scan outputs. Run analysis-
                                  load-yarr-scans.py to generate.  [default:
                                  info.json]
  -q, --qc-criteria PATH          path to json file with QC selection criteria
                                  [default: /home/eathompson/module-qc-
                                  analysis-tools/src/module_qc_analysis_tools/
                                  data/analysis_cuts.json]
  -p, --pixel-failure-config PATH
                                  path to json file with pixel failure
                                  selection criteria  [default:
                                  /home/eathompson/module-qc-analysis-tools/sr
                                  c/module_qc_analysis_tools/data/pixel_classi
                                  fication.json]
  -l, --layer TEXT                Layer of module, used for applying correct
                                  QC criteria settings. Options: L0, L1, L2
                                  (default is automatically determined from module SN)
  -o, --output-dir PATH           output directory  [default: outputs]
  --permodule / --no-permodule    Store results in one file per module
                                  (default: one file per chip)  [default: no-
                                  permodule]
  -v, --verbosity [DEBUG|INFO|WARNING|ERROR]
                                  Log level [options: DEBUG, INFO (default)
                                  WARNING, ERROR]  [default: LogLevel.info]

`TUNING`

This analysis script analyzes the tuning performance from YARR scans. It produces an output file with key parameters (threshold before/after tuning, ...). Note that the YARR scans to be used in the analysis should be identified with analysis-load-yarr-scans, see Load Yarr Scans.

analysis-TUNING --help

$ analysis-TUNING -h
Usage: analysis-TUNING [OPTIONS]

Options:
  -i, --input-yarr-config PATH    path to the json config file containing
                                  paths to YARR scan outputs. Run analysis-
                                  load-yarr-scans.py to generate.  [default:
                                  info.json]
  -q, --qc-criteria PATH          path to json file with QC selection criteria
                                  [default: /home/eathompson/module-qc-
                                  analysis-tools/src/module_qc_analysis_tools/
                                  data/analysis_cuts.json]
  -p, --pixel-failure-config PATH
                                  path to json file with pixel failure
                                  selection criteria  [default:
                                  /home/eathompson/module-qc-analysis-tools/sr
                                  c/module_qc_analysis_tools/data/pixel_classi
                                  fication.json]
  -l, --layer TEXT                Layer of module, used for applying correct
                                  QC criteria settings. Options: L0, L1, L2
                                  (default is automatically determined from module SN)
  -o, --output-dir PATH           output directory  [default: outputs]
  --permodule / --no-permodule    Store results in one file per module
                                  (default: one file per chip)  [default: no-
                                  permodule]
  -v, --verbosity [DEBUG|INFO|WARNING|ERROR]
                                  Log level [options: DEBUG, INFO (default)
                                  WARNING, ERROR]  [default: LogLevel.info]

`PIXEL_FAILURE_ANALYSIS`

This analysis script classifies pixel failures and performs the pixel failure analysis. It produces an output file with several key parameters (number of pixels failing each category, total failing pixels, ...). Note that the YARR scans to be used in the analysis should be identified with analysis-load-yarr-scans, see Load Yarr Scans.

analysis-PIXEL-FAILURE-ANALYSIS --help

$ analysis-PIXEL-FAILURE-ANALYSIS -h
Usage: analysis-PIXEL-FAILURE-ANALYSIS [OPTIONS]

Options:
  -i, --input-yarr-config PATH    path to the json config file containing
                                  paths to YARR scan outputs. Run analysis-
                                  load-yarr-scans.py to generate.  [default:
                                  info.json]
  -q, --qc-criteria PATH          path to json file with QC selection criteria
                                  [default: /home/eathompson/module-qc-
                                  analysis-tools/src/module_qc_analysis_tools/
                                  data/analysis_cuts.json]
  -p, --pixel-failure-config PATH
                                  path to json file with pixel failure
                                  selection criteria  [default:
                                  /home/eathompson/module-qc-analysis-tools/sr
                                  c/module_qc_analysis_tools/data/pixel_classi
                                  fication.json]
  -l, --layer TEXT                Layer of module, used for applying correct
                                  QC criteria settings. Options: L0, L1, L2
                                  (default is automatically determined from module SN)
  -o, --output-dir PATH           output directory  [default: outputs]
  --permodule / --no-permodule    Store results in one file per module
                                  (default: one file per chip)  [default: no-
                                  permodule]
  -v, --verbosity [DEBUG|INFO|WARNING|ERROR]
                                  Log level [options: DEBUG, INFO (default)
                                  WARNING, ERROR]  [default: LogLevel.info]

`FLATNESS`

This analysis script performs QC criteria checks on the flatness measurement.

analysis-FLATNESS --help

$ analysis-FLATNESS -h
 Usage: analysis-FLATNESS [OPTIONS]

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --input-meas          -i                     PATH                        path to the input measurement file   │
│                                                                             or directory containing input        │
│                                                                             measurement files.                   │
│                                                                             [default: None]                      │
│                                                                             [required]                           │
│    --output-dir          -o                     PATH                        output directory [default: outputs]  │
│    --qc-criteria         -q                     PATH                        path to json file with QC selection  │
│                                                                             criteria                             │
│                                                                             [default:                            │
│                                                                             /Users/kratsg/module-qc-analysis-to… │
│    --layer               -l                     TEXT                        Layer of module, used for applying   │
│                                                                             correct QC criteria settings.        │
│                                                                             Options: L0, L1, L2 (default is      │
│                                                                             automatically determined from the    │
│                                                                             module SN)                           │
│                                                                             [default: Unknown]                   │
│    ---permodule              --no--permodule                                Store results in one file per module │
│                                                                             (default: one file per chip)         │
│                                                                             [default: no--permodule]             │
│    --site                                       TEXT                        Your testing site. Required when     │
│                                                                             submitting results. Please use same  │
│                                                                             short-hand as on production DB, i.e. │
│                                                                             LBNL_PIXEL_MODULES for LBNL, IRFU    │
│                                                                             for Paris-Saclay, ...                │
│    --fit-method          -f                     [root|numpy]                fitting method                       │
│                                                                             [default: FitMethod.numpy]           │
│    --verbosity           -v                     [DEBUG|INFO|WARNING|ERROR]  Log level [options: DEBUG, INFO      │
│                                                                             (default) WARNING, ERROR]            │
│                                                                             [default: LogLevel.info]             │
│    --install-completion                                                     Install completion for the current   │
│                                                                             shell.                               │
│    --show-completion                                                        Show completion for the current      │
│                                                                             shell, to copy it or customize the   │
│                                                                             installation.                        │
│    --help                -h                                                 Show this message and exit.          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Notes

`Submit QC results`

To submit the QC results, supply the --submit option to the analysis. You also need to supply the site where the testing took place, as written in production DB (i.e. LBNL_PIXEL_MODULES for LBNL, IRFU for Paris-Saclay, ...). This will generate a URL that is printed to the terminal and saved in "submit.txt" in the same folder as the analysis output. To submit the results, you need to copy and paste one URL for each chip / test into a browser. Once submitted, the results can be viewed here: https://docs.google.com/spreadsheets/d/1pw_07F94fg2GJQr8wlvhaRUV63uhsAuBt_S1FEFBzBU/view . While all submitted results will be recorded, only the latest results for each chip / test will be analyzed. If a mistake was realized in the submitted results, one can re-run the analysis and re-submit the results to overwrite the original results.

`Example commands for a chip in a quad module`

analysis-ADC-CALIBRATION -i ../module-qc-tools/emulator/outputs/Measurements/ADC_CALIBRATION/1000000001/
analysis-SLDO -i ../module-qc-tools/emulator/outputs/Measurements/SLDO/1000000001/
analysis-ANALOG-READBACK -i ../module-qc-tools/emulator/outputs/Measurements/ANALOG_READBACK/1000000001/
analysis-VCAL-CALIBRATION -i ../module-qc-tools/emulator/outputs/Measurements/VCAL_CALIBRATION/1000000001/
analysis-INJECTION-CAPACITANCE -i ../module-qc-tools/emulator/outputs/Measurements/INJECTION_CAPACITANCE/1000000001/

`Update Chip Config`

After each analysis, update the settings in the chip config by running:

analysis-update-chip-config -i <path to analysis output directory> -c <path to YARR config directory> -t <config type>

This script reads the analysis test type and update the corresponding parameters in the chip config.

analysis-update-chip-config --help

analysis-update-chip-config -h

-i,  --input-dir                              Analysis output directory [default: None] [required]
-c,  --config-dir                             Path to the module configuration directory to be modified [default: None] [required]
-t,  --config-type                            The config type to be modified. E.g. L2_warm/L2_cold.
     --override/--no-override                 Update chip configuration even if the chip failed QC [default: no-override]
     --install-completion                     Install completion for the current shell.
     --show-completion                        Show completion for the current shell, to copy it or customize the installation.
-h,  --help                                   Show this message and exit.

`Load YARR Scans`

Before running analysis of YARR scans (MIN_HEALTH_TEST, TUNING, PIXEL_FAILURE_ANALYSIS), the YARR scans to be analyzed need to be identified. This is done locally using the following script:

analysis-load-yarr-scans --help

$ analysis-load-yarr-scans -h
Options:
  -o, --output-yarr PATH          output directory to put
                                  info_{TEST_NAME}.json which will be used as
                                  input to YARR scan analysis  [default: ./]
  -m, --moduleSN TEXT             Module serial number  [required]
  -v, --verbosity [DEBUG|INFO|WARNING|ERROR]
                                  Log level [options: DEBUG, INFO (default)
                                  WARNING, ERROR]  [default: LogLevel.info]
  -t, --test-name TEXT            Test name (MIN_HEALTH_TEST, TUNING, or
                                  PIXEL_FAILURE_ANALYSIS)  [required]
  -ds, --digital-scan PATH        path to the digital scan output directory to
                                  use in YARR analysis
  -as, --analog-scan PATH         path to the analog scan output directory to
                                  use in YARR analysis
  -hr, --threshold-scan-hr PATH   path to the threshold scan (high-range)
                                  output directory to use in YARR analysis
  -hd, --threshold-scan-hd PATH   path to the threshold scan (high-def) output
                                  directory to use in YARR analysis
  -ns, --noise-scan PATH          path to the noise scan output directory to
                                  use in YARR analysis
  -zb, --zerobias PATH            path to the threshold scan (high-def, zero-
                                  bias) output directory to use in YARR
                                  analysis
  -db, --discbump PATH            path to the disconnected bump scan output
                                  directory to use in YARR analysis

Given a directory with YARR scans, the script will identify the latest YARR scans needed for all analyses. Alternatively, the paths to YARR scans for each type of scan can be supplied to the script.

For Developer

python version

A python version higher than 3.7 is needed for this repository. Check the local python version with python -V.

If the local python version is lower, set up a virtual python environment following the instructions here.

versioning

In case you need to tag the version of the code, you need to have either hatch or pipx installed.

Activate python environment, e.g. source venv/bin/activate.
Run python -m pip install hatch or python -m pip install pipx.

You can bump the version via:

pipx run hatch run tag x.y.z

# or

hatch run tag x.y.z

where x.y.z is the new version to use. This should be run from the default branch (main / master) as this will create a commit and tag, and push for you. So make sure you have the ability to push directly to the default branch.

pre-commit

Install pre-commit to avoid CI failure. Once pre-commit is installed, a git hook script will be run to identify simple issues before submission to code review.

Instruction for installing pre-commit in a python environment:

Activate python environment, e.g. source venv/bin/activate.
Run python3 -m pip install pre-commit.
Run pre-commit install to install the hooks in .pre-commit-config.yaml.

After installing pre-commit, .pre-commit-config.yaml will be run every time git commit is done. Redo git add and git commit, if the pre-commit script changes any files.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

2.2.9rc4 pre-release

Nov 11, 2024

2.2.9rc3 pre-release

Nov 7, 2024

2.2.9rc2 pre-release

Oct 29, 2024

2.2.9rc1 pre-release

Oct 21, 2024

2.2.8

Oct 15, 2024

2.2.7

Aug 28, 2024

2.2.7rc1 pre-release

Aug 15, 2024

2.2.6

Jul 13, 2024

2.2.5rc5 pre-release

Jul 12, 2024

This version

2.2.5rc4 pre-release

Jul 12, 2024

2.2.5rc3 pre-release

Jul 11, 2024

2.2.5rc2 pre-release

Jul 11, 2024

2.2.5rc1 pre-release

Jun 10, 2024

2.2.5rc0 pre-release

May 30, 2024

2.2.4

Apr 11, 2024

2.2.4rc1 pre-release

Apr 5, 2024

2.2.3

Mar 25, 2024

2.2.3rc5 pre-release

Mar 25, 2024

2.2.3rc4 pre-release

Mar 7, 2024

2.2.3rc3 pre-release

Mar 6, 2024

2.2.3rc2 pre-release

Feb 15, 2024

2.2.3rc1 pre-release

Feb 14, 2024

2.2.3rc0 pre-release

Jan 11, 2024

2.2.2

Dec 7, 2023

2.2.2rc4 pre-release

Mar 7, 2024

2.2.2rc3 pre-release

Dec 7, 2023

2.2.2rc2 pre-release

Dec 6, 2023

2.2.2rc1 pre-release

Dec 6, 2023

2.2.2rc0 pre-release

Nov 21, 2023

2.2.1

Nov 21, 2023

2.2.0

Nov 15, 2023

2.1.1

Oct 25, 2023

2.1.0

Oct 19, 2023

2.1.0rc5 pre-release

Oct 18, 2023

2.1.0rc4 pre-release

Oct 16, 2023

2.1.0rc3 pre-release

Oct 10, 2023

2.1.0rc1 pre-release

Oct 3, 2023

2.0.5

Sep 26, 2023

2.0.4

Aug 31, 2023

2.0.3

Aug 28, 2023

2.0.2

Aug 25, 2023

2.0.1

Jun 6, 2023

2.0.1rc1 pre-release

Jun 29, 2023

2.0.0

May 23, 2023

1.3.1rc8 pre-release

May 16, 2023

1.3.1rc7 pre-release

May 9, 2023

1.3.1rc6 pre-release

May 5, 2023

1.3.1rc5 pre-release

May 3, 2023

1.3.1rc4 pre-release

May 1, 2023

1.3.1rc3 pre-release

Apr 26, 2023

1.3.1rc2 pre-release

Apr 21, 2023

1.3.1rc1 pre-release

Apr 20, 2023

1.3.0

Mar 23, 2023

1.2.0

Mar 10, 2023

1.2.0rc2 pre-release

Mar 8, 2023

1.2.0rc1 pre-release

Feb 28, 2023

1.1.0

Feb 17, 2023

1.0

Jan 26, 2023

0.0.1

Dec 6, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

module_qc_analysis_tools-2.2.5rc4.tar.gz (73.0 MB view details)

Uploaded Jul 12, 2024 Source

Built Distribution

module_qc_analysis_tools-2.2.5rc4-py3-none-any.whl (74.6 MB view details)

Uploaded Jul 12, 2024 Python 3

File details

Details for the file module_qc_analysis_tools-2.2.5rc4.tar.gz.

File metadata

Download URL: module_qc_analysis_tools-2.2.5rc4.tar.gz
Upload date: Jul 12, 2024
Size: 73.0 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.1.1 CPython/3.11.4

File hashes

Hashes for module_qc_analysis_tools-2.2.5rc4.tar.gz
Algorithm	Hash digest
SHA256	`2569e18e3ca77b0db74c89a8b778a4a614d6af697713ec72fa34fa86db2013b5`
MD5	`a0b11d1208dc56b1b4b4fb05821571ea`
BLAKE2b-256	`a4ade88f043db9ef6e2b7c1167fc13937aba522841981c606477d7b2c63de8fc`

See more details on using hashes here.

File details

Details for the file module_qc_analysis_tools-2.2.5rc4-py3-none-any.whl.

File metadata

Download URL: module_qc_analysis_tools-2.2.5rc4-py3-none-any.whl
Upload date: Jul 12, 2024
Size: 74.6 MB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.1.1 CPython/3.11.4

File hashes

Hashes for module_qc_analysis_tools-2.2.5rc4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`ac457d014300488e972349cf1012f4c4f0dba29f2a6dcaa41e97210e28d42b8b`
MD5	`b8ec82e7fb9352a7875709feedab7159`
BLAKE2b-256	`56eab083d998adad4c8221072e0ab4ba6f1005380c243342b526b82a700412c8`

See more details on using hashes here.

module-qc-analysis-tools 2.2.5rc4

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

module-qc-analysis-tools v2.2.5rc4

Table of contents

Requirements

Installation

via clone

via pip

Scripts

Sensor IV Measurement

ADC_CALIBRATION

ANALOG_READBACK

SLDO

VCAL_CALIBRATION

INJECTION_CAPACITANCE

LP_MODE

OVERVOLTAGE_PROTECTION

UNDERSHUNT_PROTECTION

DATA_TRANSMISSION

MIN_HEALTH_TEST

TUNING

PIXEL_FAILURE_ANALYSIS

FLATNESS

Notes

Submit QC results

Example commands for a chip in a quad module

Update Chip Config

Load YARR Scans

For Developer

python version

versioning

pre-commit

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes

`Sensor IV Measurement`

`ADC_CALIBRATION`

`ANALOG_READBACK`

`SLDO`

`VCAL_CALIBRATION`

`INJECTION_CAPACITANCE`

`LP_MODE`

`OVERVOLTAGE_PROTECTION`

`UNDERSHUNT_PROTECTION`

`DATA_TRANSMISSION`

`MIN_HEALTH_TEST`

`TUNING`

`PIXEL_FAILURE_ANALYSIS`

`FLATNESS`

`Submit QC results`

`Example commands for a chip in a quad module`

`Update Chip Config`

`Load YARR Scans`