fixes #113

boario/simulation.py

@@ -144,6 +144,7 @@ def __init__(
         save_records: list | str = [],
         boario_output_dir: str | pathlib.Path = tempfile.mkdtemp(prefix="boario"),
         results_dir_name: Optional[str] = None,
+        show_progress: bool = True,
     ) -> None:
         """A Simulation instance can be initialized with the following parameters:
 
@@ -171,6 +172,8 @@ def __init__(
             An optional directory where to save files generated by the simulation. Defaults to a temporary directory prefixed by "boario".
         results_dir_name : str, default 'results'
             The name of the folder where simulation results will be stored.
+        show_progress: bool, default: True
+            If True, shows a progress bar in the console during the simulation.
 
         """
         self.output_dir = pathlib.Path(boario_output_dir)
@@ -197,6 +200,7 @@ def __init__(
         self._save_params = save_params
         self._save_index = save_index
         self._register_stocks = register_stocks
+        self._show_progress = show_progress
 
         # Pre-init record variables
         self._production_evolution = np.array([])
@@ -321,7 +325,7 @@ def __init__(
             f"Simulation parameters:\n{pformat(formatted_params_dict, compact=True)}"
         )
 
-    def loop(self, progress: bool = True):
+    def loop(self):
         r"""Launch the simulation loop.
 
         This method launch the simulation for the number of steps to simulate
@@ -330,11 +334,6 @@ def loop(self, progress: bool = True):
         parameters used in the logs just before running the loop. Once the loop
         is completed, it flushes the different memmaps generated.
 
-        Parameters
-        ----------
-
-        progress: bool, default: True
-            If True, shows a progress bar of the loop in the console.
         """
         logger.info(
             f"Starting model loop for at most {self.n_temporal_units_to_sim // self.model.n_temporal_units_by_step + 1} steps"
@@ -359,7 +358,8 @@ def loop(self, progress: bool = True):
             ).open("w") as ffile:
                 event_dicts = [ev.event_dict for ev in self.all_events]
                 json.dump(event_dicts, ffile, indent=4, cls=CustomNumpyEncoder)
-        if progress:
+
+        if self._show_progress:
             widgets = [
                 "Processed: ",
                 progressbar.Counter("Step: %(value)d"),