Skip to content

brunocucco/epwpy

Repository files navigation

                                                                                          
                                       -*#*-                             ...............- 
                          .+*=      .+%*-=%%:      .=#*-               -===============-:.
                        :*%=*%%-    *%*   #%*    :+%+-%%+             .:.  -=.   :==-.    
                        -%S  -%%*: :#%.   -%%-. -##:  #%*                  -=.   :==-     
                ..      .%S:   +%%%%*.     :*%%%#=    %%=                  -=.   :==-     
              :=#%%*-   .#S-     ..                  .%%=     :*#*:        -=.   :==-     
             -%S:.=#%%*==%#                           *%%=::=##-+%%.  .   .=-.   :==-  .= 
             :%%-   .-+++:                             -+##*=.  =%S   :-::==:    .==-  --.
              *%#                                               #%+    -=--:.     .----:. 
              :%%-                                             -%S.                       
       .-=*####SS%#########:  -###########*+:     +#######=   =%SS####+::.                
     =+#**%SSSSSSSSSSSSSSSS=  =SSSSSSSSSSSSSSS=   #SSSSSSS*.  +SSSSSSSS%%%%-              
     *%%    =SSS..     .SSS=     SSS=.   .:+SSS+   -SSS:. .-::.  .SSS+.  #%*              
      #%#.  =SSS.  *S#  *S%:     SSS=       %SS%.  .SSS=  #SSS%. :SSS:  =%#.              
       *%%: =SSS#*#SSS-          SSS=     .+SSS+.   %SS*.=SSSSS+ +SS%.:+%+                
        +%%:=SSSSSSSSS-          SSSSSSSSSSSSS=.    +SSS:SSS%SSS:%SS*-#%=                 
     ....#S==SSS:..SSS:  =+-     SSS%######+=.      -SSS%SS%.#SS%SSS==%%=.                
 .:+##%%#*- =SSS.   ::. :SSS.    SSS=.               SSSSSS:..SSSSSS: :*%%%*=-            
 #%+.     -+#SSS*+++++++*SSS: .=+SSS#++++:           %SSSS+.  =SSSS%.    :-+#%%+          
 #%*     .SSSSSSSSSSSSSSSSSS: *SSSSSSSSSSS.          +SSS%.    %SSS*.      . .%%=         
 =%S       :::::::::::::::::.  .:::::::::.            :::.      :::.     =+=-.#%+         
 -%S:                                                                    =+===#S:         
 ==*------------------------------=========+++++++++++++++++++++++========++-+##          
 =+++++++++++*******++++++++++++++++========------------------==========+++++++-          
                                                                                                       
 EPWpy v1.1 is an open-source community code to wrap EPW code which is used for ab initio calculations of electron-phonon 
 interactions using Density-Functional Perturbation Theory and Maximally Localized Wannier 
 Functions.
 EPW is distributed as part of the Quantum ESPRESSO suite, therefore please cite
     "P. Giannozzi et al., J. Phys.:Condens. Matter 21 395502 (2009);
      URL http://www.quantum-espresso.org",
 in publications or presentations arising from this work. More details at
 http://www.quantum-espresso.org/quote
 Please also consider citing the EPW papers:
 1) F. Giustino, M. L. Cohen, and S. G. Louie, Phys. Rev. B 76, 165108 (2007)
 2) For calculations performed using EPW v4 through v5.6: 
      S. Ponc\'e, E. R. Margine, C. Verdi and F. Giustino, Comput. Phys. Commun. 209, 116 (2016).
    For calculations performed using EPW v5.7 and beyond:
      H. Lee, S. Ponc\'e, 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, 
      npj Comput.  Mater. 9, 156 (2023).
    
 The software tree of EPWpy v1.1 is composed of
 ./EPWpy -> The main EPWpy class
 ./EPWpy/<folders> -> Various subclasses and packages
 ./test-suite -> test for EPWpy (automatic download of QE in buid directory)
 ./notebooks_basic -> Basic Jupyter notebooks for using EPWpy 
 ./examples -> examples for using EPWpy on a terminal
 Installation
 ------------
 To compile the code you first need to issue ./configure in /espresso. 
 Indeed EPW rely on the make.sys file created by QE. 
 Then you can run ./make inside espresso/EPW.
 EPW dedicated website and forum
 -------------------------------
 EPW has a dedicated website that you can access at https://epw-code.org
 Detailed documentation and tutorials can be found here: https://docs.epw-code.org
 If you have any questions, please use the forum at https://forum.epw-code.org
 S The EPW Collaboration, Aug 2023
 
 

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5