Implement Celeritas-DD4hep integration plugin

.github/workflows/check-dd4hep-integration.yml

@@ -0,0 +1,73 @@
+name: Check dd4hep integration
+
+on:
+  workflow_dispatch:
+  workflow_call:
+  push:
+    branches:
+      - feature-dd4hep-integration-plugin
+
+concurrency:
+  group: build-${{github.ref}}-${{github.event.pull_request.number || github.run_number}}-${{github.workflow}}
+  cancel-in-progress: true
+
+jobs:
+  check-dd4hep-integration:
+    container: ghcr.io/eic/eic_ci:nightly
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Build and test dd4hep integration
+        shell: bash
+        run: |
+          set +e 
+          set -o pipefail
+          source /etc/profile
+          eic-info
+          cmake -DCELERITAS_USE_DD4hep=ON -DCMAKE_INSTALL_PREFIX=install -S . -B build
+          cmake --build build -j 8
+          cmake --install build
+          export LD_LIBRARY_PATH=$PWD/install/lib:${LD_LIBRARY_PATH}
+
+          # Run both simulations in parallel with separate log files
+          echo "Starting Celeritas simulation..."
+          ddsim --compactFile=$PWD/example/ddceler/SiD_ConstantField.xml --steering $PWD/example/ddceler/steeringFile.py --outputFile output_celeritas.root --geometry.dumpGDML SiD_ConstantField.gdml > celeritas.log 2>&1 &
+          CELER_PID=$!
+
+          echo "Starting Geant4 simulation..."
+          CELER_DISABLE=1 ddsim --compactFile=$PWD/example/ddceler/SiD_ConstantField.xml --steering $PWD/example/ddceler/steeringFile.py --outputFile output_geant4.root > geant4.log 2>&1 &
+          GEANT4_PID=$!
+
+          # Wait for both to complete
+          wait $CELER_PID || CELER_EXIT=$?
+          wait $GEANT4_PID || GEANT4_EXIT=$?
+
+          # Display logs
+          echo "=== Celeritas Log ==="
+          cat celeritas.log
+          echo "=== Geant4 Log ==="
+          cat geant4.log
+
+          # Check exit codes
+          if [ "${CELER_EXIT:-0}" -ne 0 ] || [ "${GEANT4_EXIT:-0}" -ne 0 ]; then
+            echo "Error: One or more simulations failed"
+            exit 1
+          fi
+
+          # Compare benchmarks and generate plots
+          if [ -f output_geant4.root ] && [ -f output_celeritas.root ]; then
+            root -l -b -q "${PWD}/example/ddceler/compare_benchmarks.cc(\"output_geant4.root\", \"output_celeritas.root\")"
+          else
+            echo "Error: Output files not found"
+            exit 1
+          fi
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: simulation-artifacts
+          path: |
+            *.log
+            *.png
+            *.gdml
+

CMakeLists.txt

@@ -38,6 +38,7 @@ celeritas_optional_package(PNG "Enable PNG output with libpng")
 celeritas_optional_package(Python "Use Python for documentation and testing")
 celeritas_optional_package(ROOT "Enable ROOT I/O")
 celeritas_optional_package(VecGeom "Use VecGeom geometry")
+celeritas_optional_package(DD4hep "Enable DD4hep integration")
 option(CELERITAS_USE_Perfetto "Perfetto tracing library" OFF)
 
 # Components
@@ -364,6 +365,14 @@ if(CELERITAS_USE_Geant4 AND NOT Geant4_FOUND)
   endif()
 endif()
 
+if(CELERITAS_USE_DD4hep)
+  if(NOT DD4hep_FOUND)
+    find_package(DD4hep 1.18 REQUIRED COMPONENTS DDCore DDG4)
+    include(${DD4hep_DIR}/cmake/DD4hep.cmake)
+    include(${DD4hep_DIR}/cmake/DD4hepBuild.cmake)
+  endif()
+endif()
+
 if(CELERITAS_USE_HepMC3)
   if(NOT HepMC3_FOUND)
     find_package(HepMC3 REQUIRED)

CMakePresets.json

@@ -29,7 +29,8 @@
         "CELERITAS_USE_MPI":     {"type": "BOOL", "value": "ON"},
         "CELERITAS_USE_PNG":     {"type": "BOOL", "value": "ON"},
         "CELERITAS_USE_ROOT":    {"type": "BOOL", "value": "ON"},
-        "CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "ON"}
+        "CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "ON"},
+        "CELERITAS_USE_DD4hep":  {"type": "BOOL", "value": "OFF"}
       }
     },
     {
@@ -47,6 +48,7 @@
         "CELERITAS_USE_PNG":     {"type": "BOOL", "value": "OFF"},
         "CELERITAS_USE_ROOT":    {"type": "BOOL", "value": "OFF"},
         "CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "OFF"},
+        "CELERITAS_USE_DD4hep":  {"type": "BOOL", "value": "OFF"},
         "CELERITAS_USE_covfie":  {"type": "BOOL", "value": "OFF"}
       }
     },

cmake/CeleritasConfig.cmake.in

@@ -163,6 +163,10 @@ if(CELERITAS_USE_VecGeom)
   endif()
 endif()
 
+if(CELERITAS_USE_DD4hep)
+  find_dependency(DD4hep REQUIRED)
+endif()
+
 cmake_policy(POP)
 
 #-----------------------------------------------------------------------------#

example/ddceler/SiD_ConstantField.xml

@@ -0,0 +1,71 @@
+<!-- Derived from https://github.com/AIDASoft/DD4hep/blob/master/DDDetectors/compact/SiD.xml -->
+<!-- Copyright Celeritas contributors: see top-level COPYRIGHT file for details -->
+<!-- SPDX-License-Identifier: (Apache-2.0 OR MIT) -->
+<lccdd>
+  <comment>
+    Using a constant field in the DD4hep example SiD detector description
+  </comment>
+
+  <includes>
+    <gdmlFile  ref="${DD4hepINSTALL}/DDDetectors/compact/elements.xml"/>
+    <gdmlFile  ref="${DD4hepINSTALL}/DDDetectors/compact/materials.xml"/>
+  </includes>
+
+  <define>
+    <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiDConstants.xml"/>
+  </define>
+
+
+  <limits>
+    <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD_Limits.xml"/>
+  </limits>
+
+  <regions>
+    <region name="SiTrackerBarrelRegion" eunit="MeV" lunit="mm" cut="0.001" threshold="0.001">
+      <limitsetref name="SiTrackerBarrelRegionLimitSet"/>
+    </region>
+  </regions>
+
+
+  <comment>Common Generic visualization attributes</comment>
+  <display>
+    <vis name="InvisibleNoDaughters"      showDaughters="false" visible="false"/>
+    <vis name="InvisibleWithDaughters"    showDaughters="true" visible="false"/>
+    <vis name="GreenVis"   alpha="1" r="0.0" g="1.0" b="0.0" showDaughters="true" visible="true"/>
+    <vis name="RedVis"     alpha="1" r="1.0" g="0.0" b="0.0" showDaughters="true" visible="true"/>
+    <vis name="BlueVis"    alpha="1" r="0.0" g="0.0" b="1.0" showDaughters="true" visible="true"/>
+  </display>
+
+  <comment>Additional design specific material definitions</comment>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Materials.xml"/>
+
+  <comment>Tracking detectors</comment>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Vertex.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Tracker.xml"/>
+
+  <comment>Calorimeters</comment>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Ecal.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Hcal.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_HcalPlug.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Muon.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Lumical.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Beamcal.xml"/>
+
+  <comment>Beampipe</comment>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Beampipe.xml"/>
+
+  <comment>Dead material, supports and magnet</comment>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Shields.xml"/>
+  <include ref="${DD4hepINSTALL}/DDDetectors/compact/SiD/SiD_Solenoid.xml"/>
+
+  <comment>Magnetic field</comment>
+  <fields>
+    <field name="MagnetFields1_Constant" type="ConstantField" field="magnetic">
+      <strength x="0" y="0" z="4.0*tesla"/>
+    </field>
+    <field name="MagnetFields2_Constant" type="ConstantField" field="magnetic">
+      <strength x="0" y="0" z="3.0*tesla"/>
+    </field>
+  </fields>
+
+</lccdd>