From beae45676388943b0ee1cb0fc149dac369962ed5 Mon Sep 17 00:00:00 2001 From: Martijn Govers Date: Wed, 30 Apr 2025 12:18:42 +0200 Subject: [PATCH 1/2] update build guide Signed-off-by: Martijn Govers --- docs/advanced_documentation/build-guide.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/advanced_documentation/build-guide.md b/docs/advanced_documentation/build-guide.md index 910b46528..505687967 100644 --- a/docs/advanced_documentation/build-guide.md +++ b/docs/advanced_documentation/build-guide.md @@ -175,7 +175,7 @@ You can use any IDE to develop this project. As a popular cross-platform IDE, th ```{note} VSCode (as well as some other IDEs) does not set its own build environment itself. For optimal usage, open the folder -using `cmake ` from a terminal that has the environment set up. See above section for tips. +using `code ` from a terminal that has the environment set up. See above section for tips. ``` ## Build Script for Linux/macOS @@ -194,9 +194,9 @@ Usage: ./build.sh -p [-c] [-e] [-i] [-t] To list the available presets, run `./build.sh -h`. -## Example Setup for Ubuntu 22.04 (in WSL or physical/virtual machine) +## Example Setup for Ubuntu 24.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 ( +In this section an example is given for setup in Ubuntu 24.04. You can use this example in Windows Subsystem for Linux ( WSL), or in a physical/virtual machine. ### Environment variables @@ -286,7 +286,7 @@ or install using cmake --build --preset --target install ``` -## Example Setup for Windows 10 +## Example Setup for Windows 11 Define the following environment variable user-wide: @@ -374,9 +374,9 @@ The IDE should be able to automatically detect the Visual Studio cmake configura Prompt`). ``` -## Example Setup for macOS (Big Sur) +## Example Setup for macOS (Sequoia) -In this section an example is given for setup in macOS Big Sur and Python 3.11. +In this section an example is given for setup in macOS Sequoia and Python 3.11. ### Environment variables From 56eeaed7d047cd533969af49abc4b93d888d4b7d Mon Sep 17 00:00:00 2001 From: Martijn Govers Date: Wed, 30 Apr 2025 15:06:05 +0200 Subject: [PATCH 2/2] fixes before the hackaton/meetup Signed-off-by: Martijn Govers --- CMakeLists.txt | 2 +- docs/advanced_documentation/build-guide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 0f02de07d..1e11f33ad 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,7 +11,7 @@ include("cmake/pgm_version.cmake") project (power_grid_model VERSION ${PGM_VERSION}) -option(PGM_ENABLE_TESTS "Enable tests" OFF) +option(PGM_ENABLE_DEV_BUILD "Enable developer build (e.g.: tests)" OFF) set(CMAKE_CXX_STANDARD 20) set(CMAKE_CXX_STANDARD_REQUIRED ON) diff --git a/docs/advanced_documentation/build-guide.md b/docs/advanced_documentation/build-guide.md index 505687967..9cd77cb5e 100644 --- a/docs/advanced_documentation/build-guide.md +++ b/docs/advanced_documentation/build-guide.md @@ -427,7 +427,7 @@ As an example, go to the root folder of repo. Use the following command to build ./build.sh -p ``` -To list the available presets, run `./build.sh -h`. +To list the available presets, run `cmake --list-presets`. One can run the unit tests and C API example by: