clophfit.fitting.errors
=======================

.. py:module:: clophfit.fitting.errors

.. autoapi-nested-parse::

   Error classes for ClopHfit.

   This module defines custom exceptions used throughout the ClopHfit package
   for better error handling and user-friendly error messages.



Exceptions
----------

.. autoapisummary::

   clophfit.fitting.errors.ClopHfitError
   clophfit.fitting.errors.FitError
   clophfit.fitting.errors.InsufficientDataError
   clophfit.fitting.errors.ConvergenceError
   clophfit.fitting.errors.InvalidDataError
   clophfit.fitting.errors.CLIError
   clophfit.fitting.errors.FileFormatError
   clophfit.fitting.errors.DataValidationError
   clophfit.fitting.errors.MissingDependencyError


Module Contents
---------------

.. py:exception:: ClopHfitError

   Bases: :py:obj:`Exception`


   Base class for all ClopHfit errors.


.. py:exception:: FitError

   Bases: :py:obj:`ClopHfitError`


   Base class for fitting errors.


.. py:exception:: InsufficientDataError

   Bases: :py:obj:`FitError`


   Raised to prevent fitting failure for too few data points.


.. py:exception:: ConvergenceError

   Bases: :py:obj:`FitError`


   Raised when fitting fails to converge.


.. py:exception:: InvalidDataError

   Bases: :py:obj:`FitError`


   Raised when input data is invalid.


.. py:exception:: CLIError

   Bases: :py:obj:`ClopHfitError`


   Base class for CLI-related errors.


.. py:exception:: FileFormatError(filepath, expected_format, details = '')

   Bases: :py:obj:`CLIError`


   Raised when an input file has invalid format.

   :param filepath: Path to the problematic file.
   :type filepath: str
   :param expected_format: Description of expected file format.
   :type expected_format: str
   :param details: Additional details about the error.
   :type details: str, optional


.. py:exception:: DataValidationError(message, suggestions = None)

   Bases: :py:obj:`CLIError`


   Raised when data fails validation checks.

   :param message: Description of the validation error.
   :type message: str
   :param suggestions: List of suggestions to fix the error.
   :type suggestions: list[str] | None


.. py:exception:: MissingDependencyError(missing_file, required_by, reason)

   Bases: :py:obj:`CLIError`


   Raised when required file dependencies are missing.

   :param missing_file: The file that is missing.
   :type missing_file: str
   :param required_by: What requires this file.
   :type required_by: str
   :param reason: Why this file is needed.
   :type reason: str