From c696f1d44a99c6b935270b23491559311b268c00 Mon Sep 17 00:00:00 2001
From: Christopher Dilks <christopher.j.dilks@gmail.com>
Date: Wed, 1 Mar 2023 11:21:28 -0500
Subject: [PATCH] refactor: rename `OpticalTracker` example to `RICH`
---
examples/CMakeLists.txt | 2 +-
examples/{OpticalTracker => RICH}/.gitignore | 0
.../{OpticalTracker => RICH}/CMakeLists.txt | 40 +++++++++---------
examples/{OpticalTracker => RICH}/README.md | 10 ++---
.../compact/materials.xml | 0
.../compact/pfrich.xml | 0
.../{OpticalTracker => RICH}/doc/geometry.png | Bin
.../scripts/richsim.py | 2 +-
.../scripts/test_energy_deposition.C | 0
.../scripts/test_number_of_hits.C | 0
.../src/PFRICH_geo.cpp | 0
11 files changed, 27 insertions(+), 27 deletions(-)
rename examples/{OpticalTracker => RICH}/.gitignore (100%)
rename examples/{OpticalTracker => RICH}/CMakeLists.txt (53%)
rename examples/{OpticalTracker => RICH}/README.md (83%)
rename examples/{OpticalTracker => RICH}/compact/materials.xml (100%)
rename examples/{OpticalTracker => RICH}/compact/pfrich.xml (100%)
rename examples/{OpticalTracker => RICH}/doc/geometry.png (100%)
rename examples/{OpticalTracker => RICH}/scripts/richsim.py (97%)
rename examples/{OpticalTracker => RICH}/scripts/test_energy_deposition.C (100%)
rename examples/{OpticalTracker => RICH}/scripts/test_number_of_hits.C (100%)
rename examples/{OpticalTracker => RICH}/src/PFRICH_geo.cpp (100%)
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
index 1f4b7b2be..070d7e95c 100644
--- a/examples/CMakeLists.txt
+++ b/examples/CMakeLists.txt
@@ -42,7 +42,7 @@ dd4hep_configure_output()
#==========================================================================
-SET(DD4HEP_EXAMPLES "AlignDet CLICSiD ClientTests Conditions DDCMS DDCodex DDDigi DDG4 DDG4_MySensDet LHeD OpticalSurfaces OpticalTracker Persistency DDCAD SimpleDetector"
+SET(DD4HEP_EXAMPLES "AlignDet CLICSiD ClientTests Conditions DDCMS DDCodex DDDigi DDG4 DDG4_MySensDet LHeD OpticalSurfaces RICH Persistency DDCAD SimpleDetector"
CACHE STRING "List of DD4hep Examples to build")
SEPARATE_ARGUMENTS(DD4HEP_EXAMPLES)
diff --git a/examples/OpticalTracker/.gitignore b/examples/RICH/.gitignore
similarity index 100%
rename from examples/OpticalTracker/.gitignore
rename to examples/RICH/.gitignore
diff --git a/examples/OpticalTracker/CMakeLists.txt b/examples/RICH/CMakeLists.txt
similarity index 53%
rename from examples/OpticalTracker/CMakeLists.txt
rename to examples/RICH/CMakeLists.txt
index 4a3cb5f3b..1690e5aae 100644
--- a/examples/OpticalTracker/CMakeLists.txt
+++ b/examples/RICH/CMakeLists.txt
@@ -21,49 +21,49 @@ dd4hep_set_compiler_flags()
dd4hep_use_python_executable()
#==========================================================================
-dd4hep_print("|++> OpticalTracker: ROOT version: ${ROOT_VERSION}")
+dd4hep_print("|++> RICH: ROOT version: ${ROOT_VERSION}")
if(NOT ${ROOT_VERSION} VERSION_GREATER_EQUAL 6.18.00)
- dd4hep_print("|++> Not building OpticalTracker test")
+ dd4hep_print("|++> Not building RICH test")
return()
endif()
-dd4hep_print("|++> Building OpticalTracker test")
+dd4hep_print("|++> Building RICH test")
#--------------------------------------------------------------------------
dd4hep_configure_output()
-set(OpticalTracker_INSTALL ${CMAKE_INSTALL_PREFIX}/examples/OpticalTracker)
-dd4hep_add_plugin(OpticalTrackerExample SOURCES src/*.cpp
+set(RICH_INSTALL ${CMAKE_INSTALL_PREFIX}/examples/RICH)
+dd4hep_add_plugin(RICHExample SOURCES src/*.cpp
USES DD4hep::DDCore DD4hep::DDRec DD4hep::DDCond ROOT::Core ROOT::Geom ROOT::GenVector ROOT::MathCore)
-install(TARGETS OpticalTrackerExample LIBRARY DESTINATION lib)
-install(DIRECTORY compact scripts DESTINATION ${OpticalTracker_INSTALL} )
-dd4hep_configure_scripts( OpticalTracker DEFAULT_SETUP WITH_TESTS)
+install(TARGETS RICHExample LIBRARY DESTINATION lib)
+install(DIRECTORY compact scripts DESTINATION ${RICH_INSTALL} )
+dd4hep_configure_scripts( RICH DEFAULT_SETUP WITH_TESTS)
# ---Test: run simulation
-dd4hep_add_test_reg( OpticalTracker_simulation
- COMMAND "${CMAKE_INSTALL_PREFIX}/bin/run_test_OpticalTracker.sh"
- EXEC_ARGS ${Python_EXECUTABLE} ${OpticalTracker_INSTALL}/scripts/richsim.py
- --outputFile "${OpticalTracker_INSTALL}/sim.root"
+dd4hep_add_test_reg( RICH_simulation
+ COMMAND "${CMAKE_INSTALL_PREFIX}/bin/run_test_RICH.sh"
+ EXEC_ARGS ${Python_EXECUTABLE} ${RICH_INSTALL}/scripts/richsim.py
+ --outputFile "${RICH_INSTALL}/sim.root"
REGEX_PASS "TEST: passed"
REGEX_FAIL " Exception; EXCEPTION;ERROR;Error;FATAL"
)
# ---Test: Number of raw photon hits
-dd4hep_add_test_reg( OpticalTracker_number_of_hits
- COMMAND "${CMAKE_INSTALL_PREFIX}/bin/run_test_OpticalTracker.sh"
+dd4hep_add_test_reg( RICH_number_of_hits
+ COMMAND "${CMAKE_INSTALL_PREFIX}/bin/run_test_RICH.sh"
EXEC_ARGS root.exe -b -x -n -q -l
- "${OpticalTracker_INSTALL}/scripts/test_number_of_hits.C(\"${OpticalTracker_INSTALL}/sim.root\")"
+ "${RICH_INSTALL}/scripts/test_number_of_hits.C(\"${RICH_INSTALL}/sim.root\")"
REGEX_PASS "TEST: passed"
REGEX_FAIL "TEST: failed"
- DEPENDS OpticalTracker_simulation
+ DEPENDS RICH_simulation
)
# ---Test: Energy deposition
-dd4hep_add_test_reg( OpticalTracker_energy_deposition
- COMMAND "${CMAKE_INSTALL_PREFIX}/bin/run_test_OpticalTracker.sh"
+dd4hep_add_test_reg( RICH_energy_deposition
+ COMMAND "${CMAKE_INSTALL_PREFIX}/bin/run_test_RICH.sh"
EXEC_ARGS root.exe -b -x -n -q -l
- "${OpticalTracker_INSTALL}/scripts/test_energy_deposition.C(\"${OpticalTracker_INSTALL}/sim.root\")"
+ "${RICH_INSTALL}/scripts/test_energy_deposition.C(\"${RICH_INSTALL}/sim.root\")"
REGEX_PASS "TEST: passed"
REGEX_FAIL "TEST: failed"
- DEPENDS OpticalTracker_simulation
+ DEPENDS RICH_simulation
)
diff --git a/examples/OpticalTracker/README.md b/examples/RICH/README.md
similarity index 83%
rename from examples/OpticalTracker/README.md
rename to examples/RICH/README.md
index c07b25ab5..e7fae314e 100644
--- a/examples/OpticalTracker/README.md
+++ b/examples/RICH/README.md
@@ -3,7 +3,7 @@ Proximity Focusing RICH
Example RICH demonstrating `Geant4OpticalTracker` Sensitive Detector plugin usage.
-This detector design has been pulled from [EPIC](https://github.com/eic/epic), and was originally developed in
+This detector design has been pulled from [ePIC](https://github.com/eic/epic), and was originally developed in
[ATHENA](https://eicweb.phy.anl.gov/EIC/detectors/athena), for the Electron-Ion Collider.
@@ -16,14 +16,14 @@ To use `ctest`, run:
cd .. # `pwd` should now be `DD4hep/examples`
mkdir build
cd build
-cmake -DDD4HEP_EXAMPLES="OpticalTracker" .. && make && make install
+cmake -DDD4HEP_EXAMPLES="RICH" .. && make && make install
ctest --output-on-failure # or use `--verbose` to see all output
```
## Local Development
If you want to run this example standalone, without needing to run `ctest`,
make a standalone build. The following assumes that your current working
-directory is `DD4hep/examples/OpticalTracker`.
+directory is `DD4hep/examples/RICH`.
Build with `cmake`, for example:
```bash
@@ -33,8 +33,8 @@ cmake --build build -- install
Run a test simulation:
```bash
-install/bin/run_test_OpticalTracker.sh \
- python install/examples/OpticalTracker/scripts/richsim.py
+install/bin/run_test_RICH.sh \
+ python install/examples/RICH/scripts/richsim.py
```
- See default settings in `scripts/richsim.py`
- Override these settings, or add additional settings by appending `ddsim` options
diff --git a/examples/OpticalTracker/compact/materials.xml b/examples/RICH/compact/materials.xml
similarity index 100%
rename from examples/OpticalTracker/compact/materials.xml
rename to examples/RICH/compact/materials.xml
diff --git a/examples/OpticalTracker/compact/pfrich.xml b/examples/RICH/compact/pfrich.xml
similarity index 100%
rename from examples/OpticalTracker/compact/pfrich.xml
rename to examples/RICH/compact/pfrich.xml
diff --git a/examples/OpticalTracker/doc/geometry.png b/examples/RICH/doc/geometry.png
similarity index 100%
rename from examples/OpticalTracker/doc/geometry.png
rename to examples/RICH/doc/geometry.png
diff --git a/examples/OpticalTracker/scripts/richsim.py b/examples/RICH/scripts/richsim.py
similarity index 97%
rename from examples/OpticalTracker/scripts/richsim.py
rename to examples/RICH/scripts/richsim.py
index 3eaefd0a4..2dca44a7c 100755
--- a/examples/OpticalTracker/scripts/richsim.py
+++ b/examples/RICH/scripts/richsim.py
@@ -73,7 +73,7 @@ if __name__ == "__main__":
# Installed compact file, otherwise assume the user passed `--compactFile`
install_prefix = os.environ.get("DD4hepExamplesINSTALL")
if install_prefix:
- SIM.compactFile = install_prefix + "/examples/OpticalTracker/compact/pfrich.xml"
+ SIM.compactFile = install_prefix + "/examples/RICH/compact/pfrich.xml"
# Output file (assuming CWD)
SIM.outputFile = "sim.root"
diff --git a/examples/OpticalTracker/scripts/test_energy_deposition.C b/examples/RICH/scripts/test_energy_deposition.C
similarity index 100%
rename from examples/OpticalTracker/scripts/test_energy_deposition.C
rename to examples/RICH/scripts/test_energy_deposition.C
diff --git a/examples/OpticalTracker/scripts/test_number_of_hits.C b/examples/RICH/scripts/test_number_of_hits.C
similarity index 100%
rename from examples/OpticalTracker/scripts/test_number_of_hits.C
rename to examples/RICH/scripts/test_number_of_hits.C
diff --git a/examples/OpticalTracker/src/PFRICH_geo.cpp b/examples/RICH/src/PFRICH_geo.cpp
similarity index 100%
rename from examples/OpticalTracker/src/PFRICH_geo.cpp
rename to examples/RICH/src/PFRICH_geo.cpp
--
GitLab