Merge pull request #722 from Pressio/718-investigate-improved-logger

#718: implement pressio-log as logger
Pressio · Feb 26, 2025 · 54ed896 · 54ed896
2 parents 4077a90 + 73aeb23
commit 54ed896
Show file tree

Hide file tree

Showing 197 changed files with 253 additions and 33,912 deletions.
diff --git a/.github/workflows/ci-baseline.yml b/.github/workflows/ci-baseline.yml
@@ -66,7 +66,14 @@ jobs:
         with:
           repository: Pressio/pressio-templates-usage-as-library
           path: examples
-          ref: add-compatibility-with-pressio-ops
+          ref: main
+
+      - name: Checkout pressio-log
+        uses: actions/checkout@v4
+        with:
+          repository: Pressio/pressio-log
+          path: pressio-log
+          ref: main
 
       - name: Checkout pressio-ops
         uses: actions/checkout@v4
@@ -91,10 +98,10 @@ jobs:
             -D CMAKE_INSTALL_PREFIX:PATH=${PRESSIO_INSTALL_DIR} \
             -D CMAKE_VERBOSE_MAKEFILE:BOOL=ON \
             ${{ matrix.cmake_extra_args }} \
-            -D PRESSIO_ENABLE_DEBUG_PRINT=ON \
             -D PRESSIO_ENABLE_TESTS:BOOL=ON \
             -D PRESSIO_ENABLE_TPL_EIGEN:BOOL=ON \
             -D EIGEN_INCLUDE_DIR=/eigen/eigen-${{ env.eigen_version }} \
+            -D PRESSIO_LOG_INCLUDE_DIR=${GITHUB_WORKSPACE}/pressio-log/include \
             -D PRESSIO_OPS_INCLUDE_DIR=${GITHUB_WORKSPACE}/pressio-ops/include
 
       - name: Build
@@ -108,6 +115,7 @@ jobs:
             --std=c++17 \
             -DPRESSIO_ENABLE_TPL_EIGEN \
             -I/eigen/eigen-${{ env.eigen_version }} \
+            -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
             -I${PRESSIO_INSTALL_DIR}/include \
             -c main.cpp                \
@@ -120,6 +128,7 @@ jobs:
           $CXX \
             --std=c++17 \
             -I/eigen/eigen-${{ env.eigen_version }} \
+            -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
             -I${PRESSIO_INSTALL_DIR}/include \
             -c main_with_defines.cpp   \

diff --git a/.github/workflows/ci-kokkos.yml b/.github/workflows/ci-kokkos.yml
@@ -57,7 +57,14 @@ jobs:
         with:
           repository: Pressio/pressio-templates-usage-as-library
           path: examples
-          ref: add-compatibility-with-pressio-ops
+          ref: main
+
+      - name: Checkout pressio-log
+        uses: actions/checkout@v4
+        with:
+          repository: Pressio/pressio-log
+          path: pressio-log
+          ref: main
 
       - name: Checkout pressio-ops
         uses: actions/checkout@v4
@@ -79,7 +86,6 @@ jobs:
             -D PRESSIO_ENABLE_TPL_KOKKOS:BOOL=ON \
             -D Kokkos_ROOT=/kokkos/install \
             -D KokkosKernels_ROOT=/kokkos-kernels/install \
-            -D PRESSIO_ENABLE_DEBUG_PRINT=ON \
             -D CMAKE_INSTALL_PREFIX:PATH=${PRESSIO_INSTALL_DIR} \
             -D CMAKE_CXX_FLAGS='-Wall -Werror'
 
@@ -94,6 +100,7 @@ jobs:
             -DPRESSIO_ENABLE_TPL_KOKKOS \
             -I/kokkos/install/include \
             -I/kokkos-kernels/install/include \
+            -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
             -I${PRESSIO_INSTALL_DIR}/include \
             -c main.cpp
@@ -106,6 +113,7 @@ jobs:
             -DPRESSIO_ENABLE_TPL_KOKKOS \
             -I/kokkos/install/include \
             -I/kokkos-kernels/install/include \
+            -I${GITHUB_WORKSPACE}/pressio-log/include \
             -I${GITHUB_WORKSPACE}/pressio-ops/include \
             -I${PRESSIO_INSTALL_DIR}/include \
             -c main_with_defines.cpp

diff --git a/.github/workflows/ci-trilinos.yml b/.github/workflows/ci-trilinos.yml
@@ -55,7 +55,14 @@ jobs:
       with:
         repository: Pressio/pressio-templates-usage-as-library
         path: examples
-        ref: add-compatibility-with-pressio-ops
+        ref: main
+
+    - name: Checkout pressio-log
+      uses: actions/checkout@v4
+      with:
+        repository: Pressio/pressio-log
+        path: pressio-log
+        ref: main
 
     - name: Checkout pressio-ops
       uses: actions/checkout@v4
@@ -86,7 +93,6 @@ jobs:
           -D PRESSIO_ENABLE_TPL_KOKKOS:BOOL=ON \
           -D PRESSIO_ENABLE_TPL_BLAS:BOOL=ON \
           -D PRESSIO_ENABLE_TPL_LAPACK:BOOL=ON \
-          -D PRESSIO_ENABLE_DEBUG_PRINT=ON \
           -D EIGEN_INCLUDE_DIR=/eigen/eigen-${{ env.eigen_version }} \
           -D Trilinos_DIR=${{ env.trilinos_dir }}/lib/cmake/Trilinos \
           -D CMAKE_INSTALL_PREFIX:PATH=${PRESSIO_INSTALL_DIR} \
@@ -104,6 +110,7 @@ jobs:
           -DPRESSIO_ENABLE_TPL_TRILINOS \
           -I/eigen/eigen-${{ env.eigen_version }} \
           -I$trilinos_dir/include       \
+          -I${GITHUB_WORKSPACE}/pressio-log/include \
           -I${GITHUB_WORKSPACE}/pressio-ops/include \
           -I${PRESSIO_INSTALL_DIR}/include \
           -c main.cpp
@@ -116,6 +123,7 @@ jobs:
           -DPRESSIO_ENABLE_TPL_TRILINOS \
           -I/eigen/eigen-${{ env.eigen_version }} \
           -I$trilinos_dir/include       \
+          -I${GITHUB_WORKSPACE}/pressio-log/include \
           -I${GITHUB_WORKSPACE}/pressio-ops/include \
           -I${PRESSIO_INSTALL_DIR}/include \
           -c main_with_defines.cpp

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,25 +8,51 @@ include(colors)
 #=====================================================================
 if(PRESSIO_OPS_INCLUDE_DIR)
   message("${Green}-- Using ${PRESSIO_OPS_INCLUDE_DIR}")
-  include_directories(SYSTEM ${PRESSIO_OPS_INCLUDE_DIR})
-
 else()
-
   include(FetchContent)
   message("${Green}-- PRESSIO_OPS_INCLUDE_DIR is not defined, so fetching pressio-ops...")
-
   FetchContent_Declare(
     pressio-ops
     GIT_REPOSITORY https://github.com/Pressio/pressio-ops.git
     GIT_TAG        develop
     GIT_PROGRESS   TRUE
     GIT_SHALLOW    TRUE
   )
-
   FetchContent_MakeAvailable(pressio-ops)
   set(PRESSIO_OPS_INCLUDE_DIR ${pressio-ops_SOURCE_DIR}/include)
 endif()
 
+# logging
+#=====================================================================
+option(PRESSIO_ENABLE_LOGGING "Enable logging via pressio-log" ON)
+if (PRESSIO_ENABLE_LOGGING)
+  add_compile_definitions(PRESSIO_ENABLE_LOGGING=1)
+else()
+  add_compile_definitions(PRESSIO_ENABLE_LOGGING=0)
+endif()
+
+# get pressio-log (either find it or fetch it)
+message(STATUS "PRESSIO_ENABLE_LOGGING = ${PRESSIO_ENABLE_LOGGING}")
+if (PRESSIO_ENABLE_LOGGING)
+  if(PRESSIO_LOG_INCLUDE_DIR)
+    message("${Green}-- Using ${PRESSIO_LOG_INCLUDE_DIR}")
+  else()
+    include(FetchContent)
+    message("${Green}-- PRESSIO_LOG_INCLUDE_DIR is not defined, so fetching pressio-log...")
+    FetchContent_Declare(
+      pressio-log
+      GIT_REPOSITORY https://github.com/Pressio/pressio-log.git
+      GIT_TAG        main
+      GIT_PROGRESS   TRUE
+      GIT_SHALLOW    TRUE
+    )
+    FetchContent_MakeAvailable(pressio-log)
+    set(PRESSIO_LOG_INCLUDE_DIR ${pressio-log_SOURCE_DIR}/include)
+  endif()
+else()
+  message(STATUS "Logging has been disabled (PRESSIO_ENABLE_LOGGING=OFF)")
+endif()
+
 # versioning
 #=====================================================================
 # adapted from Eigen
@@ -77,6 +103,13 @@ if(PRESSIO_ENABLE_TESTS)
     "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include;${PRESSIO_OPS_INCLUDE_DIR}>"
   )
 
+  if (PRESSIO_ENABLE_LOGGING)
+    target_include_directories(
+      pressio INTERFACE
+      "$<BUILD_INTERFACE:${PRESSIO_LOG_INCLUDE_DIR}>"
+    )
+  endif()
+
   enable_testing()
   add_subdirectory(tests)
 endif()
diff --git a/docs/source/components/utils.rst b/docs/source/components/utils.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -158,7 +158,6 @@ open an issue on `github <https://github.com/Pressio/pressio>`_.
    ./components/ode
    ./components/nonlinsolvers
    ./components/linsolvers
-   ./components/utils
 
 .. toctree::
    :caption: Miscellanea

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -89,7 +89,7 @@ or you can pick a `release version <https://github.com/Pressio/pressio/releases>
 
 3. Use cmake to configure by passing to the comand line the target list of cmake variables to define.
 
-For example, suppose we want to enable support for Trilinos and the debug prints. We would do:
+For example, suppose we want to enable support for Trilinos and the loger. We would do:
 
 .. code-block:: bash
 
@@ -98,7 +98,7 @@ For example, suppose we want to enable support for Trilinos and the debug prints
 
    cmake -D CMAKE_INSTALL_PREFIX=../install \
          -D PRESSIO_ENABLE_TPL_TRILINOS=ON \
-         -D PRESSIO_ENABLE_DEBUG_PRINT=ON \
+         -D PRESSIO_ENABLE_LOGGING=ON \
          ${PRESSIO_SRC}
 
    make install # nothing is built, just headers copied to installation