Enhance regression suite: migrate more tests, unify reference data, and improve plotting

- Migrated additional test cases (including sphere regular/irregular) into the regression suite for automated validation.
- Standardized reference data file naming convention to use the `hc_ref_` prefix for all relevant tests (sphere, F3OF, etc.), improving clarity and consistency.
- Updated and replaced outdated reference data files with results from the latest simulations to ensure up-to-date comparisons.
- Fixed comparison scripts to search for result files in the build directory, resolving issues with missing or misplaced outputs.
- Generated and saved comparison plots for all migrated tests, ensuring visual validation is available for regular, irregular, and decay cases.
- Improved plot info panels: renamed "Simulation File" to "Latest File" and shortened file paths for better readability.
- Added or updated comparison scripts (e.g., for F3OF DT3) to support new file locations and naming conventions.
- Confirmed all regression tests pass and generate correct plots.

Author: dav-og

tests/regression/CMakeLists.txt

@@ -146,7 +146,7 @@ if(TARGET f3of_dt1_test)
 
     # Reference comparison test - use the new centralized reference data location
     set(FILE_RST ${F3OF_RESULTS_DIR}/CHRONO_F3OF_DT1_SURGE.txt)
-    set(FILE_REF ${CMAKE_SOURCE_DIR}/tests/regression/reference_data/f3of/dt1/hydrochrono_f3of_dt1_surge.txt)
+    set(FILE_REF ${CMAKE_SOURCE_DIR}/tests/regression/reference_data/f3of/dt1/hc_ref_f3of_dt1_surge.txt)
 
     add_test(
         NAME f3of_dt1_regression_ref
@@ -226,7 +226,7 @@ if(TARGET f3of_dt2_test)
 
     # Reference comparison test - use the new centralized reference data location
     set(FILE_RST ${F3OF_RESULTS_DIR}/CHRONO_F3OF_DT2_PITCH.txt)
-    set(FILE_REF ${CMAKE_SOURCE_DIR}/tests/regression/reference_data/f3of/dt2/hydrochrono_f3of_dt2_pitch.txt)
+    set(FILE_REF ${CMAKE_SOURCE_DIR}/tests/regression/reference_data/f3of/dt2/hc_ref_f3of_dt2_pitch.txt)
 
     add_test(
         NAME f3of_dt2_regression_ref
@@ -306,7 +306,7 @@ if(TARGET f3of_dt3_test)
 
     # Reference comparison test - use the new centralized reference data location
     set(FILE_RST ${F3OF_RESULTS_DIR}/f3of_dt3.txt)
-    set(FILE_REF ${CMAKE_SOURCE_DIR}/tests/regression/reference_data/f3of/dt3/hydrochrono_f3of_dt3_flap_pitch.txt)
+    set(FILE_REF ${CMAKE_SOURCE_DIR}/tests/regression/reference_data/f3of/dt3/hc_ref_f3of_dt3_flap_pitch.txt)
 
     add_test(
         NAME f3of_dt3_regression_ref
@@ -321,4 +321,247 @@ if(TARGET f3of_dt3_test)
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tests/regression/f3of
         ENVIRONMENT "PATH=${Python3_ROOT_DIR};$ENV{PATH};HYDROCHRONO_BUILD_DIR=${CMAKE_BINARY_DIR}"
     )
+endif() 
+
+# Sphere Regular Waves Regression Test
+# ===================================
+
+# Create executable in model-based directory
+add_executable(sphere_reg_waves_test)
+
+set(SPHERE_REG_WAVES_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphere/reg_waves)
+set(SPHERE_REG_WAVES_RELEASE_DIR ${CMAKE_BINARY_DIR}/tests/regression/Release/sphere/reg_waves)
+set(SPHERE_REG_WAVES_RESULTS_DIR ${SPHERE_REG_WAVES_RELEASE_DIR}/results)
+
+# Use model-based source and let simulation create results automatically
+set_target_properties(sphere_reg_waves_test
+    PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY ${SPHERE_REG_WAVES_RELEASE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY_DEBUG ${SPHERE_REG_WAVES_RELEASE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY_RELEASE ${SPHERE_REG_WAVES_RELEASE_DIR}
+)
+
+target_sources(
+    sphere_reg_waves_test
+    PRIVATE
+        ${SPHERE_REG_WAVES_SRC_DIR}/sphere_reg_waves_test.cpp
+)
+
+if(HYDROCHRONO_ENABLE_IRRLICHT)
+    target_compile_definitions(sphere_reg_waves_test 
+        PRIVATE 
+        HYDROCHRONO_HAVE_IRRLICHT=1
+        "CHRONO_DATA_DIR=\"${CHRONO_DATA_DIR}\""
+    )
+endif()
+
+target_include_directories(
+    sphere_reg_waves_test
+    PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../src
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../src/gui
+)
+
+target_link_libraries(
+    sphere_reg_waves_test
+    PRIVATE
+        HydroChrono
+        HydroChronoGUI
+)
+
+# Register as CTest test
+if(TARGET sphere_reg_waves_test)
+    # Copy test data to the output directory
+    file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/data DESTINATION ${CMAKE_BINARY_DIR}/tests/regression/Release)
+    
+    add_test(
+        NAME sphere_reg_waves_regression
+        COMMAND ${SPHERE_REG_WAVES_RELEASE_DIR}/sphere_reg_waves_test.exe ${HYDROCHRONO_DATA_DIR} --nogui
+    )
+    
+    set_tests_properties(
+        sphere_reg_waves_regression
+        PROPERTIES 
+        LABELS "regression;sphere;reg_waves;core"
+        FIXTURES_SETUP sphere_reg_waves_regression_file
+        WORKING_DIRECTORY ${SPHERE_REG_WAVES_RELEASE_DIR}
+        ENVIRONMENT "${TEST_ENVIRONMENT}"
+    )
+
+    # Reference comparison test
+    add_test(
+        NAME sphere_reg_waves_regression_ref
+        COMMAND python ${CMAKE_SOURCE_DIR}/tests/regression/sphere/reg_waves/compare.py
+    )
+    
+    set_tests_properties(
+        sphere_reg_waves_regression_ref
+        PROPERTIES 
+        LABELS "regression;sphere;reg_waves;reference;core"
+        FIXTURES_REQUIRED sphere_reg_waves_regression_file
+        WORKING_DIRECTORY ${SPHERE_REG_WAVES_RELEASE_DIR}
+        ENVIRONMENT "PATH=${Python3_ROOT_DIR};$ENV{PATH};HYDROCHRONO_BUILD_DIR=${CMAKE_BINARY_DIR}"
+    )
+endif() 
+
+# Sphere Irregular Waves Regression Test
+# =====================================
+
+# Create executable in model-based directory
+add_executable(sphere_irreg_waves_test)
+
+set(SPHERE_IRREG_WAVES_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphere/irreg_waves)
+set(SPHERE_IRREG_WAVES_RELEASE_DIR ${CMAKE_BINARY_DIR}/tests/regression/Release/sphere/irreg_waves)
+set(SPHERE_IRREG_WAVES_RESULTS_DIR ${SPHERE_IRREG_WAVES_RELEASE_DIR}/results)
+
+# Use model-based source and let simulation create results automatically
+set_target_properties(sphere_irreg_waves_test
+    PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY ${SPHERE_IRREG_WAVES_RELEASE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY_DEBUG ${SPHERE_IRREG_WAVES_RELEASE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY_RELEASE ${SPHERE_IRREG_WAVES_RELEASE_DIR}
+)
+
+target_sources(
+    sphere_irreg_waves_test
+    PRIVATE
+        ${SPHERE_IRREG_WAVES_SRC_DIR}/sphere_irreg_waves_test.cpp
+)
+
+if(HYDROCHRONO_ENABLE_IRRLICHT)
+    target_compile_definitions(sphere_irreg_waves_test 
+        PRIVATE 
+        HYDROCHRONO_HAVE_IRRLICHT=1
+        "CHRONO_DATA_DIR=\"${CHRONO_DATA_DIR}\""
+    )
+endif()
+
+target_include_directories(
+    sphere_irreg_waves_test
+    PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../src
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../src/gui
+)
+
+target_link_libraries(
+    sphere_irreg_waves_test
+    PRIVATE
+        HydroChrono
+        HydroChronoGUI
+)
+
+# Register as CTest test
+if(TARGET sphere_irreg_waves_test)
+    # Copy test data to the output directory
+    file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/data DESTINATION ${CMAKE_BINARY_DIR}/tests/regression/Release)
+    
+    add_test(
+        NAME sphere_irreg_waves_regression
+        COMMAND ${SPHERE_IRREG_WAVES_RELEASE_DIR}/sphere_irreg_waves_test.exe ${HYDROCHRONO_DATA_DIR} --nogui
+    )
+    
+    set_tests_properties(
+        sphere_irreg_waves_regression
+        PROPERTIES 
+        LABELS "regression;sphere;irreg_waves;core"
+        FIXTURES_SETUP sphere_irreg_waves_regression_file
+        WORKING_DIRECTORY ${SPHERE_IRREG_WAVES_RELEASE_DIR}
+        ENVIRONMENT "${TEST_ENVIRONMENT}"
+    )
+
+    # Reference comparison test
+    add_test(
+        NAME sphere_irreg_waves_regression_ref
+        COMMAND python ${CMAKE_SOURCE_DIR}/tests/regression/sphere/irreg_waves/compare.py
+    )
+    
+    set_tests_properties(
+        sphere_irreg_waves_regression_ref
+        PROPERTIES 
+        LABELS "regression;sphere;irreg_waves;reference;core"
+        FIXTURES_REQUIRED sphere_irreg_waves_regression_file
+        WORKING_DIRECTORY ${SPHERE_IRREG_WAVES_RELEASE_DIR}
+        ENVIRONMENT "PATH=${Python3_ROOT_DIR};$ENV{PATH};HYDROCHRONO_BUILD_DIR=${CMAKE_BINARY_DIR}"
+    )
+endif() 
+
+# Sphere Irregular Waves with ETA Import Regression Test
+# =====================================================
+
+# Create executable in model-based directory
+add_executable(sphere_irreg_waves_eta_test)
+
+set(SPHERE_IRREG_WAVES_ETA_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphere/irreg_waves_eta)
+set(SPHERE_IRREG_WAVES_ETA_RELEASE_DIR ${CMAKE_BINARY_DIR}/tests/regression/Release/sphere/irreg_waves_eta)
+set(SPHERE_IRREG_WAVES_ETA_RESULTS_DIR ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}/results)
+
+# Use model-based source and let simulation create results automatically
+set_target_properties(sphere_irreg_waves_eta_test
+    PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY_DEBUG ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY_RELEASE ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}
+)
+
+target_sources(
+    sphere_irreg_waves_eta_test
+    PRIVATE
+        ${SPHERE_IRREG_WAVES_ETA_SRC_DIR}/sphere_irreg_waves_eta_test.cpp
+)
+
+if(HYDROCHRONO_ENABLE_IRRLICHT)
+    target_compile_definitions(sphere_irreg_waves_eta_test 
+        PRIVATE 
+        HYDROCHRONO_HAVE_IRRLICHT=1
+        "CHRONO_DATA_DIR=\"${CHRONO_DATA_DIR}\""
+    )
+endif()
+
+target_include_directories(
+    sphere_irreg_waves_eta_test
+    PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../src
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../src/gui
+)
+
+target_link_libraries(
+    sphere_irreg_waves_eta_test
+    PRIVATE
+        HydroChrono
+        HydroChronoGUI
+)
+
+# Register as CTest test
+if(TARGET sphere_irreg_waves_eta_test)
+    # Copy test data to the output directory
+    file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/data DESTINATION ${CMAKE_BINARY_DIR}/tests/regression/Release)
+    
+    add_test(
+        NAME sphere_irreg_waves_eta_regression
+        COMMAND ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}/sphere_irreg_waves_eta_test.exe ${HYDROCHRONO_DATA_DIR} --nogui
+    )
+    
+    set_tests_properties(
+        sphere_irreg_waves_eta_regression
+        PROPERTIES 
+        LABELS "regression;sphere;irreg_waves_eta;core"
+        FIXTURES_SETUP sphere_irreg_waves_eta_regression_file
+        WORKING_DIRECTORY ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}
+        ENVIRONMENT "${TEST_ENVIRONMENT}"
+    )
+
+    # Reference comparison test
+    add_test(
+        NAME sphere_irreg_waves_eta_regression_ref
+        COMMAND python ${CMAKE_SOURCE_DIR}/tests/regression/sphere/irreg_waves_eta/compare.py
+    )
+    
+    set_tests_properties(
+        sphere_irreg_waves_eta_regression_ref
+        PROPERTIES 
+        LABELS "regression;sphere;irreg_waves_eta;reference;core"
+        FIXTURES_REQUIRED sphere_irreg_waves_eta_regression_file
+        WORKING_DIRECTORY ${SPHERE_IRREG_WAVES_ETA_RELEASE_DIR}
+        ENVIRONMENT "PATH=${Python3_ROOT_DIR};$ENV{PATH};HYDROCHRONO_BUILD_DIR=${CMAKE_BINARY_DIR}"
+    )
 endif() 

tests/regression/compare_template.py

@@ -102,14 +102,35 @@
 }
 
 def format_path(path):
-    """Format file paths for display by making them relative to current directory"""
+    """Format file paths for display by making them relative to current directory and removing HydroChrono prefix"""
     if path is None:
         return "Not specified"
     try:
+        # First make it relative to current directory
         rel_path = os.path.relpath(path, os.getcwd())
-        return rel_path if len(rel_path) < len(path) else path
+        if len(rel_path) >= len(path):
+            rel_path = path
+        
+        # Remove "HydroChrono" from the beginning of the path if present
+        if rel_path.startswith("HydroChrono/"):
+            rel_path = rel_path[12:]  # Remove "HydroChrono/"
+        elif rel_path.startswith("HydroChrono\\"):
+            rel_path = rel_path[12:]  # Remove "HydroChrono\"
+        
+        return rel_path
     except (ValueError, OSError):
-        return str(path)
+        # If relative path fails, try to remove HydroChrono from absolute path
+        path_str = str(path)
+        if "HydroChrono" in path_str:
+            # Find the position after "HydroChrono" and remove it
+            hydrochrono_pos = path_str.find("HydroChrono")
+            if hydrochrono_pos != -1:
+                # Remove "HydroChrono" and the following slash/backslash
+                remaining = path_str[hydrochrono_pos + 12:]  # 12 = len("HydroChrono")
+                if remaining.startswith("/") or remaining.startswith("\\"):
+                    remaining = remaining[1:]
+                return remaining
+        return path_str
 
 def get_cmake_cache_path():
     """Return the canonical path to CMakeCache.txt in the build directory."""
@@ -370,7 +391,7 @@ def create_comparison_plot(ref_data, test_data, test_name, output_dir,
         f"Test Information\n\n"
         f"Model/Executable: {model_name}\n"
         f"Reference File: {format_path(ref_file_path)}\n"
-        f"Simulation File: {format_path(test_file_path)}\n"
+        f"Latest File: {format_path(test_file_path)}\n"
         f"Generated: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
     )
     create_text_panel(fig, LAYOUT['panels']['test_info'], info_content)
@@ -484,8 +505,23 @@ def run_comparison(ref_file, test_file, test_name=None, y_label="Value",
 
     # Load data with error handling
     try:
-        refData = np.loadtxt(ref_file, skiprows=1)
-        testData = np.loadtxt(test_file, skiprows=1)
+        # Try to detect the number of header lines by looking for the first numeric line
+        def find_data_start(filename):
+            with open(filename, 'r') as f:
+                for i, line in enumerate(f):
+                    # Check if line contains numeric data (time value)
+                    try:
+                        float(line.split()[0])
+                        return i
+                    except (ValueError, IndexError):
+                        continue
+            return 0  # Default to 0 if no numeric line found
+        
+        ref_skiprows = find_data_start(ref_file)
+        test_skiprows = find_data_start(test_file)
+        
+        refData = np.loadtxt(ref_file, skiprows=ref_skiprows)
+        testData = np.loadtxt(test_file, skiprows=test_skiprows)
     except (OSError, IOError, ValueError) as e:
         print(f"Error loading data files: {e}")
         sys.exit(1)
@@ -690,10 +726,10 @@ def rel_to_root(path):
     def main():
         if len(sys.argv) != 3:
             print("Usage: python compare.py <reference_file> <test_file>")
-            sys.exit(1)
-        
-        ref_file = sys.argv[1]
-        test_file = sys.argv[2]
+        sys.exit(1)
+
+    ref_file = sys.argv[1]
+    test_file = sys.argv[2]
         
         # Test-specific configuration
         test_name = "Example Multi-Column Test"

tests/regression/f3of/compare.py

@@ -19,13 +19,18 @@
 from compare_template import run_multi_column_comparison
 
 def main():
-    if len(sys.argv) != 3:
+    if len(sys.argv) == 1 or (len(sys.argv) == 3 and sys.argv[1] == 'default'):
+        # Use default reference and result file locations
+        ref_file = os.path.join(os.path.dirname(__file__), "..", "reference_data", "f3of", "dt3", "hc_ref_f3of_dt3_flap_pitch.txt")
+        test_file = os.path.join("results", "f3of_dt3.txt")
+    elif len(sys.argv) == 3:
+        ref_file = sys.argv[1]
+        test_file = sys.argv[2]
+    else:
         print("Usage: python compare.py <reference_file> <test_file>")
+        print("   or: python compare.py default")
         sys.exit(1)
 
-    ref_file = sys.argv[1]
-    test_file = sys.argv[2]
-    
     # F3OF DT3 specific configuration
     test_name = "F3OF DT3 Decay Test"
     executable_patterns = ["f3of_dt3_test", "f3of_dt3_test.exe"]
@@ -56,7 +61,7 @@ def main():
         plots_dir = test_file_path.parent / "plots"
         plots_dir.mkdir(parents=True, exist_ok=True)
         print(f"Plots will be saved to: {plots_dir}")
-        
+
         # Run the multi-column comparison using the template
         results = run_multi_column_comparison(
             ref_file, test_file, test_configs,