Skip to content

sort out debug folder

Menglin Xu requested to merge mexu_debug_folder into master

close #66 (closed)

Background: debug folder that contains many component debug files, which are mostly used by developers to view and run checks on small parts of the geometry locally

Motivation: we have many such folders in the compact like run3 version 2024, trunk version... They are almost all duplicates, and we have to do a lot of repetitive maintenance work ands

Main changes

  • after checking with @hawu, *_eve.xml are not needed, so I have removed them from the debug folder
  • remove the various existing debug folders but consolidated into a single folder
  • no longer use the path.xml file to control the version to be tested. Instead, the version is defined directly within each debug file
  • the debulg files have been renamed, such as renaming UT_debug.xml to UT.xml as the directory name already indicates that it is for debuggin
  • have added a template.xml that includes comments explaining why each of the common files needs to be included and clarifies any subtleties (such as the hardcoded materials path)

Conclusion

All subdetectors can check the trunk version geometry with a command like ./build.x86_64_v2-el9-gcc12-opt/bin/run geoDisplay compact/components/debug/UT.xml

To check different versions, there are two options:

  1. you can simply modify the version in the xml locally, like changing ../UT/trunk/UT.xml to ../UT/2024-v00.00/UT.xml in debug/UT.xml
  2. some groups may perfer creating a folder under the debug directory and place additional/released versions (aside from trunk, trunk are always placed at debug/UT.xml) there, as what we have done for Rich1 and Rich2, compact/components/debug/Rich1/2024-v00.00.xml. In that case the 2024-v00.00 version can be displayed by ./build.x86_64_v2-el9-gcc12-opt/bin/run geoDisplay compact/components/debug/Rich1/2024-v00.00.xml.

Moreover, for run5, there are several versions are being developed at the same time like TV has two versions, baseline and low. In such cases, we place the baseline version at debug/TV.xml and keep another ongoing version at TV/branch-run5-low.xml. Please note we only have created an additional folder for TV for now as it is the only subdetector in run5 with with two different versions in the master branch.

These changes do not real touch any geometry, just centralize the debug tool

Validated by

  • Core Software
  • RTA
  • Simulation
Edited by Menglin Xu

Merge request reports