quantum-espresso/PW/examples
Paolo Giannozzi 0b7c6cda37 Instructions for running examples collected into a single file 2021-01-19 14:19:23 +01:00
..
ESM_example update ESM_example in PW & NEB for GCSCF 2020-12-24 13:09:17 +09:00
EXX_example [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
VCSexample [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
cluster_example cluster_example was still containing references to obsolete variables 2017-12-06 05:52:59 +00:00
dftd3_example add example for Grimme-D3 in PW 2018-04-26 22:12:46 +02:00
example01 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example02 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example03 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example04 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example05 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example06 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example07 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example08 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example09 Updated refences for PW examples and smearing option changed from 2017-02-07 12:35:50 +00:00
example10 [skip-CI] Example for electric field updated to describe how to compute Z* 2020-11-15 11:59:01 +01:00
example11 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example12 [Skip-CI] ATOMIC_POSITIONS and CELL_PARAMETERS cards without units are 2019-02-23 22:45:29 +01:00
example13 Added tests in the test-suite to check DFT+U+V forces and stress, 2020-04-22 21:21:21 +02:00
gatefield Monofield renamed everywhere to gatefield, according to comment to the QE paper 2017-08-16 19:55:30 +00:00
vdwDF_example Calculate vdW kernel on the fly: fourth commit 2019-09-23 14:50:52 -04:00
README Instructions for running examples collected into a single file 2021-01-19 14:19:23 +01:00
clean_all
run_all_examples

README

These examples cover most programs and features of the PW package.
See comments in file "environment_variables" in the top QE directory
for instructions on how to run these examples.

-----------------------------------------------------------------------

                   LIST AND CONTENT OF THE EXAMPLES

For each example, more detailed information is provided by the README file 
contained in the corresponding directory.

example01:
    This example shows how to use pw.x to calculate the total energy
    and the band structure of four simple systems: Si, Al, Cu, Ni.

example02:
    This example shows how to use pw.x to compute the equilibrium
    geometry of a simple molecule, CO, and of an Al (001) slab.
    In the latter case the relaxation is performed in two ways:
    1) using the quasi-Newton BFGS algorithm
    2) using a damped dynamics algorithm.

example03:
    This example shows how to use pw.x to perform molecular dynamics
    for 2- and 8-atom cells of Si starting with compressed bonds along
    (111).

example04:
    This example shows how to calculate the polarization via Berry
    Phase in PBTiO3 (contributed by the Vanderbilt Group in Rutgers
    University).

example05:
    This example shows how to calculate the total energy of an
    isolated atom in a supercell with fixed occupations.
    Two examples: LDA energy of Al and sigma-GGA energy of O.

example06:
    This example shows how to use pw.x to calculate the total energy
    and the band structure of four simple systems in the non-collinear
    case: Fe, Cu, Ni, O.

example07:
    This example shows how to use pw.x to calculate the total energy
    and the band structure of fcc-Pt with a fully relativistic US-PP
    which includes spin-orbit effects.

example08:
    This example shows how to use pw.x to calculate the total energy of FeO
    using LDA+U approximation.

example09:
    This example shows how to use pw.x to perform TPSS metaGGA calculations
    for C4H6

example10:
    This example shows how to use pw.x to perform electronic structure
    calculations in the presence of a finite electric field described 
    through the modern theory of the polarization. The example shows how to
    calculate the dielectric constant of Si and the effective charges of AlAs.

example11:
    This example tests pw.x with PAW in the noncollinear, spin-orbit case.
    It calculates the band structure of ferromagnetic bcc-Fe.

example12:
    This example tests pw.x for the noncollinear/spin-orbit case with 
    DFT+U and Ultrasoft pseudopotentials.

example13:
   This example shows how to use pw.x to calculate the total energy
   of LiCoO2 using DFT+U+V with ultrasoft pseudopotentials.

Additional feature-specific examples:


EXX_example:
    Use experimental implementation of Hybrid Functional to compute
    total energy of Silicon using different values for nq and for
    calculation of binding energy of o2,co,n2 from calculations in a
    12 au cubic box and gamma sampling.

ESM_example:
    This example shows how to use the Effective Screening Medium Method (ESM)
    in pw.x to calculate the total energy, charge density, force, and
    potential of a polarized or charged medium. Calculations are for a water
    molecule and an Al(111) electrode.

VCSexample:
    This example shows how to use pw.x to optimize crystal structures at two
    pressures for As.

cluster_example:
    This example shows how to use pw.x to calculate propeties of
    isolated systems decoupling periodic images by using
    Martyna-Tuckerman approach with truncated coulomb interaction.

vdwDF_example:
    This example shows how to use the vdw-DF functional in pw.x.