Create progress bar for experiments

[BenSchZA]

Introduce a progress bar for long-running experiments, across runs/subsets/timesteps (granularity to be determined, to be most efficient).

• Not enabled by default, perhaps progress mode.

[BenSchZA]

Some code already exists for this feature, very much WIP, ping to get access to this.

[FonsSicca]

@BenSchZA hello Ben! Would like to see the progress bar feature :)

[WooSungD]

Been looking at progress and tqdm for implementing a MVP progress bar

[BenSchZA]

@WooSungD I have some code (somewhere) that I recall uses tqdm. I had some issues with multiprocessing, but it was working with single process mode. I was hoping to have multiple progress bars—maybe one for # subsets, one for # runs, and one for total timesteps across all subsets and runs (i.e. overall simulation progress). It would be a great feature to have!

[BenSchZA]

The following is pseudo-code, untested, but might give an idea of how to integrate using radCAD hooks:

class CustomTQDM(tqdm):
    """A custom class that disables deepcopy for tqdm progress bars."""
    def __deepcopy__(self, memo):
        return self

@dataclass
class Parameters:
    """
    A dataclass to store the parameters of the simulation
    """
    progress_bar: CustomTQDM = CustomTQDM(total=0)
 
 ...
 
 class CustomSimulationExecution(SimulationExecution):
    def __init_subclass__(cls) -> None:
        return super().__init_subclass__()

    def before_subset(self):
        """
        radCAD simulation hook called before each simulation parameter subset
        """
        super().before_subset()
        params: Parameters = self.context.parameters
        params.progress_bar.total = int(self.context.timesteps)

    def before_timestep(self):
        """
        radCAD simulation hook called before each simulation timestep
        """
        super().before_timestep()
        params: Parameters = self.context.parameters
        params.progress_bar.update(1)

[WooSungD]

thanks for sharing the code @BenSchZA!

as a start I think a single progress bar for overall simulation progress bar would be great :) will give this a crack once in our next model build