Merge branch 'main' into feature/documentation-on-functionality

Author: petersalemink95

.github/workflows/main.yml

@@ -76,8 +76,7 @@ jobs:
           cmake .. `
             -G "Ninja" `
             -DCMAKE_BUILD_TYPE=${{ matrix.build-option }} `
-            -DCMAKE_PREFIX_PATH=C:\conda_envs\cpp_pkgs\Library `
-            -DPOWER_GRID_MODEL_BUILD_BENCHMARK=1
+            -DCMAKE_PREFIX_PATH=C:\conda_envs\cpp_pkgs\Library
           # build
           cmake --build . --verbose -j 1
           # test
@@ -128,7 +127,7 @@ jobs:
         uses: docker/setup-qemu-action@v2
 
       - name: Build wheels
-        uses: pypa/[email protected].2
+        uses: pypa/[email protected].3
         # GitHub Actions specific build parameters
         env:
           # pass GitHub runner info into Linux container

.gitignore

@@ -486,7 +486,6 @@ dmypy.json
 .pyre/
 
 # build
-.vscode/
 src/power_grid_model/**/*.cpp
 cpp_build*/
 
@@ -509,4 +508,11 @@ PYPI_VERSION
 
 # docs builds
 docs/make.bat
-docs/Makefile
+docs/Makefile
+
+# VSCode configurations
+# it is ignored by default so the user does not accidentally change the configuration
+# if you want to changes the JSON file in .vscode folder
+# please type
+#    git add .vscode/ --force
+.vscode/

.vscode/extensions.json

@@ -0,0 +1,29 @@
+// SPDX-FileCopyrightText: 2022 Contributors to the Power Grid Model project <[email protected]>
+//
+// SPDX-License-Identifier: MPL-2.0
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"bungcip.better-toml",
+		"ms-python.black-formatter",
+		"ms-python.isort",
+		"ms-python.python",
+		"ms-python.vscode-pylance",
+		"ms-toolsai.jupyter",
+		"ms-toolsai.jupyter-keymap",
+		"ms-toolsai.jupyter-renderers",
+		"ms-toolsai.vscode-jupyter-cell-tags",
+		"ms-toolsai.vscode-jupyter-slideshow",
+		"ms-vscode.cmake-tools",
+		"ms-vscode.cpptools",
+		"ms-vscode.cpptools-extension-pack",
+		"ms-vscode.cpptools-themes",
+		"ms-vscode.test-adapter-converter",
+		"njpwerner.autodocstring",
+		"jeff-hykin.better-cpp-syntax",
+		"twxs.cmake",
+		"matepek.vscode-catch2-test-adapter"
+	]
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+// SPDX-FileCopyrightText: 2022 Contributors to the Power Grid Model project <[email protected]>
+//
+// SPDX-License-Identifier: MPL-2.0
+{
+    "cmake.buildDirectory": "${workspaceFolder}/cpp_build_${buildType}",
+    "C_Cpp.autoAddFileAssociations": false,
+    "cmake.configureOnOpen": true,
+    "testMate.cpp.test.executables": "cpp_build_${command:cmake.buildType}/tests/cpp_unit_tests/power_grid_model_unit_tests",
+    "python.testing.pytestArgs": [
+        "tests",
+        "--no-cov"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+}

CMakeLists.txt

@@ -53,8 +53,4 @@ endif()
 add_subdirectory(tests/cpp_unit_tests)
 
 # get benchmark
-if(DEFINED POWER_GRID_MODEL_BUILD_BENCHMARK AND POWER_GRID_MODEL_BUILD_BENCHMARK EQUAL 1)
-	add_subdirectory(tests/benchmark_cpp)
-endif()
-
-
+add_subdirectory(tests/benchmark_cpp)

CMakeSettings.json

@@ -7,7 +7,6 @@
       "inheritEnvironments": [ "msvc_x64_x64" ],
       "buildRoot": "${projectDir}\\cpp_build\\${name}",
       "installRoot": "${projectDir}\\install\\${name}",
-      "cmakeCommandArgs": "-DPOWER_GRID_MODEL_BUILD_BENCHMARK=1",
       "buildCommandArgs": "-v",
       "ctestCommandArgs": ""
     },
@@ -17,7 +16,6 @@
       "configurationType": "RelWithDebInfo",
       "buildRoot": "${projectDir}\\cpp_build\\${name}",
       "installRoot": "${projectDir}\\install\\${name}",
-      "cmakeCommandArgs": "-DPOWER_GRID_MODEL_BUILD_BENCHMARK=1",
       "buildCommandArgs": "-v",
       "ctestCommandArgs": "",
       "inheritEnvironments": [ "msvc_x64_x64" ]

build.sh

@@ -32,7 +32,6 @@ cd ${BUILD_DIR}
 cmake .. -GNinja \
     -DCMAKE_BUILD_TYPE=$1 \
     ${PATH_FOR_CMAKE} \
-    -DPOWER_GRID_MODEL_BUILD_BENCHMARK=1 \
     ${BUILD_COVERAGE}
 # build
 VERBOSE=1 cmake --build .

docs/advanced_documentation/build-guide.md

@@ -108,13 +108,16 @@ library `power_grid_model`. There are two sub-projects defined in the root cmake
 
 In principle, you can use any C++ IDE with cmake and ninja support to develop the C++ project. When you
 use `cmake build` for the root cmake file, the following additional options are available besides the standard cmake
-option. If no option is defined, the cmake project will build the unit tests.
+option.
 
 | Option                             | Description                                                                                                 |
 |------------------------------------|-------------------------------------------------------------------------------------------------------------|
-| `POWER_GRID_MODEL_BUILD_BENCHMARK` | When set to `1`, build the both sub-projects: unit test and benchmarks. Otherwise only build the unit test. |
 | `POWER_GRID_MODEL_COVERAGE`        | When set to `1`, build with test coverage. This is only applicable for Linux.                               |
 
+## Visual Studio Code Support
+
+You can use any IDE to develop this project. As a popular cross-platform IDE, the settings for Visual Studio Code is preconfigured in the folder `.vscode`. You can open the repository folder with VSCode and the configuration will be loaded automatically.
+
 ## Example Setup for Ubuntu 22.04 (in WSL or physical/virtual machine)
 
 In this section an example is given for setup in Ubuntu 22.04. You can use this example in Windows Subsystem for Linux (