Merge branch 'main' into test-sparse

Author: figueroa1395

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

@@ -33,7 +33,7 @@ jobs:
     steps:
       - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -260,9 +260,15 @@ jobs:
           conda info
           conda list
 
-      - uses: ./.github/actions/enable-msvc
+      - name: Enable MSVC
+        uses: ./.github/actions/enable-msvc
         if: runner.os == 'Windows'
 
+      - name: Enable gcc/g++
+        if: matrix.os == 'ubuntu'
+        run: |
+          conda install -y gcc_linux-64 gxx_linux-64
+
       - name: Build and install cmake target for Windows
         if: matrix.os == 'windows'
         run: |          
@@ -302,7 +308,7 @@ jobs:
       - uses: actions/checkout@v5
 
       - name: Setup python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
           architecture: x64

.github/workflows/check-code-quality.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
 
@@ -42,14 +42,14 @@ jobs:
 
       - name: Install and run ruff
         run: |
-          pip install ruff .
+          pip install ruff
           ruff check .
           ruff format .
           git restore README.md
 
       - name: Install and run clang-format
         run: |
-          sudo apt-get update && sudo apt-get install -y clang-format-18
+          sudo apt-get install -y clang-format-18
           find . -regex '.*\.\(h\|c\|cpp\|hpp\|cc\|cxx\)' -exec clang-format-18 -style=file -i {} \;
 
       - name: Install and run markdownlint
@@ -60,7 +60,6 @@ jobs:
 
       - name: If needed raise error
         run: |
-
           if [[ `git status --porcelain --untracked-files=no` ]]; then
             echo "Formatting not correct! See below the files which need to be reformatted!"
             git status --porcelain --untracked-files=no

.github/workflows/sonar.yml

@@ -43,15 +43,15 @@ jobs:
         run: |
           brew install boost eigen nlohmann-json msgpack-cxx doctest
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.12"
       - name: Install build-wrapper
         uses: SonarSource/sonarqube-scan-action/install-build-wrapper@v5
 
       - name: Python test and coverage
         run: |
-          pip install -e .[dev]
+          CC=clang CXX=clang++ pip install -e .[dev]
           pytest
 
       - name: Run build-wrapper for C++

.readthedocs.yaml

@@ -11,13 +11,15 @@ sphinx:
 build:
   os: "ubuntu-24.04"
   tools:
-    python: "3.11"
+    python: "3.13"
   apt_packages:
     - graphviz
+    - gcc-14
+    - g++-14
   jobs:
     post_install:
       # Build package with doc requirements from pyproject.optional-dependencies
-      - pip install --verbose --editable .[doc]
+      - CC=gcc-14 CXX=g++-14 pip install --verbose --editable .[doc]
 
       # remove API DLL define in header
       - find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/#define PGM.*//g" {} \;

power_grid_model_c/power_grid_model/include/power_grid_model/common/calculation_info.hpp

@@ -4,13 +4,13 @@
 
 #pragma once
 
-#include "logging_impl.hpp"
+#include "multi_threaded_logging.hpp"
 
 #include <map>
 
 namespace power_grid_model {
 namespace common::logging {
-class CalculationInfo final : public Logger {
+class CalculationInfo : public Logger {
     using Data = std::map<LogEvent, double>;
 
   public:
@@ -85,8 +85,28 @@ class CalculationInfo final : public Logger {
   public:
     Report report() const { return data_; }
     void clear() { data_.clear(); }
+
+    template <std::derived_from<Logger> T> T& merge_into(T& destination) const {
+        if (&destination == this) {
+            return destination; // nothing to do
+        }
+        for (const auto& [tag, value] : report()) {
+            destination.log(tag, value);
+        }
+        return destination;
+    }
+};
+
+class MultiThreadedCalculationInfo : public MultiThreadedLoggerImpl<CalculationInfo> {
+  public:
+    using MultiThreadedLoggerImpl<CalculationInfo>::MultiThreadedLoggerImpl;
+    using Report = CalculationInfo::Report;
+
+    Report report() const { return get().report(); }
+    void clear() { get().clear(); }
 };
 } // namespace common::logging
 
 using common::logging::CalculationInfo;
+using common::logging::MultiThreadedCalculationInfo;
 } // namespace power_grid_model

power_grid_model_c/power_grid_model/include/power_grid_model/common/common.hpp

@@ -6,6 +6,7 @@
 
 #include <cmath>
 #include <complex>
+#include <concepts>
 #include <cstddef>
 #include <cstdint>
 #include <limits>

power_grid_model_c/power_grid_model/include/power_grid_model/common/logging_impl.hpp renamed to power_grid_model_c/power_grid_model/include/power_grid_model/common/dummy_logging.hpp

@@ -24,6 +24,8 @@ class NoLogger : public Logger {
     void log(LogEvent /*tag*/, Idx /*value*/) override {
         // no logging
     }
+
+    template <std::derived_from<Logger> T> T& merge_into(T& destination) const { return destination; }
 };
 
 } // namespace power_grid_model::common::logging

power_grid_model_c/power_grid_model/include/power_grid_model/common/logging.hpp

@@ -60,6 +60,10 @@ class Logger {
     Logger& operator=(Logger const&) = default;
 };
 
+struct MultiThreadedLogger : public Logger {
+    virtual std::unique_ptr<Logger> create_child() = 0;
+};
+
 } // namespace common::logging
 
 using common::logging::LogEvent;

power_grid_model_c/power_grid_model/include/power_grid_model/common/multi_threaded_logging.hpp

@@ -0,0 +1,59 @@
+// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
+//
+// SPDX-License-Identifier: MPL-2.0
+
+#pragma once
+
+#include "dummy_logging.hpp"
+
+#include <cassert>
+#include <mutex>
+
+namespace power_grid_model::common::logging {
+
+template <std::derived_from<Logger> LoggerType>
+    requires requires(LoggerType& destination, LoggerType const& source) {
+        { source.merge_into(destination) };
+    }
+class MultiThreadedLoggerImpl : public MultiThreadedLogger {
+  public:
+    class ThreadLogger : public LoggerType {
+      public:
+        ThreadLogger(MultiThreadedLoggerImpl& parent) : parent_{&parent} {}
+        ThreadLogger(ThreadLogger const&) = default;
+        ThreadLogger& operator=(ThreadLogger const&) = default;
+        ThreadLogger(ThreadLogger&&) noexcept = default;
+        ThreadLogger& operator=(ThreadLogger&&) noexcept = default;
+        ~ThreadLogger() override { sync(); }
+        void sync() const { parent_->sync(*this); }
+
+      private:
+        MultiThreadedLoggerImpl* parent_;
+    };
+
+    std::unique_ptr<Logger> create_child() override { return std::make_unique<ThreadLogger>(*this); }
+    LoggerType& get() { return log_; }
+    LoggerType const& get() const { return log_; }
+
+    void log(LogEvent tag) override { log_.log(tag); }
+    void log(LogEvent tag, std::string_view message) override { log_.log(tag, message); }
+    void log(LogEvent tag, double value) override { log_.log(tag, value); }
+    void log(LogEvent tag, Idx value) override { log_.log(tag, value); }
+
+  private:
+    friend class ThreadLogger;
+
+    LoggerType log_;
+    std::mutex mutex_;
+
+    void sync(ThreadLogger const& logger) {
+        assert(&logger != &log_);
+
+        std::lock_guard const lock{mutex_};
+        logger.merge_into(log_);
+    }
+};
+
+using NoMultiThreadedLogger = MultiThreadedLoggerImpl<NoLogger>;
+
+} // namespace power_grid_model::common::logging

power_grid_model_c/power_grid_model/include/power_grid_model/common/timer.hpp

@@ -17,13 +17,13 @@ using Duration = std::chrono::duration<double>;
 
 class Timer {
   private:
-    Logger* info_;
+    Logger* log_;
     LogEvent code_;
     Clock::time_point start_;
 
   public:
-    Timer() : info_{nullptr}, code_{LogEvent::unknown} {};
-    Timer(Logger& info, LogEvent code) : info_{&info}, code_{code}, start_{Clock::now()} {}
+    Timer() : log_{nullptr}, code_{LogEvent::unknown} {};
+    Timer(Logger& log, LogEvent code) : log_{&log}, code_{code}, start_{Clock::now()} {}
 
     Timer(Timer const&) = delete;
     Timer(Timer&&) = default;
@@ -34,29 +34,29 @@ class Timer {
         stop();
 
         // Copy/move members
-        info_ = timer.info_;
+        log_ = timer.log_;
         code_ = timer.code_;
         start_ = timer.start_;
 
         // Disable original timer
-        timer.info_ = nullptr;
+        timer.log_ = nullptr;
 
         // Return reference
         return *this;
     }
 
     ~Timer() {
-        if (info_ != nullptr) {
+        if (log_ != nullptr) {
             stop();
         }
     }
 
     void stop() {
-        if (info_ != nullptr) {
+        if (log_ != nullptr) {
             auto const now = Clock::now();
             auto const duration = Duration(now - start_);
-            info_->log(code_, duration.count());
-            info_ = nullptr;
+            log_->log(code_, duration.count());
+            log_ = nullptr;
         }
     }
 };