DUNE HWDB Training

Getting Started

First step: follow the directions in the “Setup” to arrived prepared for this event. Follow the instruction there to obtain your FNAL tokens, which you will need to communicate with the REST API of the HWDB.

Then follow along with the training, which is based on the 2nd HWDB tutorials held in 2024 (incido). Slides shown there and videos of each sessions are also available here. Links to to earlier tutorials on the HWDB, in case if you are interested in: Tutorial I (May 2022) and Tutorial II (May 2022).

The complete online HWDB documentations

All REST API endpoints that are described in this training site are based on the online DUNE HWDB documentation, generated by Redoc. We do not cover the entire endpoints described in the online documentation. It is great idea to visit there and go through them.

Also the online DUNE HWDB documentation gets generated based on the Swagger site, which allows you to execute those REST API endpoints online interactively. We encourage users to exercise these two sites often.

Questions, Requests, and the Liaisons

Any question/comments, including requests of examples to be added as training materials, should be directed to the liaison of your consortium (click the button below) as well as the followings: Norm Buchanan, Ana Paula, and Hajime Muramatsu. For issues of the HWDB itself, also inform here.

× Responsible Institutions

Consortium	Liaison
ND LAr	Leon Mualem
FD1 APA	Brian Rebel and Krishan Majumdar
FD1 PDS	Gustavo Valdiviesso
FD2 PDS	Mike Eads
FD1 TPC Electronics	Martin Tzanov
FD2 BDE	Martin Tzanov
FD2 CRP (Top)	Jean-François Muraz
FD2 CRP (Bottom)	Steven Linden
FD2 TDE	Vyacheslav Galymov
FD DAQ	Roland Sipos
FD1 HV	Steve Magill and Aleena Rafique
FD2 HV	Steve Magill and Aleena Rafique
Calibration Hardware	David Rivera and Jordi Capó
Installation	Jim Stewart
DUNE QA Specialist	James Mateyack
FD Cryostat	Benjamin Fossing

Quick links

If you like to skip all basics and jump into more useful stuff, here are some quick links.

HWDB Dashboard : Provides filtered data from the HWDB visually.

DUNE Shipping Procedure and Shipping handoff process : Each steps of shipping stuff to either the SD Warehouse/SURF or non-SURF places.

DUNE bar/QR-codes : Generate many DUNE bar/QR-code labels at ease!

Pratical usage of the HWDB : Type/PID hierarchies, filtering data, storing data without a specific DB schema!?

Training schedule

(The quoted time for each session is amount of the estimated time that would take you to go through that session)

	Setup	Get ready for the training.
09:00	1. Introduction to DUNE HWDB Training site	No privilage is required. What is this website?
09:00	2. HWDB Conceptual Overview and the DUNE PID	No privilage is required. What is the HWDB? What are its essential components? The defintion of the DUNE Parts Identifier (PID)
09:30	3. Setting up Component Types and Test Types	Administrator privilage is required. How do I define a Component Type and a Test Type with the WEB UI? How about through the REST API?
10:30	4. Data Management using WEB UI	Active user privilage is required. How do I enter and retrieve Items with the WEB UI? How do I perform searches over Items/Tests with the WEB UI?
11:30	5. Data Management using REST API	Active user privilage is required. How do I enter and retrieve Items with the REST API? How do I perform searches over Items/Tests with the REST API?
12:30	6. Using the iPad App	Active user privilage is required. How do I go/down through PID hieratchy, scan QR codes, and post Locations via iPad?
13:00	7. Using the Python HWDB Upload Tool	Active user privilage is required. How does one upload bulk data with the Python HWDB Upload Tool?
15:00	8. Inserting Component Types	Architect privilage is required. How do I newly create Components (only available with the WEB UI)?
15:30	Finish