Progressbar

class simframe.io.Progressbar(prefix=' ', suffix='| ', fill='▶', empty=' ', length=25, color='blue', spinner=None)

Bases: object

Class for printing progress bar to terminal.

Methods

__call__(x, x0, x1, s0, s1)	Prints the current progress bar.
print(x, x0, x1, s0, s1)	Function prints the current progress bar.

Methods Summary

__call__(x, x0, x1, s0, s1)	Prints the current progress bar.
print(x, x0, x1, s0, s1)	Function prints the current progress bar.

Methods Documentation

__call__(x, x0, x1, s0, s1)

Prints the current progress bar.

Parameters:

• x (Number) – Current state of progress

• x0 (Number) – Starting point of snapshot

• x1 (Number) – End point of snapshot

• s0 (Number) – Starting point of simulation

• s1 (Number) – End point of simulation

print(x, x0, x1, s0, s1)

Function prints the current progress bar. If the end of either the snapshot or the simulation is reached, no progress bar will be printed.

Parameters:

• x (Number) – Current state of progress

• x0 (Number) – Starting point of snapshot

• x1 (Number) – End point of snapshot

• s0 (Number) – Starting point of simulation

• s1 (Number) – End point of simulation