Exceptions (polykin.utils.exceptions)

Custom exceptions and warnings used throughout PolyKin.

This module defines a consistent set of error and warning types for common failure modes in polymerization kinetics workflows, including convergence issues, fitting failures, ODE solver problems, root-finding errors, and invalid ranges or shapes. These classes are intended to improve clarity, error handling, and diagnostics across the library.

ConvergenceError

Raised when an iterative algorithm fails to converge to a solution.

Source code in src/polykin/utils/exceptions.py

class ConvergenceError(ValueError):
    """Raised when an iterative algorithm fails to converge to a solution."""

ConvergenceWarning

Raised when an iterative algorithm is approaching non-convergence, indicating potential instability or slow convergence.

Source code in src/polykin/utils/exceptions.py

class ConvergenceWarning(Warning):
    """
    Raised when an iterative algorithm is approaching non-convergence,
    indicating potential instability or slow convergence.
    """

FitError

Raised when a fitting procedure fails to find a valid solution.

Source code in src/polykin/utils/exceptions.py

class FitError(ValueError):
    """Raised when a fitting procedure fails to find a valid solution."""

FitWarning

Raised when a fitting procedure produces results that may be unreliable or near failure.

Source code in src/polykin/utils/exceptions.py

class FitWarning(Warning):
    """
    Raised when a fitting procedure produces results that may be unreliable
    or near failure.
    """

ODESolverError

Raised when an ordinary differential equation (ODE) solver fails to produce a solution.

Source code in src/polykin/utils/exceptions.py

class ODESolverError(ValueError):
    """
    Raised when an ordinary differential equation (ODE) solver fails to
    produce a solution.
    """

ODESolverWarning

Raised when an ODE solver produces results that may be unreliable or indicate potential failure.

Source code in src/polykin/utils/exceptions.py

class ODESolverWarning(Warning):
    """
    Raised when an ODE solver produces results that may be unreliable
    or indicate potential failure.
    """

RangeError

Raised when a value lies outside the allowed or expected range.

Source code in src/polykin/utils/exceptions.py

class RangeError(ValueError):
    """Raised when a value lies outside the allowed or expected range."""

RangeWarning

Raised when a value is near or slightly outside the recommended range, but not critically so.

Source code in src/polykin/utils/exceptions.py

class RangeWarning(Warning):
    """
    Raised when a value is near or slightly outside the recommended range,
    but not critically so.
    """

RootSolverError

Raised when a root-finding solver fails to locate a valid root.

Source code in src/polykin/utils/exceptions.py

class RootSolverError(ValueError):
    """Raised when a root-finding solver fails to locate a valid root."""

RootSolverWarning

Raised when a root-finding solver encounters potential numerical issues or uncertain results.

Source code in src/polykin/utils/exceptions.py

class RootSolverWarning(Warning):
    """
    Raised when a root-finding solver encounters potential numerical issues
    or uncertain results.
    """

ShapeError

Raised when an array or tensor has an invalid or unexpected shape.

Source code in src/polykin/utils/exceptions.py

class ShapeError(ValueError):
    """Raised when an array or tensor has an invalid or unexpected shape."""