Merge pull request #77 from alliander-opensource/feature/internal-sparse-solver

Use internal sparse solver to replace EIGEN and MKL

Author: TonyXiang8787

.github/workflows/main.yml

@@ -28,24 +28,19 @@ jobs:
     strategy:
       matrix:
         build-option: [ Debug, Release ]
-        sparse-solver: [ EIGEN, MKL, MKL_RUNTIME ]
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Run build script
-        run: ./build.sh  ${{ matrix.build-option }} ${{ matrix.sparse-solver }}
+        run: ./build.sh  ${{ matrix.build-option }}
 
   build-cpp-test-windows:
     if: (github.event_name == 'push')  || (github.event_name == 'workflow_dispatch') || (!startsWith(github.head_ref, 'release'))
     runs-on: windows-latest
     strategy:
       matrix:
         build-option: [ Debug, Release ]
-        sparse-solver: [ EIGEN, MKL, MKL_RUNTIME ]
-    env:
-      MKL_INCLUDE: C:\conda_envs\cpp_pkgs\Library\include
-      MKL_LIB: C:\conda_envs\cpp_pkgs\Library\lib
 
     steps:
       - uses: actions/checkout@v3
@@ -57,25 +52,24 @@ jobs:
       - name: Install conda environment
         # TODO removed pinned v2 of catch2, see https://github.com/alliander-opensource/power-grid-model/issues/73
         run: |
-          conda create --yes -p C:\conda_envs\cpp_pkgs -c conda-forge boost-cpp eigen nlohmann_json mkl mkl-devel mkl-include catch2==2.13.9
+          conda create --yes -p C:\conda_envs\cpp_pkgs -c conda-forge boost-cpp eigen nlohmann_json catch2==2.13.9
 
       - name: Build and test
         run: |
           $vsPath = &(Join-Path ${env:ProgramFiles(x86)} '\Microsoft Visual Studio\Installer\vswhere.exe') -property installationpath
           Import-Module (Join-Path $vsPath 'Common7\Tools\Microsoft.VisualStudio.DevShell.dll')
           Enter-VsDevShell -VsInstallPath $vsPath -SkipAutomaticLocation -DevCmdArguments '-arch=x64 -host_arch=x64'
           $env:Path += ";C:\conda_envs\cpp_pkgs\Library\bin"
-          mkdir cpp_build_${{ matrix.build-option }}_${{ matrix.sparse-solver }}
-          cd cpp_build_${{ matrix.build-option }}_${{ matrix.sparse-solver }}
+          mkdir cpp_build_${{ matrix.build-option }}
+          cd cpp_build_${{ matrix.build-option }}
           # generate cmake cache
           cmake .. `
             -G "Ninja" `
             -DCMAKE_BUILD_TYPE=${{ matrix.build-option }} `
-            -DPOWER_GRID_MODEL_SPARSE_SOLVER=${{ matrix.sparse-solver }} `
             -DCMAKE_PREFIX_PATH=C:\conda_envs\cpp_pkgs\Library `
             -DPOWER_GRID_MODEL_BUILD_BENCHMARK=1
           # build
-          cmake --build . --verbose
+          cmake --build . --verbose -j 1
           # test
           .\tests\cpp_unit_tests\power_grid_model_unit_tests.exe
 
@@ -85,12 +79,9 @@ jobs:
     strategy:
       matrix:
         build-option: [ Debug, Release ]
-        sparse-solver: [ EIGEN, MKL, MKL_RUNTIME ]
     env:
       CC: clang
       CXX: clang++
-      MKL_INCLUDE: /usr/local/include
-      MKL_LIB: /usr/local/lib
       CMAKE_PREFIX_PATH: /usr/local
 
     steps:
@@ -101,14 +92,10 @@ jobs:
         run: |
           brew install ninja boost eigen nlohmann-json 
           curl https://raw.githubusercontent.com/Homebrew/homebrew-core/5e5abb11bf49787d01164c4066119365262c21ed/Formula/catch2.rb > $(find $(brew --repository) -name catch2.rb) && brew reinstall catch2
-          sudo pip3 install mkl mkl-devel mkl-include
 
       - name: Build and test
         run: |
-          # environment
-          export LD_LIBRARY_PATH=${MKL_LIB}:${LD_LIBRARY_PATH}
-          # bash
-          ./build.sh  ${{ matrix.build-option }} ${{ matrix.sparse-solver }}
+          ./build.sh  ${{ matrix.build-option }} 
 
   build-and-test-python:
     strategy:
@@ -122,9 +109,6 @@ jobs:
             boost:
             eigen:
             cibw_build: "cp*-manylinux_x86_64 cp*-manylinux_aarch64"
-            test_cmd: >
-              pytest {package}/tests &&
-              LD_LIBRARY_PATH= pytest {package}/tests
             archs: "x86_64 aarch64"
           - platform: macos
             os: macos-latest
@@ -134,9 +118,6 @@ jobs:
             eigen: /usr/local/include/eigen3
             cibw_build: cp*-macosx_*
             archs: "x86_64 arm64"
-            test_cmd: >
-              pytest {package}/tests &&
-              LD_LIBRARY_PATH=/usr/local/lib:${LD_LIBRARY_PATH} pytest {package}/tests
           - platform: windows
             os: windows-latest
             cc:
@@ -145,7 +126,6 @@ jobs:
             eigen: C:\conda_envs\cpp_pkgs\Library\include\eigen3
             cibw_build: cp*-win_amd64
             archs: AMD64
-            test_cmd: pytest {package}/tests
 
     runs-on: ${{ matrix.os }}
     needs: [build-cpp-test-linux, build-cpp-test-windows, build-cpp-test-macos]
@@ -160,7 +140,7 @@ jobs:
       CIBW_BUILD: ${{ matrix.cibw_build }}
       CIBW_ARCHS: ${{ matrix.archs }}
       CIBW_TEST_REQUIRES: pytest pytest-cov
-      CIBW_TEST_COMMAND: ${{ matrix.test_cmd }}
+      CIBW_TEST_COMMAND: pytest {package}/tests
       # Skip trying to test arm64 builds on Intel Macs
       CIBW_TEST_SKIP: "*-macosx_arm64 *-macosx_universal2:arm64"
       CIBW_MANYLINUX_X86_64_IMAGE: ghcr.io/alliander-opensource/power-grid-model-build-env
@@ -169,11 +149,10 @@ jobs:
       CIBW_BEFORE_ALL_MACOS: >
         which clang++ &&
         clang++ --version &&
-        brew install boost eigen &&
-        sudo pip3 install mkl mkl-devel mkl-include
+        brew install boost eigen
       MACOSX_DEPLOYMENT_TARGET: 10.15
       CIBW_BEFORE_ALL_WINDOWS : >
-        conda create --yes -p C:\conda_envs\cpp_pkgs -c conda-forge boost-cpp eigen mkl
+        conda create --yes -p C:\conda_envs\cpp_pkgs -c conda-forge boost-cpp eigen
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/sonar.yml

@@ -61,7 +61,7 @@ jobs:
       - name: Run build-wrapper for C++
         run: |
           mkdir cpp_build
-          cmake -S . -B cpp_build -GNinja -DCMAKE_BUILD_TYPE=Debug -DPOWER_GRID_MODEL_SPARSE_SOLVER=EIGEN -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} 
+          cmake -S . -B cpp_build -GNinja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} 
           VERBOSE=1 build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} cmake --build cpp_build/
 
       - name: C++ test and coverage

CMakeLists.txt

@@ -31,52 +31,23 @@ else()
   add_compile_options(-Wall -Wextra -pedantic -Werror)
   add_compile_options(-Wno-deprecated-copy)  # bug in boost
   if(UNIX AND NOT APPLE)
-    list(APPEND CMAKE_FIND_LIBRARY_SUFFIXES .so.1)
-    list(APPEND CMAKE_FIND_LIBRARY_SUFFIXES .so.2)
-	# test coverage for debug build in linux
-	if (CMAKE_BUILD_TYPE STREQUAL "Debug")
+	# test coverage for debug build in linux, if specified
+	if ((CMAKE_BUILD_TYPE STREQUAL "Debug") AND (DEFINED POWER_GRID_MODEL_COVERAGE) AND (POWER_GRID_MODEL_COVERAGE EQUAL 1))
 	  add_compile_options(-fprofile-arcs -ftest-coverage)
 	  add_link_options(-fprofile-arcs)
 	endif()
   else()
-    list(APPEND CMAKE_FIND_LIBRARY_SUFFIXES .1.dylib)
-	list(APPEND CMAKE_FIND_LIBRARY_SUFFIXES .2.dylib)
   endif()
   # thread
   find_package(Threads REQUIRED)
   target_link_libraries(power_grid_model INTERFACE Threads::Threads)
 endif()
 
-
-# sparse solver, default eigen
-if (NOT DEFINED POWER_GRID_MODEL_SPARSE_SOLVER)
-	set(POWER_GRID_MODEL_SPARSE_SOLVER "EIGEN")
-endif()
-
-# use mkl solver
-if((POWER_GRID_MODEL_SPARSE_SOLVER STREQUAL "MKL") OR (POWER_GRID_MODEL_SPARSE_SOLVER STREQUAL "MKL_RUNTIME"))
-	# check load mkl at runtime or link-time
- 	if(POWER_GRID_MODEL_SPARSE_SOLVER STREQUAL "MKL_RUNTIME")
-		target_compile_definitions(power_grid_model INTERFACE POWER_GRID_MODEL_USE_MKL_AT_RUNTIME=1)
-		target_link_libraries(power_grid_model INTERFACE ${CMAKE_DL_LIBS})
-	else()
-		if(NOT DEFINED ENV{MKL_INCLUDE})
-			message(FATAL_ERROR "MKL include dir not found!")
-		endif()
-		if(NOT DEFINED ENV{MKL_LIB})
-			message(FATAL_ERROR "MKL lib dir not found!")
-		endif()
-		# mkl
-		target_include_directories(power_grid_model INTERFACE $ENV{MKL_INCLUDE})
-		list(APPEND CMAKE_PREFIX_PATH "$ENV{MKL_LIB}")
-		find_library(MKL_RT mkl_rt)
-		message("${MKL_RT}")
-		target_compile_definitions(power_grid_model INTERFACE POWER_GRID_MODEL_USE_MKL=1)
-		target_link_libraries(power_grid_model INTERFACE "${MKL_RT}")
-	endif()
+if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+  # using GCC
+  add_compile_options(-Wno-maybe-uninitialized)  # bug in boost
 endif()
 
-
 # get tests
 add_subdirectory(tests/cpp_unit_tests)
 
@@ -85,3 +56,4 @@ if(DEFINED POWER_GRID_MODEL_BUILD_BENCHMARK AND POWER_GRID_MODEL_BUILD_BENCHMARK
 	add_subdirectory(tests/benchmark_cpp)
 endif()
 
+

CMakeSettings.json

@@ -23,54 +23,6 @@
       "ctestCommandArgs": "",
       "inheritEnvironments": [ "msvc_x64_x64" ],
       "cmakeToolchain": "${env.VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake"
-    },
-    {
-      "name": "x64-Debug-MKL",
-      "generator": "Ninja",
-      "configurationType": "Debug",
-      "buildRoot": "${projectDir}\\cpp_build\\${name}",
-      "installRoot": "${projectDir}\\install\\${name}",
-      "cmakeCommandArgs": "-DPOWER_GRID_MODEL_BUILD_BENCHMARK=1 -DPOWER_GRID_MODEL_SPARSE_SOLVER=MKL",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "inheritEnvironments": [ "msvc_x64_x64" ],
-      "cmakeToolchain": "${env.VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake"
-    },
-    {
-      "name": "x64-Release-MKL",
-      "generator": "Ninja",
-      "configurationType": "RelWithDebInfo",
-      "buildRoot": "${projectDir}\\cpp_build\\${name}",
-      "installRoot": "${projectDir}\\install\\${name}",
-      "cmakeCommandArgs": "-DPOWER_GRID_MODEL_BUILD_BENCHMARK=1 -DPOWER_GRID_MODEL_SPARSE_SOLVER=MKL",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "inheritEnvironments": [ "msvc_x64_x64" ],
-      "cmakeToolchain": "${env.VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake"
-    },
-    {
-      "name": "x64-Debug-MKL-at-runtime",
-      "generator": "Ninja",
-      "configurationType": "Debug",
-      "buildRoot": "${projectDir}\\cpp_build\\${name}",
-      "installRoot": "${projectDir}\\install\\${name}",
-      "cmakeCommandArgs": "-DPOWER_GRID_MODEL_BUILD_BENCHMARK=1 -DPOWER_GRID_MODEL_SPARSE_SOLVER=MKL_RUNTIME",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "cmakeToolchain": "${env.VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake",
-      "inheritEnvironments": [ "msvc_x64_x64" ]
-    },
-    {
-      "name": "x64-Release-MKL-at-runtime",
-      "generator": "Ninja",
-      "configurationType": "RelWithDebInfo",
-      "buildRoot": "${projectDir}\\cpp_build\\${name}",
-      "installRoot": "${projectDir}\\install\\${name}",
-      "cmakeCommandArgs": "-DPOWER_GRID_MODEL_BUILD_BENCHMARK=1 -DPOWER_GRID_MODEL_SPARSE_SOLVER=MKL_RUNTIME",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "cmakeToolchain": "${env.VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake",
-      "inheritEnvironments": [ "msvc_x64_x64" ]
     }
   ]
 }

README.md

@@ -29,39 +29,8 @@ Currently, it supports the following calculations:
 
 # Installation
 
-## Runtime Dependencies
+## Install from PyPI
 
-The only Python runtime dependency is
-[numpy](https://numpy.org/). It will be automatically installed as the requirements.
-Moreover, the library optionally depends on
-[Intel Math Kernel Library (mkl)](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/onemkl.html),
-for its [PARDISO](https://www.intel.com/content/www/us/en/develop/documentation/onemkl-developer-reference-c/top/sparse-solver-routines/onemkl-pardiso-parallel-direct-sparse-solver-iface.html) sparse solver.
-It is recommended to install `mkl` because it gives huge performance boosts.
-
-The easiest way to install `mkl` is using `pip` or `conda`:
-
-```
-pip install mkl
-```
-
-or
-
-```
-conda install -c conda-forge mkl
-```
-
-You need to add the path to the `mkl` runtime file `libmkl_rt.so` or `mkl_rt.dll` the environment variable
-`LD_LIBRARY_PATH` in Linux or `Path` in Windows (`conda` does this automatically in the environment).
-If the library can find `mkl` runtime, it uses it as the sparse solver.
-It is recommended to set the environment variable `MKL_THREADING_LAYER` to `SEQUENTIAL`,
-as multi-threading is handled in a higher level.
-If the library cannot find `mkl` runtime, it will fall back to an internally built-in (and much slower)
-[Eigen SparseLU](https://eigen.tuxfamily.org/dox/classEigen_1_1SparseLU.html) solver.
-
-## Install from Pre-built Binary Package
-
-The `power-grid-model` python package is pre-built for Windows, Linux, and macOS (both Intel and Arm-based),
-for Python version 3.8, 3.9, and 3.10.
 You can directly install the package from PyPI.
 
 ```
@@ -208,13 +177,6 @@ which are licensed under their own respective Open-Source licenses.
 SPDX-License-Identifier headers are used to show which license is applicable. 
 The concerning license files can be found in the LICENSES directory.
 
-## Intel Math Kernel Library License
-
-The `power-grid-model` does not bundle or redistribute any MKL runtime library. 
-It only detects if MKL library is installed in the target system. 
-If so, it will use the library to accelerate the calculation. 
-The user is responsible to acquire a suitable MKL license.
-
 # Contributing
 Please read [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) and [CONTRIBUTING](CONTRIBUTING.md) for details on the process 
 for submitting pull requests to us.

build.sh

@@ -7,7 +7,7 @@
 set -e
 
 usage() {
-  echo "$0 {Debug/Release} {EIGEN,MKL,MKL_RUNTIME}"
+  echo "$0 {Debug/Release}"
 }
 
 if [ ! "$1" = "Debug" ] && [ ! "$1" = "Release" ]; then
@@ -16,13 +16,13 @@ if [ ! "$1" = "Debug" ] && [ ! "$1" = "Release" ]; then
   exit 1;
 fi
 
-if [ ! "$2" = "EIGEN" ] && [ ! "$2" = "MKL" ] && [ ! "$2" = "MKL_RUNTIME" ]; then
-  echo "Missing second argument"
-  usage
-  exit 1;
+if [[ $2 == "Coverage" ]]; then
+  BUILD_COVERAGE=-DPOWER_GRID_MODEL_COVERAGE=1
+else
+  BUILD_COVERAGE=
 fi
 
-BUILD_DIR=cpp_build_$1_$2
+BUILD_DIR=cpp_build_$1
 echo "Build dir: ${BUILD_DIR}"
 
 if [[ ! -z "${VCPKG_ROOT}" ]]; then
@@ -41,27 +41,19 @@ cd ${BUILD_DIR}
 # generate
 cmake .. -GNinja \
     -DCMAKE_BUILD_TYPE=$1 \
-    -DPOWER_GRID_MODEL_SPARSE_SOLVER=$2 \
     ${PATH_FOR_CMAKE} \
-    -DPOWER_GRID_MODEL_BUILD_BENCHMARK=1
+    -DPOWER_GRID_MODEL_BUILD_BENCHMARK=1 \
+    ${BUILD_COVERAGE}
 # build
 VERBOSE=1 cmake --build .
 # test
+./tests/cpp_unit_tests/power_grid_model_unit_tests
 
-if [[ $2 == "MKL_RUNTIME" ]]; then
-  LD_LIBRARY_PATH= ./tests/cpp_unit_tests/power_grid_model_unit_tests
-  LD_LIBRARY_PATH= POWER_GRID_MODEL_SPARSE_SOLVER=MKL ./tests/cpp_unit_tests/power_grid_model_unit_tests
-  LD_LIBRARY_PATH=${MKL_LIB} ./tests/cpp_unit_tests/power_grid_model_unit_tests
-  LD_LIBRARY_PATH=${MKL_LIB} POWER_GRID_MODEL_SPARSE_SOLVER=MKL ./tests/cpp_unit_tests/power_grid_model_unit_tests
-  POWER_GRID_MODEL_SPARSE_SOLVER=EIGEN ./tests/cpp_unit_tests/power_grid_model_unit_tests
-else
-  LD_LIBRARY_PATH=${MKL_LIB} ./tests/cpp_unit_tests/power_grid_model_unit_tests
-fi
 
 
 cd ..
 # test coverage report for debug build and for linux
-if [[ "$1" = "Debug" ]] && [[ $3 == "Coverage" ]];  then
+if [[ "$1" = "Debug" ]] && [[ $2 == "Coverage" ]];  then
   echo "Generating coverage report..."
   if [[ ${CXX} == "clang++"* ]]; then
     GCOV_TOOL="--gcov-tool llvm-gcov.sh"