deflex.Cycles.used_cycles

Cycles.used_cycles

Get all cycles from a list of cycles that are used.

Cycles are not in use if one flow of the cycle is zero for all time steps.

Returns: Return type:list of pandas.DataFrame

Examples

>>> from deflex import restore_results, fetch_test_files, Cycles
>>> fn = fetch_test_files("de03_fictive.dflx")
>>> cy = Cycles(restore_results(fn), storages=True, lines=True)
>>> len(cy.cycles)
9
>>> len(cy.used_cycles)
2
>>> type(cy.used_cycles[0])
<class 'pandas.core.frame.DataFrame'>