Framework Utility Functions

Collection of utility functions shared by the vivarium framework.

vivarium.framework.utilities.from_yearly(value, time_step)[source]
Return type:

TypeVar(T, bound= Union[ndarray[Any, dtype[number[NBitBase]]], Series, DataFrame, float, int])

Parameters:
vivarium.framework.utilities.to_yearly(value, time_step)[source]
Return type:

TypeVar(T, bound= Union[ndarray[Any, dtype[number[NBitBase]]], Series, DataFrame, float, int])

Parameters:
vivarium.framework.utilities.rate_to_probability(rate)[source]
Return type:

ndarray[Any, dtype[number[NBitBase]]]

Parameters:

rate (Sequence[float] | ndarray[Any, dtype[number[NBitBase]]] | Series | DataFrame | float | int)

vivarium.framework.utilities.probability_to_rate(probability)[source]
Return type:

ndarray[Any, dtype[number[NBitBase]]]

Parameters:

probability (Sequence[float] | ndarray[Any, dtype[number[NBitBase]]] | Series | DataFrame | float | int)

vivarium.framework.utilities.collapse_nested_dict(d, prefix=None)[source]
Return type:

list[tuple[str, Any]]

Parameters:
vivarium.framework.utilities.import_by_path(path)[source]

Import a class or function given its absolute path.

Return type:

Callable[..., Any]

Parameters:

path (str) – Path to object to import

Returns:

The imported class or function

vivarium.framework.utilities.handle_exceptions(func, logger, with_debugger)[source]

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

Return type:

Callable[..., Any]

Parameters: