:py:mod:`pylbo.exceptions`
==========================

.. py:module:: pylbo.exceptions


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

.. py:exception:: LegolasException(message=None)


   Bases: :py:obj:`Exception`

   
   Exception superclass to handle Legolas exceptions.

   :param message: The message to pass as error message.
   :type message: str















   ..
       !! processed by numpydoc !!

.. py:exception:: InvalidLegolasFile(file)


   Bases: :py:obj:`LegolasException`

   
   Handles trying to load invalid Legolas files.

   :param file: The path to the file.
   :type file: str, ~os.PathLike















   ..
       !! processed by numpydoc !!

.. py:exception:: BackgroundNotPresent(file, unable_to_get=None)


   Bases: :py:obj:`LegolasException`

   
   Handles trying to query for the background when this is not present in the datfile.

   :param file: The path to the file.
   :type file: str, ~os.PathLike
   :param unable_to_do: The thing that was unable to be done.
   :type unable_to_do: str















   ..
       !! processed by numpydoc !!

.. py:exception:: EigenfunctionsNotPresent(msg)


   Bases: :py:obj:`LegolasException`

   
   Handles trying to query for eigenfunctions when these
   are not present in the datfile.

   :param msg: The error message to pass on.
   :type msg: str















   ..
       !! processed by numpydoc !!

.. py:exception:: MatricesNotPresent(file)


   Bases: :py:obj:`LegolasException`

   
   Handles trying to query for matrices when these
   are not present in the datfile.

   :param file: The path to the file.
   :type file: str, ~os.PathLike















   ..
       !! processed by numpydoc !!

.. py:exception:: EigenvectorsNotPresent(file)


   Bases: :py:obj:`LegolasException`

   
   Handles trying to query for eigenvectors when
   these are not present in the datfile.

   :param file: The path to the file.
   :type file: str, ~os.PathLike















   ..
       !! processed by numpydoc !!

.. py:exception:: ResidualsNotPresent(file)


   Bases: :py:obj:`LegolasException`

   
   Handles trying to query for residuals when
   these are not present in the datfile.

   :param file: The path to the file.
   :type file: str, ~os.PathLike















   ..
       !! processed by numpydoc !!

.. py:exception:: ParfileGenerationError(file, nb_runs=None, key=None)


   Bases: :py:obj:`LegolasException`

   
   Gets thrown when something went wrong during parfile generation.
















   ..
       !! processed by numpydoc !!