Skip to content

Meet-up hackathon: update build guide #980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 1, 2025
Merged

Meet-up hackathon: update build guide #980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
beae456
update build guide
mgovers Apr 30, 2025
56eeaed
fixes before the hackaton/meetup
mgovers Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
14 changes: 7 additions & 7 deletions docs/advanced_documentation/build-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <project_dir>` from a terminal that has the environment set up. See above section for tips.
using `code <project_dir>` from a terminal that has the environment set up. See above section for tips.
```

## Build Script for Linux/macOS
Expand All @@ -194,9 +194,9 @@ Usage: ./build.sh -p <preset> [-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
Expand Down Expand Up @@ -286,7 +286,7 @@ or install using
cmake --build --preset <preset> --target install
```

## Example Setup for Windows 10
## Example Setup for Windows 11

Define the following environment variable user-wide:

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -427,7 +427,7 @@ As an example, go to the root folder of repo. Use the following command to build
./build.sh -p <preset>
```

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:

Expand Down
Loading