pynetdesign.modelling.utils.check_zero_values

pynetdesign.modelling.utils.check_zero_values(a, ErrorMessage=None)

Check if the input value is close to zero and raise an error if true.

Parameters:

afloat or array_like

The input value or values to be checked.

ErrorMessagestr , optional

Custom error message to be raised if the value is close to zero. Default is “Array values are close to zero”.

Returns:

bool

Returns True if the value is not close to zero.

Raises:

RuntimeError

If the value is close to zero, raises a RuntimeError with the provided or default error message.

Examples

>>> check_zero_values(0.0000001)
RuntimeError: Array values are close to zero

>>> check_zero_values(1.0)
True