Merge pull request #78 from Project-SEA-Stack/refactor/hydro-system

Major Refactor: Modular Hydrodynamics Core (HydroForces) with HydroSystem Façade, and Chrono Coupling Layer

Author: dav-og

CMakeLists.txt

@@ -2,11 +2,11 @@
 <p align="center">
   <img src="docs/assets/img/hydrochrono_banner.png" />
   <br/>
-  <a href="https://github.com/NREL/HydroChrono/releases"><img src="https://img.shields.io/badge/version-v0.3-blue.svg" /></a>
+  <a href="https://github.com/NREL/HydroChrono/releases"><img src="https://img.shields.io/badge/version-v0.4-blue.svg" /></a>
   <a href="#"><img src="https://img.shields.io/badge/status-Prototype-orange.svg" /></a>
 </p>
 
-> ⚠️ HydroChrono is under active development (`v0.3` prototype). This early release focuses on a YAML‑driven CLI and portable HDF5 outputs so you can try the code and share feedback. Expect rapid iteration over the coming year (inc. more advanced PTO, control, mooring & hydrodynamics) — please get in touch if you have any issues or feature requests.
+> ⚠️ HydroChrono is under active development (`v0.4` prototype). This early release focuses on a YAML‑driven CLI and portable HDF5 outputs so you can try the code and share feedback. Expect rapid iteration over the coming year (inc. more advanced PTO, control, mooring & hydrodynamics) — please get in touch if you have any issues or feature requests.
 
 
 HydroChrono (Hydrodynamics for Project Chrono) is a hydrodynamics simulation toolkit built on [Project Chrono](https://projectchrono.org/). It is designed for simulating wave energy converters (WECs) and other complex ocean systems, and is **100% free and open‑source** end‑to‑end — no proprietary dependencies required. This repo ships a prototype, YAML‑driven CLI app for running simulations and exporting portable results.

README.md

@@ -3,12 +3,13 @@
  * @brief CLI entrypoint for the HydroChrono YAML-based runner
  */
 
-#include <hydroc/hydrochrono_runner/run_hydrochrono_from_yaml.h>
+#include <hydroc/runner/run_from_yaml.h>
 #include <hydroc/version.h>
 #include "../src/utils/misc_options.h"
 #include <hydroc/logging.h>
 #include <string>
 #include <filesystem>
+#include <iostream>
 
 #ifdef _WIN32
 #include <windows.h>
@@ -75,15 +76,15 @@ struct CLIArgs {
     std::string sim_file;
     bool nogui = false;
     bool log = false;
-    bool nobanner = false;              // NEW: Disable banner display
-    bool quiet = false;                 // NEW: Quiet mode (minimal output)
-    bool debug = false;                 // NEW: Enable detailed simulation diagnostics
-    bool trace = false;                 // NEW: Enable step-by-step simulation tracing
-    std::string output_h5;              // NEW: Export HDF5 results path
-    bool h5_verbose = false;            // NEW: HDF5 verbose diagnostics
-    std::string h5_tag;                 // NEW: Optional tag appended to filename
-    bool fail_fast = false;             // NEW: Stop on first failure during sweep
-    bool profile = false;               // NEW: Enable runtime profiling summary
+    bool nobanner = false;              // Disable banner display
+    bool quiet = false;                 // Quiet mode (minimal output)
+    bool debug = false;                 // Enable detailed simulation diagnostics
+    bool trace = false;                 // Enable step-by-step simulation tracing
+    std::string output_h5;              // Export HDF5 results path
+    bool h5_verbose = false;            // HDF5 verbose diagnostics
+    std::string h5_tag;                 // Optional tag appended to filename
+    bool fail_fast = false;             // Stop on first failure during sweep
+    bool profile = false;               // Enable runtime profiling summary
 };
 
 static CLIArgs ParseArguments(int argc, char* argv[]) {
@@ -164,51 +165,60 @@ int main(int argc, char* argv[]) {
     // Configure UTF-8 console output on Windows (must be first!)
     // ---------------------------------------------------------------------
 #ifdef _WIN32
-    // Enable UTF-8 console output on Windows
     SetConsoleOutputCP(CP_UTF8);
-    std::ios_base::sync_with_stdio(false);
 #endif
 
     // Check for hidden options first (before any other processing)
     if (hydroc::misc::HandleHiddenOptions(argc, argv)) {
         return 0;
     }
 
+    // -------------------------------------------------------------------------
+    // Initialize logging early so all CLI output uses the nice formatting
+    // Wrapped in try/catch to report initialization failures clearly
+    // -------------------------------------------------------------------------
+    try {
+        hydroc::LoggingConfig cfg;
+        cfg.enable_cli_output = true;
+        cfg.enable_file_output = false;
+        cfg.console_level = hydroc::LogLevel::Info;
+        cfg.file_level = hydroc::LogLevel::Info;
+        (void)hydroc::Initialize(cfg);  // Ignore return value; failures throw
+    } catch (const std::exception& e) {
+        std::cerr << "FATAL: Exception during logging initialization: " << e.what() << std::endl;
+        return 1;
+    } catch (...) {
+        std::cerr << "FATAL: Unknown exception during logging initialization" << std::endl;
+        return 1;
+    }
+
     // Check for help/version/info flags first (before requiring input directory)
     for (int i = 1; i < argc; i++) {
         std::string arg = argv[i];
         if (arg == "--help" || arg == "-h") {
-            hydroc::LoggingConfig cfg;
-            cfg.enable_cli_output = true;
-            cfg.enable_file_output = false;
-            cfg.console_level = hydroc::LogLevel::Info;
-            cfg.file_level = hydroc::LogLevel::Info;
-            hydroc::Initialize(cfg);
             PrintHelp(argv[0]);
             hydroc::Shutdown();
             return 0;
         } else if (arg == "--version" || arg == "-v") {
-            hydroc::LoggingConfig cfg;
-            cfg.enable_cli_output = true;
-            cfg.enable_file_output = false;
-            cfg.console_level = hydroc::LogLevel::Info;
-            cfg.file_level = hydroc::LogLevel::Info;
-            hydroc::Initialize(cfg);
             PrintVersion();
             hydroc::Shutdown();
             return 0;
         } else if (arg == "--info" || arg == "-i") {
-            hydroc::LoggingConfig cfg;
-            cfg.enable_cli_output = true;
-            cfg.enable_file_output = false;
-            cfg.console_level = hydroc::LogLevel::Info;
-            cfg.file_level = hydroc::LogLevel::Info;
-            hydroc::Initialize(cfg);
             PrintInfo();
             hydroc::Shutdown();
             return 0;
         }
     }
+
+    // Handle "no arguments" case
+    if (argc == 1) {
+        hydroc::cli::LogError("ERROR: Input directory or setup file is required");
+        hydroc::cli::ShowEmptyLine();
+        hydroc::cli::LogInfo(std::string("Usage: ") + argv[0] + " [options] <input_directory_or_setup_file>");
+        hydroc::cli::LogInfo("Use --help for more information.");
+        hydroc::Shutdown();
+        return 1;
+    }
 
     // Parse command line arguments
     CLIArgs args = ParseArguments(argc, argv);
@@ -219,85 +229,61 @@ int main(int argc, char* argv[]) {
         hydroc::cli::ShowEmptyLine();
         hydroc::cli::LogInfo(std::string("Usage: ") + argv[0] + " [options] <input_directory_or_setup_file>");
         hydroc::cli::LogInfo("Use --help for more information.");
+        hydroc::Shutdown();
         return 1;
     }
 
     // Check if input is a setup file or directory
     std::filesystem::path input_path(args.input_directory);
     if (std::filesystem::exists(input_path)) {
         if (std::filesystem::is_regular_file(input_path)) {
-            // Check if it's a setup file
             if (input_path.extension() == ".yaml") {
                 const std::string filename = input_path.filename().string();
                 const std::string suffix = ".setup.yaml";
                 if (filename.length() >= suffix.length() && 
                     filename.compare(filename.length() - suffix.length(), suffix.length(), suffix) == 0) {
-                    // Convert setup file path to directory path
                     args.input_directory = input_path.parent_path().string();
                     hydroc::cli::LogInfo(std::string("Loaded setup file: ") + input_path.string());
                 } else {
                     hydroc::cli::LogError("ERROR: File provided is not a valid .setup.yaml file");
                     hydroc::cli::LogInfo(std::string("  Path: ") + args.input_directory);
                     hydroc::cli::LogInfo("  Expected: Directory or any file ending in '.setup.yaml'");
+                    hydroc::Shutdown();
                     return 1;
                 }
             }
         } else if (!std::filesystem::is_directory(input_path)) {
             hydroc::cli::LogError("ERROR: Path is neither a directory nor a regular file");
             hydroc::cli::LogInfo(std::string("  Path: ") + args.input_directory);
+            hydroc::Shutdown();
             return 1;
         }
     } else {
         hydroc::cli::LogError("ERROR: Input path does not exist");
         hydroc::cli::LogInfo(std::string("  Path: ") + args.input_directory);
+        hydroc::Shutdown();
         return 1;
     }
 
-    // Note: Banner will be rendered by the YAML runner
+    // Shutdown logging - the runner will reinitialize it
+    hydroc::Shutdown();
 
     // Prepare arguments for the YAML runner
     std::vector<std::string> runner_args;
-    runner_args.push_back(argv[0]);  // program name
-    
-    // Add input directory
+    runner_args.push_back(argv[0]);
     runner_args.push_back(args.input_directory);
 
-    // Add optional flags
-    if (args.nogui) {
-        runner_args.push_back("--nogui");
-    }
-    
-    // Add logging flag if requested
-    if (args.log) {
-        runner_args.push_back("--log");
-    }
-    
-    // Add new CLI options
-    if (args.nobanner) {
-        runner_args.push_back("--nobanner");
-    }
-    
-    if (args.quiet) {
-        runner_args.push_back("--quiet");
-    }
-    
-    if (args.debug) {
-        runner_args.push_back("--debug");
-    }
-    
-    if (args.trace) {
-        runner_args.push_back("--trace");
-    }
-    
-    if (args.profile) {
-        runner_args.push_back("--profile");
-    }
-    
+    if (args.nogui) runner_args.push_back("--nogui");
+    if (args.log) runner_args.push_back("--log");
+    if (args.nobanner) runner_args.push_back("--nobanner");
+    if (args.quiet) runner_args.push_back("--quiet");
+    if (args.debug) runner_args.push_back("--debug");
+    if (args.trace) runner_args.push_back("--trace");
+    if (args.profile) runner_args.push_back("--profile");
     if (!args.model_file.empty()) {
         runner_args.push_back("--model_file");
         runner_args.push_back(args.model_file);
     }
-    
     if (!args.sim_file.empty()) {
         runner_args.push_back("--sim_file");
         runner_args.push_back(args.sim_file);
@@ -306,9 +292,7 @@ int main(int argc, char* argv[]) {
         runner_args.push_back("--output-h5");
         runner_args.push_back(args.output_h5);
     }
-    if (args.fail_fast) {
-        runner_args.push_back("--fail-fast");
-    }
+    if (args.fail_fast) runner_args.push_back("--fail-fast");
 
     // Convert to argc/argv format for the runner
     std::vector<char*> runner_argv;