[1.3.37] 2025-06-27

* Updated `utilities/run_samples.sh` to have an option to redirect command outputs to a user-specified log file.
* Updated all testing workflows to print the output log if the run fails.
* Many documentation updates and fixes.
* Renamed this file to `CHANGELOG.md` and added markdown formatting.

🚨+ NEW PLUG-IN + 🚨
- Added a new plant hydraulics plug-in. Credit to Kyle Rizzo for developing this plug-in.

## Context
- Added overloaded + and - operators for `helios::RGBcolor` and `helios::RGBAcolor` vector types.

## Plant Architecture
- Fixed a bug in `PlantArchitecture::interpolateTube()`.
- Added 10 self-tests.

## Radiation
- Refined `RadiationModel::applyImageProcessingPipeline()`. It now performs a standard set of processing steps, and has an option to apply HDR toning.

Author: bnbailey-psl

.clang-format

@@ -6,6 +6,7 @@ AlignConsecutiveAssignments: false
 AlignConsecutiveDeclarations: false
 AlignOperands: true
 AlignTrailingComments: false
+AllowShortFunctionsOnASingleLine: None
 AlwaysBreakTemplateDeclarations: Yes
 BraceWrapping: 
   AfterCaseLabel: false

.github/workflows/linux_GPU_selftests.yaml

@@ -36,7 +36,11 @@ jobs:
       - name: Bash script
         run: |
           cd utilities
-          ./run_samples.sh --visbuildonly
+          if ! ./run_samples.sh --visbuildonly --log-file linux_GPU_selftests.log; then
+            echo "==== run_samples.sh failed; dumping linux_GPU_selftests.log ===="
+            cat linux_GPU_selftests.log
+            exit 1
+          fi
   
 
   stop-gpu:

.github/workflows/linux_selftests.yaml

@@ -42,4 +42,8 @@ jobs:
       - name: Bash script
         run: |
           cd utilities
-          ./run_samples.sh --nogpu --visbuildonly
+          if ! ./run_samples.sh --nogpu --visbuildonly --log-file linux_selftests.log; then
+            echo "==== run_samples.sh failed; dumping linux_selftests.log ===="
+            cat linux_selftests.log
+            exit 1
+          fi

.github/workflows/mac_selftests.yaml

@@ -28,4 +28,8 @@ jobs:
       - name: Bash script
         run: |
           cd utilities
-          ./run_samples.sh --nogpu --visbuildonly
+          if ! ./run_samples.sh --nogpu --visbuildonly --log-file macos_selftests.log; then
+            echo "==== run_samples.sh failed; dumping macos_selftests.log ===="
+            cat macos_selftests.log
+            exit 1
+          fi

.github/workflows/windows_selftests.yaml

@@ -23,6 +23,11 @@ jobs:
       - uses: ilammy/msvc-dev-cmd@v1
 
       - name: Bash script
+        shell: bash
         run: |
           cd utilities
-          sh run_samples.sh --nogpu --visbuildonly
+          if ! ./run_samples.sh --nogpu --visbuildonly --log-file windows_selftests.log; then
+            echo "==== run_samples.sh failed; dumping windows_selftests.log ===="
+            cat windows_selftests.log
+            exit 1
+          fi

core/CMakeLists.txt

@@ -25,6 +25,9 @@ target_include_directories(helios
 )
 
 # External libraries
+set(SAVED_LOG_LEVEL ${CMAKE_MESSAGE_LOG_LEVEL})
+set(CMAKE_MESSAGE_LOG_LEVEL WARNING)
+
 include_directories( "${CMAKE_CURRENT_SOURCE_DIR}/lib/zlib")
 add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/lib/zlib"     "${CMAKE_BINARY_DIR}/lib/zlib")
 
@@ -37,6 +40,8 @@ add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/lib/libjpeg-9a" "${CMAKE_BINARY_DI
 
 target_link_libraries( helios PRIVATE png_static  jpeg ) #note that zlib is already linked by libpng
 
+set(CMAKE_MESSAGE_LOG_LEVEL ${SAVED_LOG_LEVEL})
+
 file( COPY "${CMAKE_CURRENT_SOURCE_DIR}/lib/images" DESTINATION "${CMAKE_BINARY_DIR}/lib/" )
 file( COPY "${CMAKE_CURRENT_SOURCE_DIR}/lib/models" DESTINATION "${CMAKE_BINARY_DIR}/lib/" )
 file( COPY "${CMAKE_CURRENT_SOURCE_DIR}/lib/testdata" DESTINATION "${CMAKE_BINARY_DIR}/lib/" )

core/CMake_project.cmake

@@ -18,6 +18,7 @@ if(GIT_FOUND)
             OUTPUT_VARIABLE GIT_COMMIT_HASH
             OUTPUT_STRIP_TRAILING_WHITESPACE
     )
+    message( STATUS "[Helios] Detected Git commit hash: ${GIT_COMMIT_HASH}" )
 else()
     set(GIT_COMMIT_HASH "unknown")
 endif()
@@ -26,6 +27,7 @@ endif()
 if(NOT DEFINED HELIOS_PREVIOUS_COMMIT)
     set(HELIOS_PREVIOUS_COMMIT "" CACHE STRING "Last configured Helios Git commit")
 endif()
+message( STATUS "[Helios] Last configured Helios Git commit hash: ${HELIOS_PREVIOUS_COMMIT}" )
 
 if(NOT HELIOS_PREVIOUS_COMMIT STREQUAL GIT_COMMIT_HASH)
   message(STATUS "[Helios] Git commit version change detected, automatically re-configuring...")
@@ -75,11 +77,11 @@ endif()
 
 # -- linking plug-ins --#
 LIST(LENGTH PLUGINS PLUGIN_COUNT)
-message("-- Loading ${PLUGIN_COUNT} plug-ins")
+message( STATUS "[Helios] Loading ${PLUGIN_COUNT} plug-ins")
 foreach(PLUGIN ${PLUGINS})
-    message("-- loading plug-in ${PLUGIN}")
+    message( STATUS "[Helios] Loading plug-in ${PLUGIN}")
     if( ${PLUGIN} STREQUAL ${EXECUTABLE_NAME} )
-        message( FATAL_ERROR "The executable name cannot be the same as a plugin name. Please rename your executable." )
+        message( FATAL_ERROR "[Helios] The executable name cannot be the same as a plugin name. Please rename your executable." )
     endif()
     add_subdirectory( "${BASE_DIRECTORY}/plugins/${PLUGIN}" "${PROJECT_BINARY_DIR}/plugins/${PLUGIN}" )
     target_link_libraries( ${EXECUTABLE_NAME} ${PLUGIN} )
@@ -98,14 +100,14 @@ target_include_directories(helios PUBLIC "$<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/
 if( ENABLE_OPENMP )
     find_package(OpenMP)
     if (OpenMP_CXX_FOUND)
-        message( "-- Enabling experimental OpenMP support" )
+        message( STATUS "[Helios] Enabling experimental OpenMP support" )
         target_link_libraries(helios PUBLIC OpenMP::OpenMP_CXX)
         target_compile_definitions(helios PUBLIC USE_OPENMP)
     else()
         if(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
-            message(WARNING "You are using Apple Clang compiler, which does not support OpenMP. The program will compile without OpenMP support.")
+            message(WARNING "[Helios] You are using Apple Clang compiler, which does not support OpenMP. The program will compile without OpenMP support.")
         else()
-            message(WARNING "OpenMP not found! The program will compile without OpenMP support.")
+            message(WARNING "[Helios] OpenMP not found! The program will compile without OpenMP support.")
         endif()
     endif()
 endif()