TqdmProgressBar#

class ansys.dpf.core.common.TqdmProgressBar(text, unit, tot_size=None)#

Bases: ansys.dpf.gate.common.ProgressBarBase

Custom progress bar implementation based on tqdm.

Overview#

update

Modify how the current value of the progress bar is updated.

start

finish

bar

current

tot_size

progress_available

Check if the tdqm module exists.

Import detail#

from ansys.dpf.core.common import TqdmProgressBar

Attribute detail#

TqdmProgressBar.bar#
TqdmProgressBar.current = 0#
TqdmProgressBar.tot_size = None#

Method detail#

TqdmProgressBar.update(current_value)#

Modify how the current value of the progress bar is updated.

static TqdmProgressBar.progress_available()#

Check if the tdqm module exists.

Returns:

True if module exists, else False.

Return type:

bool

TqdmProgressBar.start()#
TqdmProgressBar.finish()#