Merge pull request #725 from PowerGridModel/fix/build-guide

Renew build guide

Author: TonyXiang8787

docs/advanced_documentation/build-guide.md

@@ -11,12 +11,12 @@ repository there are three builds:
 
 * A `power-grid-model` [pip](https://pypi.org/project/power-grid-model/) Python package with C++ extension as the calculation core.
 * A [CMake](https://cmake.org/) project consisting of the C++ header-only calculation core, and the following build targets:
-    * A dynamic library (`.dll` or `.so`) with stable pure C API/ABI which can be used by any application
+    * A dynamic library (`.dll` or `.so`) with stable pure C API/ABI which can be used by any application (enabled by default)
+    * An install target that installs the package containing the dynamic library (enabled by default)
     * Native C++ unit tests
     * C API tests
     * A performance benchmark program
     * An example C program to call the shared library
-    * An install target that installs a package that contains the dynamic library
 * A separate example [CMake](https://cmake.org/) project with a small C++ program that shows how to find and use the installable
   package.
 
@@ -65,7 +65,7 @@ You can define the environment variable `CXX` to for example `clang++` to specif
 
 ### Build System for CMake Project
 
-This repository uses [CMake](https://cmake.org/) (version 3.23 or later) and [Ninja](https://ninja-build.org/) as C++ build system.
+This repository uses [CMake](https://cmake.org/) (version 3.23 or later) as C++ build system.
 
 ### Build Dependencies
 
@@ -97,43 +97,57 @@ The table below shows the Python dependencies
 ## Build Python Package
 
 Once you have prepared the build dependencies, 
-you can install the library from source in develop mode with the development dependency. 
+you can install the library from source in editable mode with the development dependency. 
 Go to the root folder of the repository.
 
-```
+```shell
 pip install -e .[dev]
 ```
 
 Then you can run the tests.
 
-```
+```shell
 pytest
 ```
 
 A basic `self_test` function is provided to check if the installation was successful and ensures there are no build errors, segmentation violations, undefined symbols, etc. It performs multiple C API calls, runs through the main data flow, and verifies the integrity of serialization and deserialization.
 
-```
+```python
 from power_grid_model.utils import self_test
 self_test()
 ```
 
 ## Build CMake Project
 
-There is a root cmake file in the root folder of the repo `CMakeLists.txt`. It specifies
-dependencies and the build options for the project. The core algorithm is implemented in the header-only
-library `power_grid_model`. There are four sub-projects defined in the root cmake file:
+### User build
+
+If you are a C-API user of the library, you can build the CMake using all the default settings.
+You can specifiy a standard [CMAKE_BUILD_TYPE](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html).
+This will only build the core C-API dynamic library.
+
+```shell
+cmake -DCMAKE_BUILD_TYPE=Release -B build
+cmake --build build --config Release
+```
+
+### Developer build
+
+If you opt for a developer build of Power Grid Model, 
+you can use the pre-defined CMake presets to enable developer build, including all the tests, warnings, examples, and benchmark. In the presets the [Ninja](https://ninja-build.org/) generator is used. 
+In principle, you can use any C++ IDE with cmake and ninja support to develop the C++ project.
+It is also possible to use the bare CMake CLI to set up the project. 
+Supported presets for your development platform can be listed using `cmake --list-presets`.
+
+In the developer build the following build targets (directories) are enabled:
 
 * `power_grid_model_c`: a dynamic library (`.dll` or `.so`) with stable pure C API/ABI which can be used by any application
 * `tests/cpp_unit_tests`: the unit test target for the C++ core using the `doctest` framework.
 * `tests/cpp_integration_tests`: the integration test target for the C++ core using the `doctest` framework.
 * `tests/cpp_validation_tests`: the validation test target using the `doctest` framework
-* `tests/c_api_tests`: the C API test target using the `doctest` framework
+* `tests/native_api_tests`: the C API test target using the `doctest` framework
 * `tests/benchmark_cpp`: the C++ benchmark target for performance measure.
 * `power_grid_model_c_example`: an example C program to call the dynamic library
 
-In principle, you can use any C++ IDE with cmake and ninja support to develop the C++ project. It is also possible to use
-the bare CMake CLI to set up the project. For ease of use, several presets are available (CMake 3.23+). Supported presets
-for your development platform can be listed using `cmake --list-presets`.
 
 On Linux/macOS, the presets will use command `clang`/`clang++` or `gcc`/`g++` to find the relevant `clang` or `gcc` compiler. It is the developer's reponsiblity to properly define symbolic links (which should be discoverable through `PATH` environment variable) of `clang` or `gcc` compiler in your system. If you want to build with `clang-tidy`, you also need to define symbolic link of `clang-tidy` to point to the actual `clang-tidy` executable of your system.