Merge pull request #42 from scivision/feature-cmake

CMake: improve install

Author: cburstedde

.github/workflows/ci_cmake.yml

@@ -18,7 +18,7 @@ on:
 jobs:
 
   linux:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     name: CMake build on Linux
     timeout-minutes: 15
 
@@ -33,7 +33,7 @@ jobs:
             ninja-build libopenmpi-dev openmpi-bin
 
     - name: CMake configure
-      run: cmake --preset=ninja -DCMAKE_INSTALL_PREFIX=~/libsc
+      run: cmake --preset default -DCMAKE_INSTALL_PREFIX=~
 
     - name: CMake build
       run: cmake --build build
@@ -42,11 +42,10 @@ jobs:
       run: cmake --install build
 
     - name: CMake self-tests
-      run: ctest --parallel 2 --output-on-failure
-      working-directory: build
+      run: ctest --preset default
 
     - name: CMake configure examples
-      run: cmake -B example/build -S example -Dmpi=yes -Dopenmp=yes -DSC_ROOT=~/libsc
+      run: cmake -B example/build -S example -Dmpi=yes -Dopenmp=yes -DSC_ROOT=~
 
     - name: CMake build examples
       run: cmake --build example/build
@@ -82,7 +81,7 @@ jobs:
       run: brew install open-mpi ninja
 
     - name: CMake configure
-      run: cmake --preset=mac -DCMAKE_INSTALL_PREFIX=~/libsc
+      run: cmake --preset mac -DCMAKE_INSTALL_PREFIX=~
 
     - name: CMake build
       run: cmake --build build
@@ -91,11 +90,10 @@ jobs:
       run: cmake --install build
 
     - name: CMake self-tests
-      run: ctest -E sort --parallel 2 --output-on-failure
-      working-directory: build
+      run: ctest -E sort --preset default
 
     - name: CMake configure examples
-      run: cmake -B example/build -S example -Dmpi=yes -DSC_ROOT=~/libsc
+      run: cmake -B example/build -S example -Dmpi=yes -DSC_ROOT=~
 
     - name: CMake build examples
       run: cmake --build example/build
@@ -157,11 +155,11 @@ jobs:
 
     - name: CMake configure with MPI
       if: steps.check_files.outputs.files_exists == 'true'
-      run: cmake --preset=ninja -DCMAKE_INSTALL_PREFIX=~/libsc
+      run: cmake --preset default -DCMAKE_INSTALL_PREFIX=~
 
     - name: CMake configure without MPI
       if: steps.check_files.outputs.files_exists == 'false'
-      run: cmake --preset=ninja -Dmpi=no -DCMAKE_INSTALL_PREFIX=~/libsc
+      run: cmake --preset default -Dmpi=no -DCMAKE_INSTALL_PREFIX=~
 
     - name: CMake build
       run: cmake --build build
@@ -170,16 +168,15 @@ jobs:
       run: cmake --install build
 
     - name: CMake self-tests
-      run: ctest --parallel 2 --output-on-failure
-      working-directory: build
+      run: ctest --preset default
 
     - name: CMake configure examples with MPI
       if: steps.check_files.outputs.files_exists == 'true'
-      run: cmake -B example/build -S example -Dmpi=yes -Dopenmp=yes -DSC_ROOT=~/libsc
+      run: cmake -B example/build -S example -Dmpi=yes -Dopenmp=yes -DSC_ROOT=~
 
     - name: CMake configure examples without MPI
       if: steps.check_files.outputs.files_exists == 'false'
-      run: cmake -B example/build -S example -Dopenmp=yes -DSC_ROOT=~/libsc
+      run: cmake -B example/build -S example -Dopenmp=yes -DSC_ROOT=~
 
     - name: CMake build examples
       run: cmake --build example/build

CMakeLists.txt

@@ -74,6 +74,10 @@ endif(BUILD_TESTING)
 
 # --- packaging
 
+install(FILES
+  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/FindSC.cmake
+  DESTINATION lib/cmake/Modules)
+
 include(cmake/pkgconf.cmake)
 include(cmake/install.cmake)
 

CMakePresets.json

@@ -1,27 +1,22 @@
 {
-"version": 1,
-"cmakeMinimumRequired": {
-  "major": 3,
-  "minor": 19,
-  "patch": 0
+  "version": 2,
+  "cmakeMinimumRequired": {
+    "major": 3,
+    "minor": 20,
+    "patch": 0
 },
 
 "configurePresets": [
 {
-  "name": "_default", "hidden": true,
+  "name": "default",
   "binaryDir": "${sourceDir}/build",
+  "generator": "Ninja",
   "cacheVariables": {"CMAKE_BUILD_TYPE": "Release",
     "mpi": true,
     "openmp": true}
 },
 {
-  "name": "ninja", "inherits": "_default",
-  "displayName": "build with Ninja",
-  "description": "Ninja is a faster alternative to Make",
-  "generator": "Ninja"
-},
-{
-  "name": "mac", "inherits": "ninja",
+  "name": "mac", "inherits": "default",
   "displayName": "MacOS",
   "description": "MacOS: OpenMP not used",
   "cacheVariables": {"openmp": false}
@@ -32,19 +27,18 @@
   "description": "MacOS: OpenMP not used, using Make"
 },
 {
-  "name": "make", "inherits": "_default",
+  "name": "make", "inherits": "default",
   "displayName": "build with GNU Make",
   "generator": "Unix Makefiles"
 },
 {
-  "name": "makewin", "inherits": "_default",
+  "name": "makewin", "inherits": "default",
   "displayName": "build with GNU Make: Windows",
   "generator": "MinGW Makefiles"
 },
 {
-  "name": "intel", "inherits": "ninja",
+  "name": "intel", "inherits": "default",
   "displayName": "Intel Classic compiler: Linux/MacOS",
-  "description": "build with Intel Classic on Linux/MacOS",
   "environment": {
     "CC": "icc",
     "CXX": "icpc",
@@ -55,7 +49,6 @@
 {
   "name": "intelwin", "inherits": "intel",
   "displayName": "Intel Classic compiler: Windows",
-  "description": "build with Intel Classic on Windows",
   "environment": {
     "CC": "icl",
     "CXX": "icl"
@@ -64,12 +57,30 @@
 {
   "name": "intelnext", "inherits": "intel",
   "displayName": "Intel oneAPI LLVM",
-  "description": "build with Intel oneAPI NextGen LLVM",
   "environment": {
     "CC": "icx",
     "CXX": "icx",
     "FC": "ifx"
   }
 }
+],
+"buildPresets": [
+  {
+    "name": "default",
+    "configurePreset": "default"
+  }
+],
+"testPresets": [
+{
+  "name": "default",
+  "configurePreset": "default",
+  "output": {
+    "outputOnFailure": true,
+    "verbosity": "default"
+  },
+  "execution": {
+    "noTestsAction": "error",
+    "stopOnFailure": false}
+}
 ]
 }

cmake/install.cmake

@@ -8,25 +8,20 @@ configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/Config.cmake.in
 
 write_basic_package_version_file(
   ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake
-  VERSION ${${PROJECT_NAME}_VERSION}
-  COMPATIBILITY SameMinorVersion
-)
+  COMPATIBILITY SameMinorVersion)
 
 install(EXPORT ${PROJECT_NAME}Targets
-  FILE ${PROJECT_NAME}Targets.cmake
   NAMESPACE ${PROJECT_NAME}::
-  DESTINATION lib/cmake/${PROJECT_NAME}
-)
+  DESTINATION lib/cmake/${PROJECT_NAME})
 
 install(FILES
   ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Config.cmake
   ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake
   DESTINATION lib/cmake/${PROJECT_NAME})
 
 export(EXPORT ${PROJECT_NAME}Targets
-  FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Targets.cmake"
-  NAMESPACE ${PROJECT_NAME}::
-)
+  FILE ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Targets.cmake
+  NAMESPACE ${PROJECT_NAME}::)
 
 # --- CPack
 

example/CMakeLists.txt

@@ -5,8 +5,6 @@ include(CTest)
 include(CheckSymbolExists)
 include(CheckIncludeFile)
 
-list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/../cmake/Modules)
-
 option(mpi "use MPI" off)
 
 # --- find external libraries
@@ -21,14 +19,18 @@ find_package(ZLIB REQUIRED)
 find_package(Threads)
 
 # --- find our library
-set(CMAKE_FIND_PACKAGE_PREFER_CONFIG true)
 
-find_package(SC REQUIRED PATHS ${PROJECT_SOURCE_DIR}/../build)
+if(NOT SC_ROOT AND NOT DEFINED ENV{SC_ROOT})
+  set(SC_ROOT ${PROJECT_SOURCE_DIR}/../build)
+endif()
+
+find_package(SC REQUIRED)
 
 # --- get system capabilities
 
 check_symbol_exists(sqrt math.h SC_NONEED_M)
 if(NOT SC_NONEED_M)
+  set(CMAKE_REQUIRED_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} m)
   check_symbol_exists(sqrt math.h SC_NEED_M)
 endif()