.. GitLab Pages with Sphinx documentation master file, created by
   sphinx-quickstart on Thu Jan  9 10:28:38 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Intro
=====

EPWpy is an open-source python code which wraps EPW code for automated calculations. EPWpy provides python objects with methods that can be used to automate DFT+EPW calculations using Quantum Espresso and EPW.EPWpy also provides a series of visualization utilities for plotting various quantities. EPW is a F90/MPI code which calculates properties related to the electron-phonon interaction using `Density-Functional Perturbation Theory <http://link.aps.org/doi/10.1103/RevModPhys.73.515>`_ and `Maximally Localized Wannier Functions <http://link.aps.org/doi/10.1103/PhysRevB.56.12847>`_. The name is derived from the words "Electron-phonon Wannier" which refer to the Wannier-Fourier interpolation method employed by the code.
The development and co-ordination of EPWpy is led by `Sabyasachi Tiwari <https://oden.utexas.edu/people/directory/Sabyasachi-Tiwari/>`_ and `Feliciano Giustino <https://cqme.oden.utexas.edu/>`_.

The most recent reference technical manuscript is:
`S. Tiwari, B. Cucco, M. Zacharias, J-L. Bartolome, S. Mishra, W. Yang, V-A. Ha, S. Ponce, E. Kioupakis, R. Margine, and F. Giustino,  Unpublished (2024) <https://www.nature.com/articles/s41524-023-01107-3>`_ 

.. \\\**A
.. `H. Lee, S. Poncé, K. Bushick, S. Hajinazar, J. Lafuente-Bartolome, J. Leveillee, C. Lian, J.-M. Lihm, F.
.. Macheda, H. Mori, H. Paudyal, W. H. Sio, S. Tiwari, M. Zacharias, X. Zhang, N. Bonini, E. Kioupakis, E. R.
.. Margine, and F. Giustino, “Electron–phonon physics from first principles using the EPW code”, npj Comput.
.. Mater. 9, 156 (2023) <https://doi.org/10.1038/s41524-023-01107-3>`_.


.. toctree::
   :maxdepth: 1
   :caption: PROJECT
   :hidden:

   doc/About
   doc/Releases
   doc/Documentation
   doc/Acknowledgement
   doc/Contact

.. toctree::
   :maxdepth: 2
   :caption: NOTEBOOKS:
   :hidden:

   doc/notebooks/transport-v1.2 
   doc/notebooks/polaron_v1.2
   doc/notebooks/optics_v1.1
   doc/notebooks/quadrupole
   doc/notebooks/zg
   doc/notebooks/supercond_aniso_v1.2
   doc/notebooks/supercond_iso_v1.2
   doc/notebooks/zg_anharmonicity_PbTe

.. toctree::
   :maxdepth: 4
   :caption: SOURCE CODE
   :hidden:

   doc/DownloadAndInstall
   GitLab <https://gitlab.com/epwpy/epwpy>
   doc/modules    
..
.. toctree::
   :maxdepth: 1
   :caption: DEVELOPERS
   :hidden:

.. doc/DevelopersMeetings
..   doc/SteeringCommitteeMeetings
..   doc/WebsiteMaintenance