.. _documentation:

Documentation
=============

The complete **PyPL** reference is reported below.


Huang-Rhys solver
-----------------

.. automodule:: pypl.hr_solver
    :members:
    :undoc-members:
    :show-inheritance:

Lineshape
---------

.. automodule:: pypl.lineshape
    :members:
    :undoc-members:
    :show-inheritance:

Huang-Rhys factors
------------------

.. automodule:: pypl.hr_factors
    :members:
    :undoc-members:
    :show-inheritance:

1D configurational coordinate solver
------------------------------------

.. automodule:: pypl.config_coord_1d_solver
    :members:
    :undoc-members:
    :show-inheritance:

Utils
-----

.. automodule:: pypl.utils
    :members:
    :undoc-members:
    :show-inheritance: