This lesson is being piloted (Beta version)

DUNE HWDB Training



The 2nd HWDB tutorials

The 2nd HWDB tutorials was held as a two-day workshop on consecutive Mondays, July 15, 2024, and July 22, 2024.

A two day schedule with lesson links is provided as HWDB Tutorials.

The Indico Site for this training is https://indico.fnal.gov/event/65297/.

Links to to an earlier tutorial on the HWDB:



Getting Started

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

By the end of this training, participants will know how to:



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.



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?
14:00 8. Inserting Component Types Architect privilage is required.
How do I newly create Components (only available with the WEB UI)?
14:30 Finish