Skip to content

Reporting

The ITk Production Database (PDB) holds all the ITk production information. Data can be extracted via scripts using the itkdb python package or directly via API requests (see API documentation).

ITk reporting tools exist to help retrieve sub-sets of PDB information for specific tasks using pre-defined or tunable scripts. Here, several tools are documented. If there is no reporting tool to fit your reporting task then please contact: Reporting egroup

This page lists reports in three types:

  • On Demand Reports: data is compiled immediately at the user's request
  • Scheduled Reporting: cronned pre-made scripts to produce sharable dashboards
  • Alerts: reporting with identification of "out-of-spec" values

General Comments

Reports are generally written in Python and make use of itkdb package to query PDB.

Generally useful code and documenation for developing reports can be found in the Reportorium.

On Demand Reports

On demand reports request and compile data from PDB at the user's request.

Scripts are pre-prepared in notebook and webApp format. These can be run as they are or used as template for further development.

ITk Reports Scripts & Notebooks

The ITk-reports repository contains several example notebooks for reporting:

  • Component Type Dashboards: what, where, stage, meta-data
  • Test Type Dashboards: where, when, data
  • Institution Inventory Dashboards: what, stage, meta-data

Documentation and tutorial examples is available here

Reporting WebApps

A dedicated reporting webApp contians a couple of themes for general reporting here

Functionality includes:

Population App

Retrieved information:

  • PDB Stats: overall stats for database
  • PDB Objects: number of stages and testTypes per componentType
  • Project Pops: populations per componentType/testType
  • Inventories: populations per Institution
  • Plot Shipments: visualise component travels
  • Plot Param: plot component/test parameter

Reporting App

“an overview of components at institute and country level with options to select a smaller number of countries or a single institute”

Retrieved information:

  • Summary Tables
  • Summary Plots
  • Detailed Tables
  • Detailed Plots

Originally intended for Pixels monitoring components at clusters/instutions on-demand.

WebApp Interface

WebApp to run ITk-reports style dashboards on demand.

Intended to ease interface with the general reporting codebase for common report types, e.g. testType dashboard to check upload test data, componentType dashboard to check component sub-type, stages, etc.

Scheduled Reporting

Pre-written scripts with running frequently.

Various ITk reporting tools exist to help retrieve sub-sets of PDB information for specific tasks using pre-defined or tunable scripts.

ITk PDB Reporting Hub

This is a common repository for listing scheduled reports by WBS structure. The repository aims to provide a single landing page to find existing reports.

List of Reporting Tools

(Totally not complete)

Pixels

pixel modules git repository

Strips

strips webApp

General

reporting webApp

Alerts

Alerts involve reporting on PDB data with some identification of exceptional values.

Alerting in ITk-reports

Alert functionality:

  • identify exceptional data points
  • collate exceptional values and associated data
  • email responsible person(s)

identify exceptional data points

Values can be identified as exceptional as follows:

  • Multiples of sigma, i.e. make use of statistical information
  • Range max & min, e.g. from specification documents
  • Exact matching, i.e. alert if equal
  • Non-matching, i.e. alert if not equal

collate exceptional values and associated meta-data

An Alerts tab is added to testType Dashboard report with a table of exceptional values for each parameter (NB components may appear in multiple tables).

The tables include: tested component serialNumber, upload institution of test, stage of test, parameter code & value, reason identified as exceptional

email responsible person(s)

The recipient receives an email with the report summary (number of exeptions per parameter) and a link to full report dashboard.

Set-up an alert

Please contact Kenny with:

  • PDB testType
  • Exception definitions (per parameter)
  • Contact email

---

Unmaintained

Production Population Timelines webApp

WebApp to monitor trends in component production over clusteers/institutions.