Feature/clean up logging (#177)

* remove time_log_interval

* unite on progress_update_interval

* minor update

* Update hercules/hercules_model.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update hercules/hercules_model.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: paulf81

docs/h_dict.md

@@ -24,8 +24,7 @@ The `h_dict` is a Python dictionary that contains all the configurations for eac
 | `name` | str | Simulation name | - |
 | `description` | str | Simulation description | - |
 | `output_file` | str | Output CSV file path | "outputs/hercules_output.csv" |
-| `time_log_interval` | int | Logging interval in steps | - |
-| `log_every_n` | int | Log every N simulation steps (default: 1) | 1 |
+| `log_every_n` | int | Log every N simulation steps to output log (default: 1) | 1 |
 | `external_data` | dict | External data configuration | - |
 | `external_data_file` | str | External data file path (deprecated, use `external_data` instead) | - |
 | `controller` | dict | Controller configuration | - |

hercules/hercules_model.py

@@ -114,20 +114,11 @@ def __init__(self, input_file):
         self.step = 0
         self.n_steps = int(self.total_simulation_time / self.dt)
 
-        # How often to update the user on current simulation time
-        # In simulated time
-        if "time_log_interval" in self.h_dict:
-            self.time_log_interval = self.h_dict["time_log_interval"]
-        else:
-            self.time_log_interval = 600  # seconds
-        self.step_log_interval = self.time_log_interval / self.dt
-
-        # Round to step_log_interval to be an integer greater than 0
-        self.step_log_interval = np.max([1, np.round(self.step_log_interval)])
+        # Set progress_update_interval to log 10 times per simulation
+        self.progress_update_interval = self.n_steps / 10
 
-        # Calculate progress bar update interval (independent of verbose logging)
-        # Update every 1% of completion or every 100 steps, whichever is more frequent
-        self.progress_update_interval = min(max(1, self.n_steps // 100), 100)
+        # Round progress_update_interval to be an integer greater than 0
+        self.progress_update_interval = np.max([1, np.round(self.progress_update_interval)])
 
         # Save start time UTC (zero_time_utc is redundant since time=0 corresponds to starttime_utc)
         # starttime_utc is required and should already be set, but ensure it's still present
@@ -503,7 +494,7 @@ def run(self):
             for self.step in range(self.n_steps):
                 # Log the current time
                 if self.verbose:
-                    if (self.step % self.step_log_interval == 0) or first_iteration:
+                    if (self.step % self.progress_update_interval == 0) or first_iteration:
                         self.logger.info(f"Simulation time: {self.time} (ending at {self.endtime})")
                         self.logger.info(f"Step: {self.step} of {self.n_steps}")
                         percent_complete = 100 * self.step / self.n_steps