PH User Guide
PH User Guide
2)
Contents
1 Introduction 1
2 People 1
3 Installation 2
3.1 Structure of the PHonon package . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
3.2 Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
4 Using PHonon 4
4.1 Single-q calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4.2 Calculation of interatomic force constants in real space . . . . . . . . . . . . . . 5
4.3 Calculation of electron-phonon interaction coefficients . . . . . . . . . . . . . . . 5
4.4 DFPT with the tetrahedron method . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.5 Calculation of electron-phonon interaction coefficients with the tetrahedron method 6
4.6 Phonons for two-dimensional crystals . . . . . . . . . . . . . . . . . . . . . . . . 7
4.7 Phonons from DFPT+U . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.8 Fourier interpolation of phonon potential . . . . . . . . . . . . . . . . . . . . . . 7
4.9 Calculation of phonon-renormalization of electron bands . . . . . . . . . . . . . 8
5 Parallelism 8
6 Troubleshooting 9
1 Introduction
This guide covers the usage of the PHonon package for linear-response calculations.
It is also assumed that you know the physics behind Quantum ESPRESSO, the methods
it implements, and in particular the physics and the methods of PHonon. It also assumes that
you have already installed, or know how to install, Quantum ESPRESSO. If not, please read
the general User’s Guide for Quantum ESPRESSO, found in subdirectory Doc/ of the main
Quantum ESPRESSO directory, or consult the web site http://www.quantum-espresso.org.
1
Further documentation, beyond what is provided in this guide, can be found in the directory
PHonon/Doc/, containing a copy of this guide. People who want to contribute to Quantum
ESPRESSO should read the Wiki pages on GitLab: https://gitlab.com/QEF/q-e/-/wikis.
2 People
The PHonon package was originally developed by Stefano Baroni, Stefano de Gironcoli, Andrea
Dal Corso (SISSA), Paolo Giannozzi (Univ. Udine), and many others. We quote in particular:
Michele Lazzeri (Univ.Paris VI) for the 2n+1 code and Raman cross section calculation
with 2nd-order response;
Andrea Dal Corso for the implementation of Ultrasoft, PAW, noncolinear, spin-orbit
extensions to PHonon;
Andrea Floris, Iurii Timrov, Burak Himmetoglu, Nicola Marzari, Stefano de Gironcoli,
and Matteo Cococcioni, for phonons using Hubbard-corrected DFPT (DFPT+U ).
Other contributors include: Lorenzo Paulatto (Univ. Paris VI) for PAW, 2n+1 code;
William Parker (Argonne) for phonon terms in dielectric tensor; Tobias Wassmann (Univ.
Paris VI) for third-order derivatives of GGA potential. Weicheng Bao (Nanjing University)
and Norge Cruz Hernandez (Universidad de Sevilla) helped debugging the phonon code.
We shall greatly appreciate if scientific work done using the Quantum ESPRESSO dis-
tribution will contain an acknowledgment to the following references:
and
2
Users of the GPU-enabled version should also cite the following paper:
Note the form Quantum ESPRESSO for textual citations of the code. Please also see
package-specific documentation for further recommended citations. Pseudopotentials should
be cited as (for instance)
3 Installation
PHonon is a Quantum ESPRESSO package and it is tightly bound to Quantum ESPRESSO.
For instruction on how to download and compile Quantum ESPRESSO, please refer to
the general Users’ Guide, available in file Doc/user guide.pdf under the main Quantum
ESPRESSO directory, or in web site http://www.quantum-espresso.org.
Once Quantum ESPRESSO is correctly configured, PHonon is compiled by just typing
make ph, from the main Quantum ESPRESSO directory; or, if you use CMake, by just
typing make.
3
Note: since v.5.4, packages PlotPhon (for phonon plotting) and QHA (vibrational free energy
in the Quasi-Harmonic approximations), contribute by the late Prof. Eyvaz Isaev, are no longer
bundled with PHonon. Their latest version can be found in the tarballs of v.5.3 of QE.
3.2 Compilation
Typing make ph from the root Quantum ESPRESSO directory, or make from the PHonon
directory, produces the following codes:
PH/dynmat.x: applies various kinds of Acoustic Sum Rule (ASR), calculates LO-TO
splitting at q = 0 in insulators, IR and Raman cross sections (if the coefficients have been
properly calculated), from the dynamical matrix produced by ph.x
PH/q2r.x: calculates Interatomic Force Constants (IFC) in real space from dynamical
matrices produced by ph.x on a regular q-grid
PH/matdyn.x: produces phonon frequencies at a generic wave vector using the IFC file
calculated by q2r.x; may also calculate phonon DOS, the electron-phonon coefficient λ,
the function α2 F (ω)
PH/lambda.x: also calculates λ and α2 F (ω), plus Tc for superconductivity using the
McMillan formula
PH/alpha2f.x: also calculates λ and α2 F (ω). It is used together with the optimized
tetrahedron method and shifted q-grid
PH/fqha.x: a simple code to calculate vibrational entropy with the quasi-harmonic ap-
proximation
Links to the main Quantum ESPRESSO bin/ directory are automatically generated.
4 Using PHonon
Phonon calculation is presently a two-step process. First, you have to find the ground-
state atomic and electronic configuration; Second, you can calculate phonons using Density-
Functional Perturbation Theory. Further processing to calculate Interatomic Force Constants,
to add macroscopic electric field and impose Acoustic Sum Rules at q = 0 may be needed. In
the following, we will indicate by q the phonon wavevectors, while k will indicate Bloch vectors
used for summing over the Brillouin Zone.
4
The main code ph.x can be used whenever PWscf can be used, with the exceptions of hybrid
and meta-GGA functionals, external electric fields, constraints on magnetization, nonperiodic
boundary conditions. USPP and PAW are not implemented for higher-order response calcula-
tions. See the header of file PHonon/PH/phonon.f90 for a complete and updated list of what
PHonon can and cannot do.
Since version 4.0 it is possible to safely stop execution of ph.x code using the same mecha-
nism of the pw.x code, i.e. by creating a file prefix.EXIT in the working directory. Execution
can be resumed by setting recover=.true. in the subsequent input data. Moreover the exe-
cution can be (cleanly) stopped after a given time is elapsed, using variable max seconds. See
example/Recover example/.
5
done one q-vector at the time, a simpler procedure is to specify variable ldisp=.true. and to
set variables nq1, nq2, nq3 to some suitable Monkhorst-Pack grid, that will be automatically
generated, centered at q = 0.
Second, code q2r.x reads the dynamical matrices produced in the preceding step and
Fourier-transform them, writing a file of Interatomic Force Constants in real space, up to a
distance that depends on the size of the grid of q-vectors. Input documentation in the header
of PHonon/PH/q2r.f90.
Program matdyn.x may be used to produce phonon modes and frequencies at any q us-
ing the Interatomic Force Constants file as input. Input documentation in the header of
PHonon/PH/matdyn.f90.
See Example 02 for a complete calculation of phonon dispersions in AlAs.
1. a scf calculation for the dense k-point grid (or a scf calculation followed by a non-scf
one on the dense k-point grid); specify option la2f=.true. to pw.x in order to save a
file with the eigenvalues on the dense k-point grid. The latter MUST contain all k and
k + q grid points used in the subsequent electron-phonon calculation. All grids MUST
be unshifted, i.e. include k = 0.
2. a normal scf + phonon dispersion calculation on the coarse k-point grid, specifying option
electron phonon=’interpolated’, and the file name where the self-consistent first-order
variation of the potential is to be stored: variable fildvscf). The electron-phonon coeffi-
cients are calculated using several values of Gaussian broadening (see PHonon/PH/elphon.f90)
because this quickly shows whether results are converged or not with respect to the k-
point grid and Gaussian broadening.
3. Finally, you can use matdyn.x and lambda.x (input documentation in the header of
PHonon/PH/lambda.f90) to get the α2 F (ω) function, the electron-phonon coefficient λ,
and an estimate of the critical temperature Tc .
See the appendix for the relevant formulae. Important notice: the q → 0 limit of the con-
tribution to the electron-phonon coefficient diverges for optical modes! please be very careful,
consult the relevant literature.
6
2. Run ph.x.
There is an example in PHonon/example/tetra_example/.
2. Run ph.x with lshift_q = .true. and electron_phonon = "" (or unset it) to generate
the dynamical matrix and the deformation potential (in _ph*/{prefix}_q*/) of each q.
3. Run ph.x with electron_phonon = "lambda_tetra". You should use a denser k grid
by setting nk1, nk2, and nk3. Then lambda*.dat are generated; they contain λqν .
&INPUTPH
! The same as that for the electron-phonon calculation with ph.x
:
/
&INPUTA2F
nfreq = Number of frequency-points for a2F(omega),
/
Then λ, and ωln are computed and they are printed to the standard output. α2 F (ω) and
(partial) phonon-DOS are also computed; they are printed to a file prefix .a2F.dat.
7
4.8 Fourier interpolation of phonon potential
The potential perturbation caused by the displacement of a single atom is spatially localized.
Hence, the phonon potential can be interpolated from q points on a coarse grid to other q points
using Fourier interpolation. To use this functionality, first, one shoud run a ph.x calculation
for q points on a regular coarse grid. Then, a dvscf q2r.x run performs an inverse Fourier
transformation of the phonon potentials from a q grid to a real-space supercell. Finally, by spec-
ifying ldvscf interpolation=.true. in ph.x, the phonon potentials are Fourier transformed
to given q points.
For insulators, the nonanalytic long-ranged dipole part of the potential needs to be sub-
tracted and added before and after the interpolation, respectively. This treatment is activated
by specifying do long range=.true. in the input files of dvscf q2r.x and ph.x.
Due to numerical inaccuracies, the calculated Born effective charges may not add up to zero,
violating the charge neutrality condition. This error may lead to nonphysical polar divergence
of the phonon potential for q points close to Γ, even in IR-inactive materials. To avoid this
problem, one can specify do charge neutral=.true. in the input files of dvscf q2r.x and
ph.x. Then, the phonon potentials and the Born effective charges are renormalized by enforcing
the charge neutrality condition, following the scheme of S. Ponce et al, J. Chem. Phys. (2015).
The Fourier interpolation of phonon potential is proposed and described in the following
papers:
A. Eiguren and C. Ambrosch-Draxl, Phys. Rev. B 78, 045124 (2008);
S. Ponce et al, J. Chem. Phys. 143, 102813 (2015);
X. Gonze et al, Comput. Phys. Commun., 248, 107042 (2020).
5 Parallelism
We refer to the corresponding section of the PWscf guide for an explanation of how parallelism
works.
ph.x may take advantage of MPI parallelization on images, plane waves (PW) and on k-
points (“pools”). Currently all other MPI and explicit OpenMP parallelizations have very
limited to nonexistent implementation. phcg.x implements only PW parallelization. All other
codes may be launched in parallel, but will execute on a single processor.
In “image” parallelization, processors can be divided into different “images”, corresponding
to one (or more than one) “irrep” or q vectors. Images are loosely coupled: processors com-
8
municate between different images only once in a while, so image parallelization is suitable for
cheap communication hardware (e.g. Gigabit Ethernet). Image parallelization is activated by
specifying the option -nimage N to ph.x. Inside an image, PW and k-point parallelization can
be performed: for instance,
will run 8 images on 8 processors each, subdivided into 2 pools of 4 processors for k-point
parallelization. In order to run the ph.x code with these flags the pw.x run has to be run with:
without any -nimage flag. After the phonon calculation with images the dynmical matrices
of q-vectors calculated in different images are not present in the working directory. To obtain
them you need to run ph.x again with:
and the recover=.true. flag. This scheme is quite automatic and does not require any
additional work by the user, but it wastes some CPU time because all images stops when
the image that requires the largest amount of time finishes the calculation. Load balancing
between images is still at an experimental stage. You can look into the routine image q irr
inside PHonon/PH/check initial status to see the present algorithm for work distribution
and modify it if you think that you can improve the load balancing.
A different paradigm is the usage of the GRID concept, instead of MPI, to achieve paral-
lelization over irreps and q vectors. Complete phonon dispersion calculation can be quite long
and expensive, but it can be split into a number of semi-independent calculations, using options
start q, last q, start irr, last irr. An example on how to distribute the calculations and
collect the results can be found in examples/GRID example. Reference:
Calculation of Phonon Dispersions on the GRID using Quantum ESPRESSO, R. di Meo, A.
Dal Corso, P. Giannozzi, and S. Cozzini, in Chemistry and Material Science Applications on
Grid Infrastructures, editors: S. Cozzini, A. Laganà, ICTP Lecture Notes Series, Vol. 24,
pp.165-183 (2009).
6 Troubleshooting
ph.x stops with error reading file The data file produced by pw.x is bad or incomplete
or produced by an incompatible version of the code.
ph.x mumbles something like cannot recover or error reading recover file You have
a bad restart file from a preceding failed execution. Remove all files recover* in outdir.
ph.x says occupation numbers probably wrong and continues You have a metallic or
spin-polarized system but occupations are not set to ‘smearing’.
9
ph.x does not yield acoustic modes with zero frequency at q = 0 This may not be
an error: the Acoustic Sum Rule (ASR) is never exactly verified, because the system is never
exactly translationally invariant as it should be. The calculated frequency of the acoustic mode
is typically less than 10 cm−1 , but in some cases it may be much higher, up to 100 cm−1 . The
ultimate test is to diagonalize the dynamical matrix with program dynmat.x, imposing the
ASR. If you obtain an acoustic mode with a much smaller ω (let us say < 1cm−1 ) with all
other modes virtually unchanged, you can trust your results.
“The problem is [...] in the fact that the XC energy is computed in real space on a discrete
grid and hence the total energy is invariant (...) only for translation in the FFT grid. Increasing
the charge density cutoff increases the grid density thus making the integral more exact thus
reducing the problem, unfortunately rather slowly...This problem is usually more severe for
GGA than with LDA because the GGA functionals have functional forms that vary more
strongly with the position; particularly so for isolated molecules or system with significant
portions of “vacuum” because in the exponential tail of the charge density a) the finite cutoff
(hence there is an effect due to cutoff) induces oscillations in rho and b) the reduced gradient
is diverging.”(info by Stefano de Gironcoli, June 2008)
ph.x yields really lousy phonons, with bad or “negative” frequencies or wrong
symmetries or gross ASR violations Possible reasons:
if this happens only for acoustic modes at q = 0 that should have ω = 0: Acoustic Sum
Rule violation, see the item before this one.
wrong atomic masses given in input will yield wrong frequencies (but the content of file
fildyn should be valid, since the force constants, not the dynamical matrix, are written
to file).
convergence threshold for either SCF (conv thr) or phonon calculation (tr2 ph) too large:
try to reduce them.
maybe your system does have negative or strange phonon frequencies, with the approx-
imations you used. A negative frequency signals a mechanical instability of the chosen
structure. Check that the structure is reasonable, and check the following parameters:
For metallic systems: it has been observed that the convergence with respect to the
k-point grid and smearing is very slow in presence of semicore states, and for phonon
wave-vectors that are not commensurate i with the k-point grid (that is, q ̸= ki − kj )
Note that “negative” frequencies are actually imaginary: the negative sign flags eigenvalues of
the dynamical matrix for which ω 2 < 0.
10
Wrong degeneracy error in star q Verify the q-vector for which you are calculating
phonons. In order to check whether a symmetry operation belongs to the small group of q,
the code compares q and the rotated q, with an acceptance tolerance of 10−5 (set in routine
PW/src/eqvect.f90). You may run into trouble if your q-vector differs from a high-symmetry
point by an amount in that order of magnitude.
while the electron-phonon coupling constant λqν for mode ν at wavevector q is defined as
γqν
λqν = 2
(3)
πh̄N (eF )ωqν
where N (eF ) is the DOS at the Fermi level. The spectral function is defined as
1 γqν
α2 F (ω) =
X
δ(ω − ωqν ) . (4)
2πN (eF ) qν h̄ωqν
The electron-phonon mass enhancement parameter λ can also be defined as the first reciprocal
momentum of the spectral function:
X Z
α2 F (ω)
λ= λqν = 2 dω. (5)
qν ω
Note that a factor M −1/2 is hidden in the definition of normal modes as used in the code.
McMillan: " #
ΘD −1.04(1 + λ)
Tc = exp (6)
1.45 λ(1 − 0.62µ∗ ) − µ∗
or (better?) " #
ωlog −1.04(1 + λ)
Tc = exp (7)
1.2 λ(1 − 0.62µ∗ ) − µ∗
where " #
2 Z dω 2
ωlog = exp α F (ω)logω (8)
λ ω
11