==================================
*pyviblib* Class Library Reference
==================================

Package tree of pyviblib
========================
    .. image:: img/package_tree_for_pyviblib.png

Packages and modules
====================

    :mod:`pyviblib`
        *root package of the class library*

        * :mod:`~pyviblib.molecule` -- handling molecules

    :mod:`pyviblib.calc`
        *calculation routines*

        * :mod:`~pyviblib.calc.common` -- commonly used routines
        * :mod:`~pyviblib.calc.qtrfit` -- superimposing molecules using a quaternion fit
        * :mod:`~pyviblib.calc.spectra` -- handling VROA spectra
        * :mod:`~pyviblib.calc.vibrations` --  handling vibrational motion

    :mod:`~pyviblib.gui`
        *components of the graphical user interface of PyVib2*

        * :mod:`~pyviblib.gui.dialogs` -- dialogs
        * :mod:`~pyviblib.gui.figures` -- figures implemented with Matplotlib
        * :mod:`~pyviblib.gui.images` -- images (:mod:`Tkinter.Photoimage`)
        * :mod:`~pyviblib.gui.main` -- main window of PyVib2
        * :mod:`~pyviblib.gui.rendering` -- 3D rendering implemented with VTK
        * :mod:`~pyviblib.gui.resources` -- program resources
        * :mod:`~pyviblib.gui.widgets` -- building "blocks" for the dialogs and windows
        * :mod:`~pyviblib.gui.windows` -- windows

    :mod:`~pyviblib.io`
        *input/output operations*

        * :mod:`~pyviblib.io.parsers` -- parsing files
        * :mod:`~pyviblib.io.workspace` -- reading/writing PyVib2 workspace files
        * :mod:`~pyviblib.io.writers` -- writing files

    :mod:`~pyviblib.util`
        *utility modules*

        * :mod:`~pyviblib.util.constants` -- physical constants and conversion factors
        * :mod:`~pyviblib.util.exceptions` -- exceptions raised by pyviblib
        * :mod:`~pyviblib.util.misc` -- miscellaneous
        * :mod:`~pyviblib.util.pse` -- handling chemical elements

.. toctree::
    :hidden:

    pyviblib
    pyviblib.molecule
    pyviblib.calc
    pyviblib.calc.common
    pyviblib.calc.qtrfit
    pyviblib.calc.spectra
    pyviblib.calc.vibrations
    pyviblib.gui
    pyviblib.gui.dialogs
    pyviblib.gui.figures
    pyviblib.gui.images
    pyviblib.gui.main
    pyviblib.gui.rendering
    pyviblib.gui.resources
    pyviblib.gui.widgets
    pyviblib.gui.windows
    pyviblib.io
    pyviblib.io.parsers
    pyviblib.io.workspace
    pyviblib.io.writers
    pyviblib.util
    pyviblib.util.constants
    pyviblib.util.exceptions
    pyviblib.util.misc
    pyviblib.util.pse