User Guide
user_guide
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 7
| Download | |
| Open PDF In Browser | View PDF |
PostProc User’s Guide (v.6.2.1)
(only partially updated)
Contents
1 Introduction
1
2 People and terms of use
1
3 Compilation
2
4 Usage
4.1 Plotting selected quantities . . . . .
4.2 Band structure, Fermi surface . . .
4.3 Projection over atomic states, DOS,
4.4 Color plot of the Fermi velocity and
4.5 Wannier functions . . . . . . . . . .
4.6 Interfaces to/from other code . . .
4.7 Other tools . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . .
projected band structure . . . . . . .
the orbital character on Fermi surfaces
. . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . .
5 Troubleshooting
1
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3
3
4
4
5
6
6
6
6
Introduction
This guide covers the usage of PostProc, version 6.2.1: an open-source package for postprocessing of data produced by PWscf and CP. PostProc is part of the Quantum ESPRESSO
distribution and requires PWscf to be installed.
Important notice: due to the lack of time and of manpower, this manual is only partially
updated and may contain outdated information.
This guide assumes that you know the physics that PostProc describes and the methods it
implements. 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 directory Doc/ two levels above the one containing this guide; or consult the web site:
http://www.quantum-espresso.org.
Further documentation, beyond what is provided in this guide, can be found in the directory PP/Doc/, containing a copy of this guide. People who want to contribute to Quantum
1
ESPRESSO should read the Developer Manual, found in directory Doc/ two levels above the
one containing this guide: Doc/developer man.pdf.
2
People and terms of use
The PostProc package was originally developed by Stefano Baroni, Stefano de Gironcoli, Andrea Dal Corso (SISSA), Paolo Giannozzi (Univ. Udine), and many others. We mention in
particular:
• Olivia Pulci, Adriano Mosca Conte, Davide Grassano (RomaII) for the pw2gw utility;
• Andrea Benassi (SISSA) for the epsilon utility, Tae Yun Kim and Cheol-Hwan Park
(Seoul National University) for fixes to it;
• Dmitry Korotin (Inst. Met. Phys. Ekaterinburg) for the wannier ham utility;
• Georgy Samsonidze (Bosch Research) for the interface with the Berkeley GW code;
• The late Prof. Eyvaz Isaev for the Fermi Surface code;
• Natalie Holzwarth (WFU) for the PAW projection in code projwfc.f90;
• Takashi Koretsune and Florian Thoele (ETHZ) for noncollinear magnetisation support
with USPP and PAW pseudopotentials in code pw2wannier.f90.
• Leopold Talirz (U.York) for extensions and fixes to pp.x.
PostProc is free software, released under the GNU General Public License. See:
http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt, or the file License in the distribution).
We shall greatly appreciate if scientific work done using the Quantum ESPRESSO distribution will contain an acknowledgment to the following references:
P. Giannozzi, S. Baroni, N. Bonini, M. Calandra, R. Car, C. Cavazzoni, D. Ceresoli,
G. L. Chiarotti, M. Cococcioni, I. Dabo, A. Dal Corso, S. Fabris, G. Fratesi, S. de
Gironcoli, R. Gebauer, U. Gerstmann, C. Gougoussis, A. Kokalj, M. Lazzeri, L.
Martin-Samos, N. Marzari, F. Mauri, R. Mazzarello, S. Paolini, A. Pasquarello, L.
Paulatto, C. Sbraccia, S. Scandolo, G. Sclauzero, A. P. Seitsonen, A. Smogunov, P.
Umari, R. M. Wentzcovitch, J.Phys.: Condens.Matter 21, 395502 (2009)
and
P. Giannozzi, O. Andreussi, T. Brumme, O. Bunau, M. Buongiorno Nardelli, M.
Calandra, R. Car, C. Cavazzoni, D. Ceresoli, M. Cococcioni, N. Colonna, I. Carnimeo, A. Dal Corso, S. de Gironcoli, P. Delugas, R. A. DiStasio Jr, A. Ferretti, A.
Floris, G. Fratesi, G. Fugallo, R. Gebauer, U. Gerstmann, F. Giustino, T. Gorni, J
Jia, M. Kawamura, H.-Y. Ko, A. Kokalj, E. Küçükbenli, M .Lazzeri, M. Marsili, N.
Marzari, F. Mauri, N. L. Nguyen, H.-V. Nguyen, A. Otero-de-la-Roza, L. Paulatto,
S. Poncé, D. Rocca, R. Sabatini, B. Santra, M. Schlipf, A. P. Seitsonen, A. Smogunov, I. Timrov, T. Thonhauser, P. Umari, N. Vast, X. Wu, S. Baroni J.Phys.:
Condens.Matter 29, 465901 (2017)
2
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)
[ ] We used the pseudopotentials C.pbe-rrjkus.UPF and O.pbe-vbc.UPF from
http://www.quantum-espresso.org.
3
Compilation
PostProc is distributed together with 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, PostProc can be compiled by just
typing make pp, from the main Quantum ESPRESSO directory; or typing make from the
PP/ subdirectory. Several executable codes are produced in PP/bin and linked to bin/.
4
Usage
All codes for which input documentation is not explicitly mentioned below have some documentation in the header of the fortran sources. In the following, “Example N” stands for
subdirectory examples/exampleN/.
All quantities whose dimensions are not explicitly specified are in RYDBERG ATOMIC
UNITS. Charge is ”number” charge (i.e. not multiplied by e); potentials are in energy units
(i.e. they are multiplied by e).
4.1
Plotting selected quantities
The main postprocessing code pp.x extracts the specified data from the data files produced by
PWscf (pw.x executable) or CP (cp.x executable); prepares data for plotting by writing them
into formats that can be read by several plotting programs.
Quantities that can be read or calculated are:
charge density
spin polarization
various potentials
local density of states at EF
local density of electronic entropy
STM images
selected squared wavefunction
ELF (electron localization function)
RDG (reduced density gradient)
integrated local density of states
Various types of plotting (along a line, on a plane, three-dimensional, polar) and output formats
(including the popular cube format) can be specified. Moreover data can be saved to an
intermediate (formatted) file so that more data set can be summed or subracted in a later run.
3
The output files can be directly read by the free plotting system Gnuplot (1D or 2D plots),
or by code plotrho.x that comes with PostProc and produces PostScript 2D plots, or by
advanced plotting software XCrySDen and gOpenMol (3D plots).
See file Doc/INPUT PP.* for a detailed description of the input for code pp.x. See Example
01 for an example of a charge density plot, Example 03 for an example of STM image simulation.
Planar averages Code plan avg.x calculates planar averages of Kohn-Sham orbitals. Code
average.x calculates planar averages of quantities calculated by pp.x (e.g. potentials, charge,
magnetization densities). Note that average.x reads the intermediate file produced by pp.x,
not data files produced by pw.x. Examples of usage of average.x can be found in examples/WorkFct ex
and in examples/dipole example/.
All-electron charge pawplot.x produces plots of the all-electron charge for PAW calculations.
About Bader’s analysis In http://theory.cm.utexas.edu/henkelman/code/bader/ one
can find a software that performs Bader’s analysis starting from charge on a regular grid.
One should use PAW to compute the charge density. The required ”cube” format can be
produced using pp.x (info by G. Lapenna who has successfully used this technique, but
adds: “Problems occur with polar X-H bonds or in all cases where the zero-flux of density comes too close to atoms described with pseudo-potentials”). This code should perform decomposition into Voronoi polyhedra as well, in place of obsolete code voronoy.x
(removed from distribution since v.4.2). Alternatively, you can use CRITIC2, available at
https://github.com/aoterodelaroza/critic2, which can read directly pw.x output and
“XSF” files. CRITIC2 functionaly include Bader’s AIM, ELF, laplacian of density and potentials, non-covalente interaction (NCI) plots and much more.
4.2
Band structure, Fermi surface
The code bands.x reads data file(s), extracts eigenvalues, regroups them into bands (the algorithm used to order bands and to resolve crossings may not work in all circumstances, though).
The output is written to a file in a simple format that can be directly read and converted to
plottable format by auxiliary code plotband.x. Unpredictable plots may results if k-points
are not in sequence along lines, or if two consecutive points are the same. The code bands.x
performs as well a symmetry analysis of the band structure. For a complete input description,
seeDoc/INPUT bands.*. See Example 01, Example 04 and Example 06 for simple band plots.
The calculation of Fermi surface can be performed using code fs.x. The resulting file in
.bxsf format can be read and plotted using XCrySDen. See Example 02 for an example of Fermi
surface visualization (Ni, including the spin-polarized case).
4.3
Projection over atomic states, DOS, projected band structure
The code projwfc.x calculates projections of wavefunctions over atomic orbitals. The atomic
wavefunctions are those contained in the pseudopotential file(s). The Löwdin population analysis (similar to Mulliken analysis) is presently implemented. The projected DOS (or PDOS:
the DOS projected onto atomic orbitals) can also be calculated and written to file(s). More
details on the input data are found in file Doc/INPUT PROJWFC.*. The ordering of the various
4
angular momentum components (defined in routine flib/ylmr2.f90) is as follows: P0,0 (t),
P1,0 (t), P1,1 (t)cosφ, P1,1 (t)sinφ, P2,0 (t), P2,1 (t)cosφ, P2,1 (t)sinφ, P2,2 (t)cos2φ, P2,2 (t)sin2φ and
so on, where Pl,m =Legendre Polynomials, t = cosθ = z/r, φ = atan(y/x).
Data produced by code projwfc.x can be further analysed using auxiliary codes sumpdos.x
(sums selected PDOS by specifying the names of files containing the desired PDOS: type
sumpdos.x -h or look into the source code for more details) and plotproj.x . A more sophisticated tools is the script tools/sum states.py, by Julen Larrucea: documentation in
http://larrucea.eu/sum states-py-2/.
The total electronic DOS can also be calculated by code dos.x, whose complete input
documentation is in Doc/INPUT DOS.* See Example 02 for total and projected electronic DOS
calculations, -and for projected band structure; see Example 03 for projected and local DOS
calculations.
The DOS projected over molecular states (e.g. for a molecule on a surface system) can be
computed using code molecularpdos.x (courtesy of Guido Fratesi). See file Doc/INPUT MOLDOS.*
for input documentation and directory MolDos example/ for an example.
4.4
Color plot of the Fermi velocity and the orbital character on
Fermi surfaces
You can plot any quantity on Fermi surfaces as a color plot by using fermisurfer program1 .
fermi_velocity.x and fermi_proj.x are used to generate an input file for fermisurfer from
the output of pw.xor projwfc.x.
fermi_velocity.x generates a color-plot of Fermi velocity. You use it as follows:
1. Run pw.xwith K_POINT automatic.
2. Run
$ fermi_velocity.x -in {pw.x input file}
3. vfermi.frmsf is generated
fermi_proj.x generates a color plot of an orbital character. You use it as follows:
1. Run pw.xwith K_POINT automatic.
2. Run projwfc.x just to generate {prefix}.save/atomic_proj.*.
3. Run
$ fermi_proj.x -in {input file}
Input-file format is as follows:
&PROJWFC
{The same as the input of projwfc.x}
/
{Number of target wavefunctions}
{Index of target WFC1} {Index of target WFC2} {Index of target WFC3} ...
1
http://osdn.jp/projects/fermisurfer/
5
Pn
target
2
|hϕatom
It generates i=1
target(i) |ϕnk i| , where ns and target(i) are the number of the target
wavefunctions and the indices of target wavefunctions, respectively.
4. The above quantity is written into "proj.frmsf", which can be read by FermiSurfer
program.
There is an example of fermi_velocity.x and fermi_proj.x in PP/example/fermisurf_example/.
4.5
Wannier functions
There are several Wannier-related utilities in PostProc:
1. The ”Poor Man Wannier” code pmw.x, to be used in conjunction with DFT+U calculations (see Example 05)
2. The interface with Wannier90 code, pw2wannier.x: see the documentation in W90/ (you
have to install the Wannier90 plug-in)
3. The wannier ham.x code generates a model Hamiltonian in Wannier functions basis: see
examples/WannierHam example/.
Note that the wfdd.x code has been moved to CP.
4.6
Interfaces to/from other code
Codes pw2bgw.x and bgw2pw.x convert data files from pw.x to a format suitable for usage by the
Berkeley GW code, and vice versa. See files Doc/INPUT pw2bgw.* and Doc/INPUT bgw2pw.*
for input data documentation.
Code pw2gw.x converts data files from pw.x to a format suitable for usage by another GW
code, computes optical properties in single-particle approach (Fermi Golden Rule). See file
Doc/INPUT pw2gw.html for input data documentation, directory examples/pw2gw example/
for an example of usage.
Code pw export.x, not compiled by default, is an interface to other codes, documented in
Doc/INPUT pw export.* Code qexml.x, not compiled by default, is a template that is useful
to follow when wrting interfaces.
4.7
Other tools
Code wfck2r.x converts Kohn-Sham orbitals from reciprocal to real space. It is a useful starting
point if you need to access wavefunctions and perform postprocessing operations that are not
implemented in Quantum ESPRESSO.
Code epsilon.x calculates RPA frequency-dependent complex dielectric function. Documentation is in file Doc/eps man.tex.
Code initial state.x calculates the initial state contribution to the Core-level shift. See
examples/CLS IS example/ for an example, and examples/CLS FS example/ for the corrsponding final state calculation of Core-level shifts.
6
5
Troubleshooting
Almost all problems in Quantum ESPRESSO arise from incorrect input data and result in
error stops. Error messages should be self-explanatory, but unfortunately this is not always
true. If the code issues a warning messages and continues, pay attention to it but do not assume
that something is necessarily wrong in your calculation: most warning messages signal harmless
problems.
Some postprocessing codes complain that they do not find some files For Linux
PC clusters in parallel execution: in at least some versions of MPICH, the current directory
is set to the directory where the executable code resides, instead of being set to the directory
where the code is executed. This MPICH weirdness may cause unexpected failures in some
postprocessing codes that expect a data file in the current directory. Workaround: use symbolic
links, or copy the executable to the current directory.
error in davcio in postprocessing codes Most likely you are not reading the correct data
files, or you are not following the correct procedure for postprocessing. In parallel execution:
if you did not set wf collect=.true., the number of processors and pools for the phonon run
should be the same as for the self-consistent run; all files must be visible to all processors.
7
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Page Count : 7 Page Mode : UseOutlines Author : Title : Subject : Creator : LaTeX with hyperref package Producer : pdfTeX-1.40.17 Create Date : 2018:06:22 17:11:34+02:00 Modify Date : 2018:06:22 17:11:34+02:00 Trapped : False PTEX Fullbanner : This is pdfTeX, Version 3.14159265-2.6-1.40.17 (TeX Live 2016/Debian) kpathsea version 6.2.2EXIF Metadata provided by EXIF.tools