Framework Utility Functions

Collection of utility functions shared by the vivarium framework.

vivarium.framework.utilities.from_yearly(value, time_step)

vivarium.framework.utilities.to_yearly(value, time_step)

vivarium.framework.utilities.rate_to_probability(rate)

Parameters:

rate (float | List | Tuple | ndarray | Series) –

Return type:

ndarray

vivarium.framework.utilities.probability_to_rate(probability)

vivarium.framework.utilities.collapse_nested_dict(d, prefix=None)

vivarium.framework.utilities.import_by_path(path)

Import a class or function given it’s absolute path.

Parameters:

path (str) – Path to object to import

Return type:

Callable

vivarium.framework.utilities.handle_exceptions(func, logger, with_debugger)

Drops a user into an interactive debugger if func raises an error.

Parameters:

• func (Callable) –

• logger (Any) –

• with_debugger (bool) –

Return type:

Callable