Debian Codegraph @

GUI/PWgui/doc/pwdocs/user_guide/node2.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
3 <!--Converted with LaTeX2HTML 2019.2 (Released June 5, 2019) -->
4 <HTML lang="EN">
5 <HEAD>
6 <TITLE>1 Introduction</TITLE>
7 <META NAME="description" CONTENT="1 Introduction">
8 <META NAME="keywords" CONTENT="user_guide">
9 <META NAME="resource-type" CONTENT="document">
10 <META NAME="distribution" CONTENT="global">
11
12 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
13 <META NAME="viewport" CONTENT="width=device-width, initial-scale=1.0">
14 <META NAME="Generator" CONTENT="LaTeX2HTML v2019.2">
15
16 <LINK REL="STYLESHEET" HREF="user_guide.css">
17
18 <LINK REL="next" HREF="node7.html">
19 <LINK REL="previous" HREF="node1.html">
20 <LINK REL="next" HREF="node3.html">
21 </HEAD>
22
23 <BODY >
24 <!--Navigation Panel-->
25 <A
26 HREF="node3.html">
27 <IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A>
28 <A
29 HREF="user_guide.html">
30 <IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A>
31 <A
32 HREF="node1.html">
33 <IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A>
34 <A ID="tex2html101"
35 HREF="node1.html">
36 <IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A>
37 <BR>
38 <B> Next:</B> <A
39 HREF="node3.html">1.1 People</A>
40 <B> Up:</B> <A
41 HREF="user_guide.html">User's Guide for Quantum-ESPRESSO</A>
42 <B> Previous:</B> <A
43 HREF="node1.html">Contents</A>
44 <B> <A ID="tex2html102"
45 HREF="node1.html">Contents</A></B>
46 <BR>
47 <BR>
48 <!--End of Navigation Panel-->
49
50 <H1><A ID="SECTION00020000000000000000">
51 1 Introduction</A>
52 </H1>
53
54 <P>
55 This guide gives a general overview of the contents and of the installation
56 of Q<SMALL>UANTUM </SMALL>ESPRESSO (opEn-Source Package for Research in Electronic Structure, Simulation,
57 and Optimization), version 6.7MaX.
58
59 <P>
60 <EM>Important notice: due to the lack of time and of manpower, this
61 manual does not cover many important aspects and may contain outdated
62 information.</EM>
63
64 <P>
65 The Q<SMALL>UANTUM </SMALL>ESPRESSO distribution contains the core packages <TT>PWscf</TT> (Plane-Wave
66 Self-Consistent Field) and <TT>CP</TT> (Car-Parrinello) for the calculation
67 of electronic-structure properties within
68 Density-Functional Theory (DFT), using a Plane-Wave (PW) basis set
69 and pseudopotentials. It also includes other packages for
70 more specialized calculations:
71
72 <UL>
73 <LI><TT>PWneb</TT>:
74 energy barriers and reaction pathways through the Nudged Elastic Band
75 (NEB) method.
76 </LI>
77 <LI><TT>PHonon</TT>:
78 vibrational properties with Density-Functional Perturbation Theory
79 (DFPT).
80 </LI>
81 <LI><TT>PostProc</TT>:
82 codes and utilities for data postprocessing.
83 </LI>
84 <LI><TT>PWcond</TT>:
85 ballistic conductance.
86 </LI>
87 <LI><TT>XSPECTRA</TT>:
88 K-, L<SUB>1</SUB>-, L<SUB>2, 3</SUB>-edge X-ray absorption spectra.
89 </LI>
90 <LI><TT>TD-DFPT</TT>:
91 spectra from Time-Dependent
92 Density-Functional Perturbation Theory.
93 </LI>
94 <LI><TT>GWL</TT>: electronic excitations within the GW approximation
95 and with the Bethe-Salpeter Equation
96 </LI>
97 <LI><TT>EPW</TT>: calculation of the electron-phonon coefficients
98 and related quantities;
99 </LI>
100 <LI><TT>HP</TT>: calculation of Hubbard <I>U</I> parameters using DFPT.
101 </LI>
102 </UL>
103 The following auxiliary packages are included as well:
104
105 <UL>
106 <LI><TT>PWgui</TT>:
107 a Graphical User Interface, producing input data files for
108 <TT>PWscf</TT> and some <TT>PostProc</TT> codes.
109 </LI>
110 <LI><TT>atomic</TT>:
111 atomic calculations and pseudopotential generation.
112 </LI>
113 </UL>
114 A copy of required external libraries is also included.
115 Finally, several additional packages that exploit data produced by Q<SMALL>UANTUM </SMALL>ESPRESSO or patch some Q<SMALL>UANTUM </SMALL>ESPRESSO routines can be automatically installed using
116 <TT>make</TT>:
117
118 <UL>
119 <LI><TT>Wannier90</TT>:
120 maximally localized Wannier functions.
121 </LI>
122 <LI><TT>WanT</TT>:
123 quantum transport properties with Wannier functions.
124 </LI>
125 <LI><TT>YAMBO</TT>:
126 electronic excitations within Many-Body Perturbation Theory,
127 GW and Bethe-Salpeter equation.
128 </LI>
129 <LI><TT>GIPAW</TT> (Gauge-Independent Projector Augmented Waves):
130 NMR chemical shifts and EPR g-tensor.
131 </LI>
132 </UL>
133 For Q<SMALL>UANTUM </SMALL>ESPRESSO with the self-consistent continuum solvation (SCCS) model,
134 aka ``Environ'', see <TT>http://www.quantum-environment.org/</TT>.
135
136 <P>
137 Documentation on single packages can be found in the <TT>Doc/</TT>
138 directory of each package. A detailed description of input
139 data is available for most packages in files <TT>INPUT_*.txt</TT> and
140 <TT>INPUT_*.html</TT>.
141
142 <P>
143 The Q<SMALL>UANTUM </SMALL>ESPRESSO codes work on many different types of Unix machines,
144 including parallel machines using both OpenMP and MPI
145 (Message Passing Interface).
146 Q<SMALL>UANTUM </SMALL>ESPRESSO also runs on Mac OS X and MS-Windows machines
147 (see section <A HREF="node9.html#Sec:Installation">2.2</A>). The GPU-enabled version is
148 available on <TT>https://gitlab.com/QEF/q-e-gpu/-/release</TT>.
149
150 <P>
151 Further documentation, beyond what is provided in this guide, can be found in:
152
153 <UL>
154 <LI>the <TT>Doc/</TT> and <TT>examples/</TT> directories
155 of the Q<SMALL>UANTUM </SMALL>ESPRESSO distribution;
156 </LI>
157 <LI>the web site <TT>www.quantum-espresso.org</TT>;
158 </LI>
159 <LI>the archives of the mailing list:
160 See section <A HREF="node4.html#SubSec:Contacts">1.2</A>, ``Contacts'', for more info.
161 </LI>
162 </UL>
163 People who want to contribute to Q<SMALL>UANTUM </SMALL>ESPRESSO should read the
164 Wiki pages on GItLab: <TT>https://gitlab.com/QEF/q-e/-/wiki</TT>.
165
166 <P>
167 This guide does not explain the basic Unix concepts (shell, execution
168 path, directories etc.) and utilities needed to run Q<SMALL>UANTUM </SMALL>ESPRESSO; it does not
169 explain either solid state physics and its computational methods.
170 If you want to learn the latter, you should first read a good textbook,
171 such as e.g. the book by Richard Martin:
172 <EM>Electronic Structure: Basic Theory and Practical Methods</EM>,
173 Cambridge University Press (2004); or:
174 <EM>Density functional theory: a practical introduction</EM>,
175 D. S. Sholl, J. A. Steckel (Wiley, 2009); or
176 <EM>Electronic Structure Calculations for Solids and Molecules:
177 Theory and Computational Methods</EM>,
178 J. Kohanoff (Cambridge University Press, 2006). Then you should consult
179 the documentation of the package you want to use for more specific references.
180
181 <P>
182 All trademarks mentioned in this guide belong to their respective owners.
183
184 <P>
185 <BR><HR>
186 <!--Table of Child-Links-->
187 <A ID="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
188
189 <UL>
190 <LI><A ID="tex2html103"
191 HREF="node3.html">1.1 People</A>
192 <LI><A ID="tex2html104"
193 HREF="node4.html">1.2 Contacts</A>
194 <LI><A ID="tex2html105"
195 HREF="node5.html">1.3 Guidelines for posting to the mailing list</A>
196 <LI><A ID="tex2html106"
197 HREF="node6.html">1.4 Terms of use</A>
198 </UL>
199 <!--End of Table of Child-Links-->
200 <HR>
201 <!--Navigation Panel-->
202 <A
203 HREF="node3.html">
204 <IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A>
205 <A
206 HREF="user_guide.html">
207 <IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A>
208 <A
209 HREF="node1.html">
210 <IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A>
211 <A ID="tex2html101"
212 HREF="node1.html">
213 <IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A>
214 <BR>
215 <B> Next:</B> <A
216 HREF="node3.html">1.1 People</A>
217 <B> Up:</B> <A
218 HREF="user_guide.html">User's Guide for Quantum-ESPRESSO</A>
219 <B> Previous:</B> <A
220 HREF="node1.html">Contents</A>
221 <B> <A ID="tex2html102"
222 HREF="node1.html">Contents</A></B>
223 <!--End of Navigation Panel-->
224
225 </BODY>
226 </HTML>