Welcome to the documentation of PyPL |version|
==============================================

**PyPL** is designed to compute vibrationally resolved spectra of point defects.

Features:

   - Calculation of vibrationally resolved photoluminescence and absorption spectra using Huang-Rhys theory and the generating function approach.
   - Calculation of vibrationally resolved optical spectra using the one-dimensional configurational coordinate diagram (1D CCD) approach.

--------

.. toctree::
   :hidden:
   :maxdepth: 2

   installation
   tutorial
   documentation
   credits

.. glossary::

   :ref:`installation`
      Instructions on how to install the **PyPL** package.

   :ref:`tutorial`
      Compact demonstration of usage of **PyPL** for computing vibrationally resolved photoluminescence and absorption spectra of point defects.

   :ref:`documentation`
      Detailed documentation of the **PyPL** package.

   :ref:`credits`
      Instructions on how to cite and acknowledge this software in publications.

.. note::

   To get help using the **PyPL** package, send an email to `jinyuchem@uchicago.edu <mailto:jinyuchem@uchicago.edu>`_.

The **PyPL** package is hosted on `GitHub <https://github.com/MICCoMpy/pypl>`_ and licensed under the open-source MIT license.