use scikit-build-core as build backend

.github/actions/enable-msvc/action.yml

@@ -0,0 +1,23 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: 'Enable MSVC'
+description: 'Sets up Microsoft Visual C++ Build Tools on the runner'
+
+runs:
+  using: "composite"
+  steps:
+    - name: Setup MSVC Build Tools
+      shell: pwsh
+      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'
+
+        Add-Content $env:GITHUB_ENV "VCINSTALLDIR=$env:VCINSTALLDIR"
+        Add-Content $env:GITHUB_ENV "PATH=$env:PATH"
+        Add-Content $env:GITHUB_ENV "INCLUDE=$env:INCLUDE"
+        Add-Content $env:GITHUB_ENV "LIB=$env:LIB"
+        Add-Content $env:GITHUB_ENV "LIBPATH=$env:LIBPATH"
+

.github/conda_pgm_env.yml

@@ -7,8 +7,7 @@ dependencies:
   # build env
   - python=3.12
   - pip
-  - wheel
-  - setuptools
+  - scikit-build-core
   # build deps
   - libboost-headers
   - eigen

.github/workflows/build-test-release.yml

@@ -44,15 +44,16 @@ jobs:
 
       - name: Build SDist
         run: |
-          cat PYPI_VERSION
+          cp PYPI_VERSION VERSION
+          cat VERSION
           pip install build
           python -m build --sdist --outdir wheelhouse .
 
       - name: Keep version file
         uses: actions/upload-artifact@v4
         with:
           name: version
-          path: PYPI_VERSION
+          path: VERSION
 
       - name: Keep SDist
         uses: actions/upload-artifact@v4
@@ -122,13 +123,12 @@ jobs:
       - name: Install conda environment
         run: |
           conda create --yes -p C:\conda_envs\cpp_pkgs -c conda-forge libboost-headers eigen nlohmann_json msgpack-cxx doctest
-
+
+      - uses: ./.github/actions/enable-msvc
+        if: runner.os == 'Windows'
+
       - 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'
-
           # Resolve dirty PATH environment
           # TODO(mgovers): Remove after https://github.com/actions/runner-images/issues/10001 is resolved
           $env:PATH = ($env:PATH -split ';' | Where-Object { $_ -ne 'C:\Program Files\LLVM\bin' }) -join ';'
@@ -150,7 +150,7 @@ jobs:
           install\${{ env.PRESET }}\bin\power_grid_model_package_test; if(!$?) { Exit $LASTEXITCODE }
 
   build-cpp-test-macos:
-    runs-on: macos-14
+    runs-on: macos-15
     strategy:
       matrix:
         build-option: [ debug, release ]
@@ -202,6 +202,9 @@ jobs:
           name: version
           path: .
 
+      - uses: ./.github/actions/enable-msvc
+        if: runner.os == 'Windows'
+
       - name: Set up XCode
         if: matrix.os == 'macos-15'
         uses: maxim-lobanov/setup-xcode@v1
@@ -257,12 +260,12 @@ jobs:
           conda info
           conda list
 
+      - uses: ./.github/actions/enable-msvc
+        if: runner.os == 'Windows'
+
       - name: Build and install cmake target for Windows
         if: matrix.os == 'windows'
         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'
           cmake -GNinja -DCMAKE_BUILD_TYPE=Release -B build/ -S .
           cmake --build build/ --verbose -j1
           cmake --install build/ --prefix ${env:CONDA_PREFIX}/Library
@@ -275,7 +278,7 @@ jobs:
           cmake --install build/
 
       - name: Build python
-        run: python -m pip install . -vv --no-build-isolation --no-deps  
+        run: python -m pip install . --no-build-isolation --no-deps -C wheel.cmake=false
 
       - name: Test
         run: pytest
@@ -319,7 +322,7 @@ jobs:
 
       - name: Get tag
         id: tag
-        run: echo "tag=v$(cat PYPI_VERSION)" >> $GITHUB_OUTPUT
+        run: echo "tag=v$(cat VERSION)" >> $GITHUB_OUTPUT
 
       - name: Display tag
         run: echo "${{ steps.tag.outputs.tag }}"

cmake/pgm_version.cmake

@@ -5,4 +5,5 @@
 cmake_minimum_required (VERSION 3.23)
 
 file(READ "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" _PGM_VERSION)
-string(STRIP ${_PGM_VERSION} PGM_VERSION)
+string(STRIP ${_PGM_VERSION} _PGM_VERSION_STRIPPED)
+string(REGEX REPLACE "^([0-9]+\\.[0-9]+(\\.[0-9]+)?).*" "\\1" PGM_VERSION "${_PGM_VERSION_STRIPPED}")

docs/advanced_documentation/build-guide.md

@@ -91,9 +91,8 @@ The table below shows the Python dependencies
 
 | Library name                                                                            | Remark                   | License                                                                                    |
 | --------------------------------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------ |
-| [pybuild-header-dependency](https://github.com/TonyXiang8787/pybuild-header-dependency) | build dependency         | [BSD-3](https://github.com/TonyXiang8787/pybuild-header-dependency/blob/main/LICENSE)      |
-| [numpy](https://numpy.org/)                                                             | build/runtime dependency | [BSD-3](https://github.com/numpy/numpy/blob/main/LICENSE.txt)                              |
-| [wheel](https://github.com/pypa/wheel)                                                  | build dependency         | [MIT](https://github.com/pypa/wheel/blob/main/LICENSE.txt)                                 |
+| [numpy](https://numpy.org/)                                                             | runtime dependency | [BSD-3](https://github.com/numpy/numpy/blob/main/LICENSE.txt)                              |
+| [scikit-build-core](https://github.com/scikit-build/scikit-build-core)                                                  | build dependency         | [Apache](https://github.com/scikit-build/scikit-build-core/blob/main/LICENSE)                                 |
 | [pytest](https://github.com/pytest-dev/pytest)                                          | Development dependency   | [MIT](https://github.com/pytest-dev/pytest/blob/main/LICENSE)                              |
 | [pytest-cov](https://github.com/pytest-dev/pytest-cov)                                  | Development dependency   | [MIT](https://github.com/pytest-dev/pytest-cov/blob/master/LICENSE)                        |
 | [msgpack-python](https://github.com/msgpack/msgpack-python)                             | Development dependency   | [Apache License, Version 2.0](https://github.com/msgpack/msgpack-python/blob/main/COPYING) |

pyproject.toml

@@ -4,14 +4,10 @@
 
 [build-system]
 requires = [
-    "setuptools",
-    "wheel",
-    "pybuild-header-dependency",
-    "msgpack-cxx",
-    "nlohmann-json",
-    "libboost-headers"
+    "scikit-build-core",
+    "pgm-build-dependencies@git+https://github.com/PowerGridModel/pgm-build-dependencies.git"
 ]
-build-backend = "setuptools.build_meta"
+build-backend = "scikit_build_core.build"
 
 [project]
 name = "power-grid-model"
@@ -55,21 +51,41 @@ doc = [
 ]
 
 [project.urls]
-Home-page = "https://lfenergy.org/projects/power-grid-model/"
-GitHub = "https://github.com/PowerGridModel/power-grid-model"
-Documentation = "https://power-grid-model.readthedocs.io/en/stable/"
-Mailing-list = "https://lists.lfenergy.org/g/powergridmodel"
-Discussion = "https://github.com/orgs/PowerGridModel/discussions"
+homepage = "https://lfenergy.org/projects/power-grid-model/"
+github = "https://github.com/PowerGridModel/power-grid-model"
+documentation = "https://power-grid-model.readthedocs.io/en/stable/"
+mailing-list = "https://lists.lfenergy.org/g/powergridmodel"
+discussion = "https://github.com/orgs/PowerGridModel/discussions"
 
-[tool.setuptools.packages.find]
-where = ["src"]
-namespaces = false
+[project.entry-points."cmake.root"]
+power_grid_model = "power_grid_model.power_grid_model_c"
 
-[tool.setuptools.dynamic]
-version = { file = "PYPI_VERSION" }
+[tool.scikit-build]
+logging.level = "INFO"
+
+cmake.version = ">=3.23"
+cmake.build-type = "Release"
+cmake.args = ["-GNinja"]
+
+build-dir = "build"
+build.tool-args = ["-j1"]
+
+search.site-packages = false
+
+ninja.version = ">=1.10"
+ninja.make-fallback = false
+
+sdist.include = ["CMakeLists.txt", "power_grid_model_c/", "cmake/", "VERSION"]
+
+wheel.install-dir = "power_grid_model/power_grid_model_c"
+wheel.py-api = "py3"
+
+[tool.scikit-build.metadata.version]
+provider = "scikit_build_core.metadata.regex"
+input = "VERSION"
+regex = "^\\s*(?P<version>[^\\s]+)\\s*$"
+result = "{version}"
 
-[tool.setuptools.package-data]
-"power_grid_model" = ["py.typed"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests/unit"]