.. _api:

===============
phaseshifts API
===============

Package Contents
----------------

This chapter covers the main modules of the phaseshifts and provides some API documentation 
for those wishing to incorporate this package into their own projects. 

.. automodule:: phaseshifts
    :members:
    :undoc-members:
    :show-inheritance:
    
Subpackages
-----------
The main sub packages are listed below: 
 * :py:mod:`phaseshifts.gui` - includes all the necessary files for the graphical user interface.
 * :py:mod:`phaseshifts.lib` - contains the Fortran libphsh library and the python wrappings.
 * :py:mod:`phaseshifts.doc` - source documentation for the phaseshifts package.
 * :py:mod:`phaseshifts.test` - modules for testing the phaseshift package.

Submodules
----------

phaseshifts.atorb
+++++++++++++++++

.. automodule:: phaseshifts.atorb
    :members:
    :private-members:
    :undoc-members:
    :show-inheritance:

phaseshifts.conphas
+++++++++++++++++++

.. automodule:: phaseshifts.conphas
    :members:
    :private-members:
    :undoc-members:
    :show-inheritance:

phaseshifts.elements
++++++++++++++++++++

.. automodule:: phaseshifts.elements
    :members:
    :special-members:
    :private-members:
    :undoc-members:
    :show-inheritance:

phaseshifts.leed
++++++++++++++++

.. automodule:: phaseshifts.leed
    :members:
    :private-members:
    :undoc-members:
    :show-inheritance:
    
phaseshifts.model
+++++++++++++++++

.. automodule:: phaseshifts.model
    :members:
    :private-members:
    :undoc-members:
    :show-inheritance:

phaseshifts.phsh
++++++++++++++++

.. automodule:: phaseshifts.phsh
    :members:
    :private-members:
    :undoc-members:
    :show-inheritance: