osbornjd / qa-gallery

Plotting macro and result gallery for standardized QA plots

QA-gallery

Plotting macro and result gallery for standardized QA plots

QA branches

The main branch carries common macros and utilities. And each QA plot setup is placed in their individual branches:

• QA-calorimeter-single-particle branch : Full detector Calorimeter QA for single particles, designed to plot QA file from https://github.com/sPHENIX-Collaboration/macros/tree/QA-calorimeter-single-particle/detectors/sPHENIX
• QA-tracking-low-occupancy branch : Tracking QA for low occupancy, designed to plot QA file from https://github.com/sPHENIX-Collaboration/macros/tree/QA-tracking-low-occupancy/detectors/sPHENIX
• QA-tracking-high-occupancy branch : Tracking QA for high occupancy, designed to plot QA file from https://github.com/sPHENIX-Collaboration/macros/tree/QA-tracking-high-occupancy/detectors/sPHENIX

The plotting branches are automatically synced with the main branch via GitHub actions.

Result plots

The result by running these QA notebooks are archived by tags. Please find a list of recent runs at https://github.com/sPHENIX-Collaboration/QA-gallery/tags

Developper's guide

For base script and QA_Draw_Utility.C, please edit in the main branch. Then it will be automatically sync to other plotting branches via GitHub Actions

In the plotting branches, the plotting macros plot the default QA ROOT file via the sPHENIX Jupyter Lab environment. Both source code, documentation and result plots are saved in the Jupyter Notebook formats, such as QA-calorimeter.ipynb and they can be best viewed via the nbviewer site (example)

To edit the notebook,

1. Please checkout the plotting branches
2. Generate or download the QA ROOT file from a recent QA runs, e.g. Calorimeter QA jobs
3. Edit/execute in either with following environements:

• sPHENIX JupyterLab via SDCC HTC Jupyter Hub, which provides both latest software and computing power. Here is an introduction: https://github.com/sPHENIX-Collaboration/tutorials/tree/master/JupyterLab

• sPHENIX JupyterLab runs locally on your local computer via sPHENIX Singularity container. Please setup the container, source sPHENIX setup, and run setup.sh to start the sPHENIX JupyterLab webserver interface.

4. Last step, before making a pull request, please execute the "Edit/clear all output" command in JupyterLab. It will clear out output and all for a clean git diff for the pull request