EPW: Electron-phonon physics from first principles
==================================================

EPW is an open-source software project for calculating 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 <https://doi.org/10.1103/PhysRevB.76.165108>`_ employed by the EPW code. The project also contains the ZG code for calculating electron-phonon couplings including anharmonic corrections using supercells and the `special displacement method <https://doi.org/10.1103/PhysRevResearch.2.013357>`_.

.. grid:: 1 1 3 3
   :gutter: 3

   .. grid-item-card:: Start here

      - :doc:`Download and install <DownloadAndInstall>`
      - :doc:`Tutorials <Tutorials>`
      - :doc:`About <About>`

   .. grid-item-card:: For users

      - :doc:`Schools <Schools>`
      - :doc:`Documentation <Documentation>`
      - `User Forum <https://forum.epw-code.org/>`_

   .. grid-item-card:: For developers

      - :doc:`Developers meetings <DevelopersMeetings>`
      - :doc:`Steering committee <SteeringCommitteeMeetings>`
      - `EPW GitLab <https://gitlab.com/epw/q-e/-/tree/develop/EPW>`_

.. toctree::
   :maxdepth: 1
   :caption: Project
   :hidden:

   About
   Releases
   Documentation
   Tutorials
   Schools
   Acknowledgement
   PapersUsingEPW/Papers
   Contact
   User Forum <https://forum.epw-code.org/>

.. toctree::
   :maxdepth: 1
   :caption: Source code
   :hidden:

   DownloadAndInstall
   GitLab
   TestFarm
   Developers
   Benchmarks

.. toctree::
   :maxdepth: 1
   :caption: Developers
   :hidden:

   DevelopersMeetings
   SteeringCommitteeMeetings
   WebsiteMaintenance