Minimal tidy of CMake scripts (#277)

* Minimal tidy of CMake scripts Purely cosmetic for clarity and next step of improving linking. * Reduce CMake max version to support older VecCore VecCore still uses CMake's long deprecated FindCUDA module, resulting in issues with policy CMP0146: https://cmake.org/cmake/help/latest/policy/CMP0146.html Reduce max CMake version to 3.24 to prevent this error until upstream is patched.
apt-sim · Feb 28, 2024 · 2482f39 · 2482f39
1 parent f76b10f
commit 2482f39
Show file tree

Hide file tree

Showing 7 changed files with 220 additions and 154 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,18 +1,20 @@
 # SPDX-FileCopyrightText: 2020 CERN
 # SPDX-License-Identifier: Apache-2.0
 
-cmake_minimum_required(VERSION 3.18)
+cmake_minimum_required(VERSION 3.18...3.24)
 
 # Record the command line invoking the cmake command. Replay with recmake_initial.sh.
 include(cmake/RecordCmdLine.cmake)
 
 project(AdePT
   VERSION 0.1.0
   DESCRIPTION "Accelerated demonstrator of electromagnetic Particle Transport"
-  LANGUAGES C CXX CUDA)
-
-include(GNUInstallDirs)
+  LANGUAGES C CXX CUDA
+)
 
+#----------------------------------------------------------------------------#
+# CMake and Build Settings
+#----------------------------------------------------------------------------#
 # - Include needed custom/core modules
 set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 include(CMakeSettings) 
@@ -28,7 +30,8 @@ if(NOT CMAKE_CONFIGURATION_TYPES)
   endif()
   set(CMAKE_BUILD_TYPE "${__DEFAULT_CMAKE_BUILD_TYPE}"
     CACHE STRING "Choose the type of build, options are: None Release MinSizeRel Debug RelWithDebInfo MinSizeRel."
-    FORCE)
+    FORCE
+  )
 endif()
 
 set(CMAKE_CXX_STANDARD 17)
@@ -39,6 +42,15 @@ set(CMAKE_CUDA_STANDARD_REQUIRED ${CMAKE_CXX_STANDARD_REQUIRED})
 set(CMAKE_CUDA_EXTENSIONS OFF)
 set(CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE ON)
 
+#----------------------------------------------------------------------------#
+# User options
+#----------------------------------------------------------------------------#
+# Options
+option(ADEPT_USE_SURF "Enable surface model navigation on GPU" OFF)
+
+#----------------------------------------------------------------------------#
+# Dependencies
+#----------------------------------------------------------------------------#
 # With CUDA language enabled above, this should find the toolkit alongside the compiler
 find_package(CUDAToolkit REQUIRED)
 
@@ -48,8 +60,6 @@ set(VecCore_BACKEND CUDA)
 find_package(VecCore ${VecCore_VERSION} REQUIRED COMPONENTS ${VecCore_BACKEND})
 message(STATUS "Using VecCore version ${VecCore_VERSION}")
 
-option(ADEPT_USE_SURF "Enable surface model navigation on GPU" OFF)
-
 # Before looking for other packages, try to find XercesC explicitly to avoid
 # problems with G4HepEm not finding Geant4 11.1 even though we find it here.
 find_package(XercesC REQUIRED)
@@ -58,23 +68,21 @@ find_package(XercesC REQUIRED)
 set(VecGeom_VERSION_REQ 2.0.0-dev.3)
 find_package(VecGeom REQUIRED)
 # Older versions did not provide VecGeom_VERSION_STRING, but only VecGeom_VERSION
-if (NOT VecGeom_VERSION_STRING)
+if(NOT VecGeom_VERSION_STRING)
   set(VecGeom_VERSION_STRING ${VecGeom_VERSION})
 endif()
-if (VecGeom_VERSION_STRING STRLESS VecGeom_VERSION_REQ)
+if(VecGeom_VERSION_STRING STRLESS VecGeom_VERSION_REQ)
   message(FATAL_ERROR "AdePT requires at least VecGeom ${VecGeom_VERSION_REQ}, found ${VecGeom_VERSION_STRING}" )
 else()
   message(STATUS "Using VecGeom version ${VecGeom_VERSION_STRING}")
 endif()
-# make sure we import VecGeom architecture flags - is this needed?
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${VECGEOM_CXX_FLAGS}")
 # Make sure VecGeom::vgdml is enabled
 if(NOT TARGET VecGeom::vgdml)
   message(FATAL_ERROR "AdePT requires VecGeom compiled with GDML support")
 endif()
 # Check for surface model support in VecGeom
-if (ADEPT_USE_SURF)
-  if (VecGeom_SURF_FOUND)
+if(ADEPT_USE_SURF)
+  if(VecGeom_SURF_FOUND)
     message(STATUS "Surface model in VecGeom is enabled")
     add_compile_definitions(ADEPT_USE_SURF)
   else()
@@ -105,7 +113,6 @@ endif()
 
 # Find HepMC3, used by integration examples to load realistic events
 find_package(HepMC3 QUIET)
-
 if(HepMC3_FOUND)
   message(STATUS "HepMC3 found ${HEPMC3_INCLUDE_DIR}")
   add_compile_definitions(HEPMC3_FOUND)
@@ -127,138 +134,157 @@ if(G4HepEm_FOUND)
   message(STATUS "G4HepEm found ${G4HepEm_INCLUDE_DIR}")
 endif()
 
-if(BUILD_TESTING)
-  set(TESTING_GDML "${PROJECT_BINARY_DIR}/trackML.gdml")
-  set(CMS2018_GDML "${PROJECT_BINARY_DIR}/cms2018.gdml")
-  file(DOWNLOAD https://gitlab.cern.ch/VecGeom/VecGeom/raw/v1.2.0/persistency/gdml/gdmls/trackML.gdml "${TESTING_GDML}"
-    EXPECTED_HASH SHA256=2c53e0f2f4673c61f8679702532647bf71ec64c1613aae330fa835e7d7087064)
-  file(DOWNLOAD https://gitlab.cern.ch/VecGeom/VecGeom/raw/v1.2.0/persistency/gdml/gdmls/cms2018.gdml "${CMS2018_GDML}"
-    EXPECTED_HASH SHA256=a6538d8f196fbfe4c14e806df3439d5a0d7050d538d364faabe882c750970e63)
-endif()
-
-configure_file(examples/data/cms2018_sd.gdml ${CMAKE_BINARY_DIR}/cms2018_sd.gdml)
-configure_file(examples/data/ppttbar.hepmc3 ${CMAKE_BINARY_DIR}/ppttbar.hepmc3)
-
+#----------------------------------------------------------------------------#
+# Build Targets
+#----------------------------------------------------------------------------#
 set(ADEPT_G4_INTEGRATION_SRCS
   src/AdePTTrackingManager.cc
   src/AdePTPhysics.cc
   src/HepEMPhysics.cc
-  src/AdePTGeant4Integration.cpp)
+  src/AdePTGeant4Integration.cpp
+)
 
 set(ADEPT_SRCS
   src/AdePTTransport.cpp
-  src/AdePTConfigurationMessenger.cc)
+  src/AdePTConfigurationMessenger.cc
+)
 
 set(ADEPT_CUDA_SRCS
   src/AdePTTransport.cu
-  src/HostScoring.cu)
+  src/HostScoring.cu
+)
 
 add_library(CopCore INTERFACE)
-target_include_directories(CopCore INTERFACE
-                           $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include/AdePT/copcore/>
-                           $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)
+target_include_directories(CopCore
+  INTERFACE
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include/AdePT/copcore/>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>
+)
 
 add_library(AdePT_G4_integration SHARED ${ADEPT_G4_INTEGRATION_SRCS})
-target_include_directories(AdePT_G4_integration PUBLIC 
-                          #Include directory for building the library
-                          $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-                          #Include directory for the installed target
-                          $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)
-target_link_libraries(AdePT_G4_integration PUBLIC 
-                      CopCore
-                      VecGeom::vecgeom
-                      VecGeom::vgdml
-                      ${Geant4_LIBRARIES}
-                      G4HepEm::g4HepEm
-                      G4HepEm::g4HepEmData)
+target_include_directories(AdePT_G4_integration 
+  PUBLIC 
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>
+)
+target_link_libraries(AdePT_G4_integration 
+  PUBLIC 
+    CopCore
+    VecGeom::vecgeom
+    VecGeom::vgdml
+    ${Geant4_LIBRARIES}
+    G4HepEm::g4HepEm
+    G4HepEm::g4HepEmData
+)
 
 add_library(AdePT SHARED ${ADEPT_SRCS})
-target_include_directories(AdePT PUBLIC
-                          #Include directory for building the library
-                          $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-                          #Include directory for the installed target
-                          $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)
-target_link_libraries(AdePT PUBLIC 
-                      CopCore
-                      VecGeom::vecgeom
-                      VecGeom::vgdml
-                      G4HepEm::g4HepEm
-                      G4HepEm::g4HepEmData)
+target_include_directories(AdePT 
+  PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>
+)
+target_link_libraries(AdePT 
+  PUBLIC 
+    CopCore
+    VecGeom::vecgeom
+    VecGeom::vgdml
+    G4HepEm::g4HepEm
+    G4HepEm::g4HepEmData
+)
 
 add_library(AdePT_cuda SHARED ${ADEPT_CUDA_SRCS})
-target_include_directories(AdePT_cuda PUBLIC 
-                          ${Geant4_INCLUDE_DIRS}
-                          #Include directory for building the library
-                          $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-                          #Include directory for the installed target
-                          $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)
-target_link_libraries(AdePT_cuda PUBLIC
-                      VecGeom::vecgeomcuda_static
-                      CopCore
-                      G4HepEm::g4HepEmInit
-                      G4HepEm::g4HepEmRun)
-set_target_properties(AdePT_cuda PROPERTIES CUDA_SEPARABLE_COMPILATION ON CUDA_RESOLVE_DEVICE_SYMBOLS ON)
+target_include_directories(AdePT_cuda 
+  PUBLIC 
+    ${Geant4_INCLUDE_DIRS}
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>
+)
+target_link_libraries(AdePT_cuda 
+  PUBLIC
+    VecGeom::vecgeomcuda_static
+    CopCore
+    G4HepEm::g4HepEmInit
+    G4HepEm::g4HepEmRun
+)
+set_target_properties(AdePT_cuda
+  PROPERTIES 
+    CUDA_SEPARABLE_COMPILATION ON 
+    CUDA_RESOLVE_DEVICE_SYMBOLS ON
+)
 
 # AdePT_cuda links against vecgeomcuda_static. This is fine as long as the final executable doesn't link with 
 # vecgeomcuda itself, as is the case with Geant4 integration examples. However for standalone applications not 
 # using geant4, that may need features from vecgeomcuda, this doesn't work. In that case AdePT_cuda has to link 
 # to the shared version of vecgeomcuda, and the final executable to vecgeomcuda_static
 add_library(AdePT_cuda_standalone SHARED ${ADEPT_CUDA_SRCS})
-target_include_directories(AdePT_cuda_standalone PUBLIC 
-                          ${Geant4_INCLUDE_DIRS}
-                          #Include directory for building the library
-                          $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-                          #Include directory for the installed target
-                          $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)
-target_link_libraries(AdePT_cuda_standalone PUBLIC
-                      VecGeom::vecgeomcuda
-                      CopCore
-                      G4HepEm::g4HepEmInit
-                      G4HepEm::g4HepEmRun)
-set_target_properties(AdePT_cuda_standalone PROPERTIES CUDA_SEPARABLE_COMPILATION ON CUDA_RESOLVE_DEVICE_SYMBOLS ON)
-
+target_include_directories(AdePT_cuda_standalone 
+  PUBLIC 
+    ${Geant4_INCLUDE_DIRS}
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>
+)
+target_link_libraries(AdePT_cuda_standalone
+  PUBLIC
+    VecGeom::vecgeomcuda
+    CopCore
+    G4HepEm::g4HepEmInit
+    G4HepEm::g4HepEmRun
+)
+set_target_properties(AdePT_cuda_standalone
+  PROPERTIES 
+    CUDA_SEPARABLE_COMPILATION ON
+    CUDA_RESOLVE_DEVICE_SYMBOLS ON
+)
 
 # Optional library to activate NVTX annotations for profiling:
-set(NVTX OFF CACHE BOOL "Add NVTX instrumentation for profiling (only for annotated examples)")
+option(NVTX OFF "Add NVTX instrumentation for profiling (only for annotated examples)")
 add_library(NVTX INTERFACE)
 if(NVTX)
   target_link_libraries(NVTX INTERFACE nvToolsExt)
   target_compile_definitions(NVTX INTERFACE -DUSE_NVTX)
 endif()
 
-add_subdirectory(test)
-add_subdirectory(examples)
+if(BUILD_TESTING)
+  add_subdirectory(test)
+  # This might become a separate option, e.g. "ADEPT_BUILD_EXAMPLES"
+  add_subdirectory(examples)
+endif()
 
 ####################################################################################################
 
 include(CMakePackageConfigHelpers)
 #Generate the configuration file from the template and save it to the build directory
 configure_package_config_file(cmake/${PROJECT_NAME}Config.cmake.in 
-                              "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${PROJECT_NAME}Config.cmake"
-                              INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
-                              PATH_VARS CMAKE_INSTALL_INCLUDEDIR)
+  "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${PROJECT_NAME}Config.cmake"
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+  PATH_VARS CMAKE_INSTALL_INCLUDEDIR
+)
 
 #Install the libraries
 install(TARGETS CopCore AdePT AdePT_cuda AdePT_G4_integration AdePT_cuda_standalone 
-EXPORT ${PROJECT_NAME}Targets
-ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
-LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
-RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}")
+  EXPORT ${PROJECT_NAME}Targets
+  ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
+  LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
+  RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}"
+)
 
 #Install the headers
 install(DIRECTORY include/AdePT 
-        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
 
 #Install the configuration file
 install(FILES "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/AdePTConfig.cmake" 
-        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+)
 
 #Export the targets file
 export(TARGETS CopCore AdePT_G4_integration AdePT AdePT_cuda AdePT_cuda_standalone
-        FILE "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${PROJECT_NAME}Targets.cmake")
+  FILE "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${PROJECT_NAME}Targets.cmake"
+)
 
 #Install the targets file
 install(EXPORT ${PROJECT_NAME}Targets
-        NAMESPACE ${PROJECT_NAME}::
-        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
-
+  NAMESPACE ${PROJECT_NAME}::
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+)
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -1,5 +1,10 @@
 # SPDX-FileCopyrightText: 2020 CERN
 # SPDX-License-Identifier: Apache-2.0
 
+# - Common data for testing
+configure_file(data/cms2018_sd.gdml ${PROJECT_BINARY_DIR}/cms2018_sd.gdml)
+configure_file(data/ppttbar.hepmc3 ${PROJECT_BINARY_DIR}/ppttbar.hepmc3)
+
+# - Subprojects
 add_subdirectory(Example1)
-add_subdirectory(IntegrationBenchmark)
+add_subdirectory(IntegrationBenchmark)