pysyncrosim.environment.progress_bar

pysyncrosim.environment.progress_bar(report_type='step', iteration=None, timestep=None, total_steps=None, message=None)

Begins, steps, ends, and reports progress for a SyncroSim simulation.

Parameters:

• report_type (String, optional) – Directive to “begin”, “end”, “report”, “message”, or “step” the simulation. The default is “step”.

• iteration (Int, optional) – Number of iterations. The default is None.

• timestep (Int, optional) – Number of timesteps. The default is None.

• total_steps (Int, optional) – Number of total steps in the simulation. The default is None.

• message (String, optional) – A message to print to the progress bar status. The default is None.

Raises:

• TypeError – If iteration, timestep, or total_steps are not Integers.

• ValueError – If report_type is not “begin”, “end”, “step”, “report”, or “message”.

Return type:

None.