Osman Goni Ridwan

Free reference · Checked against VASP 6.6.1

VASP cheat sheets

What to type, how to check that it worked, and what usually goes wrong, for the everyday jobs of a VASP calculation. Each sheet is organized by task, gives the default and the recommended value side by side, and says why, with a link to the lecture that explains the physics.

Where each sheet fits

A calculation moves through the same stages every time. Each box opens its sheet.

  1. PreparePOSCARPOTCARKPOINTSINCAR
  2. RunSlurm job script
  3. ReadOUTCAR, OSZICAR
  4. FixErrors and fixes
  5. WorkflowsRelax → static → DOS and bandsPropertiesMagnetismBarriers (NEB)MD and ML force fields

Essentials

The input files, the job script, the output, and what to do when it fails.

  1. INCAR

    The tags to set yourself, their defaults, smearing choices and copy-ready INCARs for each task.

    ENCUT ISMEAR IBRIONINCAR builder and checker

    Open the sheet →

  2. KPOINTS

    Every KPOINTS format, which mesh suits which lattice, KSPACING and band-structure paths.

    KSPACING KGAMMAk-mesh calculator

    Open the sheet →

  3. POTCAR

    Suffixes decoded, building and checking a POTCAR without printing it, and the rare-earth choice.

    ENCUT LMAXMIXPOTCAR planner

    Open the sheet →

  4. POSCAR

    The format line by line, selective dynamics, CONTCAR reuse and the mistakes that stop a run.

    SYMPREC LATTICE_CONSTRAINTSPOSCAR checker

    Open the sheet →

  5. Slurm job script

    CPU and GPU job scripts, MPI ranks and threads, NCORE and KPAR, chained jobs and monitoring.

    NCORE KPARJob script generator

    Open the sheet →

  6. Reading the output

    Which file holds what, one-line commands for energy, forces, stress, moments and convergence.

    LORBIT NWRITECommand finder

    Open the sheet →

  7. Errors and fixes

    Each error message with its cause and fix, and what to try when the SCF or a relaxation will not converge.

    ALGO AMIXError lookup

    Open the sheet →

Applications

Research workflows, step by step.

  1. Relaxation

    From a starting structure to converged geometry, static energy, DOS and band structure.

    IBRION ISIF EDIFFG

    Open the sheet →

  2. Magnetism

    Ferro-, antiferro- and ferrimagnetic setups, moments, spin–orbit coupling, anisotropy and DFT+U.

    MAGMOM ISPIN NUPDOWNMAGMOM builder

    Open the sheet →

  3. Properties

    Every major property with the tags, earlier steps, output files and analysis tools it needs.

    LOPTICS LEPSILON LAECHGProperty finder

    Open the sheet →

  4. NEB

    Migration barriers with stock VASP and with VTST: setup, climbing image and checks.

    IMAGES SPRING LCLIMB

    Open the sheet →

  5. AIMD and ML force fields

    Thermostats and ensembles, time steps, analysis, and on-the-fly machine-learned force fields.

    MDALGO POTIM ML_MODE

    Open the sheet →

INCAR tag index, A to Z

Every tag used in the course and the sheets, with its default. Each tag name opens its page on the VASP Wiki.

TagWhat it doesDefaultMore
ADDGRIDAn extra, finer grid for the augmentation charges..FALSE.INCAR sheet
AEXXFraction of exact (Hartree–Fock) exchange in a hybrid-functional calculation. With AEXX = 1.0 VASP switches off correlation and runs a full Hartree–Fock calculation.0.25 with LHFCALC = .TRUE.; 0 otherwise—
ALGOElectronic minimization algorithm.Normal (blocked Davidson)INCAR sheet
AMIXLinear mixing parameter for the charge density.0.4 (PAW)INCAR sheet
AMIX_MAGMixing parameter for the magnetization density.1.6INCAR sheet
ANDERSEN_PROBAndersen collision probability per atom per step (MDALGO = 1).0AIMD and ML force fields sheet
BANDGAPHow VASP reports the band gap in OUTCAR (VASP 6.4.3 and later).COMPACT—
BMIXCutoff wave vector of the Kerker mixing for the charge density.1.0INCAR sheet
BMIX_MAGKerker cutoff for the magnetization density.1.0INCAR sheet
CSHIFTComplex shift (broadening) in eV used for LOPTICS.0.1 (for LOPTICS)—
CSVR_PERIODTime scale of the CSVR thermostat (MDALGO = 5).0 (= NVE)AIMD and ML force fields sheet
DIPOLCentre of the cell for the dipole correction, in fractional coordinates.not set (VASP places it half a cell away from the plane of lowest charge density)—
EDIFFSCF stopping criterion: the energy change between steps, in eV.10−4 eVINCAR sheet
EDIFFGWhen a relaxation stops.EDIFF × 10INCAR sheet
EFERMIHow the Fermi energy is placed.LEGACYINCAR sheet
EFIELD_PEADA finite homogeneous electric field (eV/Å), also used internally by LCALCEPS.0.01 in each direction with LCALCEPS, otherwise 0—
EINTThe energy window for LPARD.not set—
EMAXUpper end of the DOS energy window (eV).highest eigenvalue plus a margin—
EMINLower end of the DOS energy window (eV).lowest eigenvalue minus a margin—
ENCUTPlane-wave cutoff in eV: the size of the basis set.the largest ENMAX among the POTCAR filesINCAR sheet
ENINICutoff used during the first, non-self-consistent steps of a run.ENCUT—
GGAExchange–correlation functional of the GGA family.the functional given by LEXCH in the POTCAR, if METAGGA and XC are not set eitherINCAR sheet
GGA_COMPAT.FALSE. restores the full lattice symmetry of the gradient terms of GGA and meta-GGA functionals..TRUE.Magnetism sheet
HFRCUTCoulomb truncation for hybrid functionals.0INCAR sheet
HFSCREENRange-separation parameter of screened hybrids, in Å⁻¹.0 (no screening)INCAR sheet
IBANDThe bands for LPARD.not set—
IBRIONHow the atoms move.−1 if NSW = −1 or 0, otherwise 0 (molecular dynamics)INCAR sheet
ICHAINVTST method: 0 nudged elastic band, 2 dimer, 1 dynamical matrix, 3 Lanczos.0NEB sheet
ICHARGHow the starting charge density is made.2 if ISTART = 0, otherwise 0INCAR sheet
ICORELEVELCore-level energies: 1 initial state, 2 final state with a core hole.0—
IDIPOLDirection of the dipole correction: 1, 2 or 3 along a lattice vector, 4 in all directions.not set—
IMAGESNumber of images between the two end points of an NEB, one folder each (01, 02, …).0NEB sheet
INIWAVHow the orbitals are initialized when no WAVECAR is read. INIWAV = 1 fills them with random numbers.1—
IOPTVTST optimizer: 1 LBFGS, 2 conjugate gradient, 3 quick-min, 7 FIRE (0 = use IBRION).0NEB sheet
ISEARCHLine search used by ALGO = All.0INCAR sheet
ISIFWhich of atoms, cell shape and volume relax, and whether the stress is computed.0 for molecular dynamics (IBRION = 0) or hybrid functionals (LHFCALC = .TRUE.), otherwise 2INCAR sheet
ISMEARHow electrons are smeared over states near the Fermi level.1INCAR sheet
ISPINSpin polarization: 1 off, 2 collinear spin-polarized.1INCAR sheet
ISTARTRead the orbitals from WAVECAR (1) or start from scratch (0).1 if a WAVECAR file exists, otherwise 0INCAR sheet
ISYMHow symmetry is used.2 for PAW; 3 with hybrids (LHFCALC); 1 with ultrasoft potentialsINCAR sheet
IVDWEmpirical van der Waals correction, e.g. 11 for DFT-D3 with zero damping, 12 for Becke–Johnson damping.0 (none)—
I_CONSTRAINED_MConstrain local moments: 1 direction, 2 size and direction, 4 direction and sign (VASP 6.4.0 and later).not setMagnetism sheet
KBLOCKAverages (PCDAT, DOSCAR) are written every KBLOCK × NBLOCK steps.NSWAIMD and ML force fields sheet
KGAMMAΓ-centred mesh for KSPACING..TRUE.INCAR sheet
KPARNumber of k-point groups that run in parallel.1INCAR sheet
KPOINTS_OPT_MODEDiagonalizer for the KPOINTS_OPT step: 0 skip, 1 blocked Davidson, 2 exact.1KPOINTS sheet
KPOINTS_OPT_NKBATCHBatch size of k-points in the KPOINTS_OPT step.the number of irreducible k-points of the self-consistent runKPOINTS sheet
KSPACINGk-mesh from the INCAR: the largest allowed spacing between k-points, in Å⁻¹ (2π included).0.5 (Γ-centred while KGAMMA = .TRUE., its default)INCAR sheet
KSPACING_OPTk-spacing (Å⁻¹, 2π included) of an extra non-self-consistent mesh, used when there is no KPOINTS_OPT file.0.5KPOINTS sheet
LAECHGWrite the all-electron core and valence densities (AECCAR0, AECCAR2) for Bader analysis..FALSE.—
LAMBDAWeight of the penalty term for constrained moments.0Magnetism sheet
LANGEVIN_GAMMALangevin friction per species in ps⁻¹ (MDALGO = 3).0 for each speciesAIMD and ML force fields sheet
LANGEVIN_GAMMA_LLangevin friction of the lattice in ps⁻¹ (MDALGO = 3, ISIF = 3).0AIMD and ML force fields sheet
LASPHNon-spherical gradient corrections inside the PAW spheres..FALSE.INCAR sheet
LATTICE_CONSTRAINTSThree logicals that freeze or free the lattice components during a cell relaxation or MD.no constraintsPOSCAR sheet
LCALCEPSThe same quantities as LEPSILON from finite electric fields; works for hybrids and meta-GGA, gapped systems only..FALSE.—
LCALCPOLBerry-phase electronic polarization..FALSE.—
LCHARGWrite CHGCAR and CHG at the end of the run..TRUE. (VASP 6.0–6.4.2: .NOT. LH5)INCAR sheet
LCHIMAGNMR chemical shielding tensors by linear response..FALSE.—
LCLIMBVTST climbing image: the highest image climbs to the saddle point..TRUE. (VTST)NEB sheet
LDAUSwitch on DFT+U..FALSE.Magnetism sheet
LDAUJJ in eV, one value per species.0 for each speciesMagnetism sheet
LDAULThe l quantum number that gets U, one value per species: 2 for d, 3 for f, −1 for none.2 for each speciesMagnetism sheet
LDAUPRINTHow much of the occupation matrices to print.0Magnetism sheet
LDAUTYPEDFT+U flavour: 1 Liechtenstein (U and J), 2 Dudarev (only U − J matters), 4 like 1 without exchange splitting.2Magnetism sheet
LDAUUU in eV, one value per species.0 for each speciesMagnetism sheet
LDIPOLDipole correction of the potential and forces for slabs and molecules..FALSE.—
LEFGElectric field gradients at the nuclei..FALSE.—
LELFWrite the electron localization function to ELFCAR..FALSE.—
LEPSILONStatic dielectric tensor, Born effective charges and piezoelectric tensor by density-functional perturbation theory (LDA and GGA only)..FALSE.—
LHFCALCSwitches on a hybrid functional with exact exchange..FALSE.INCAR sheet
LHYPERFINEHyperfine coupling constants (spin-polarized runs)..FALSE.—
LKPOINTS_OPTWhether VASP reads the KPOINTS_OPT file..TRUE. if a KPOINTS_OPT file is presentKPOINTS sheet
LMAXMIXHighest angular momentum ℓ of the on-site densities that are mixed and written to CHGCAR.2INCAR sheet
LMIXTAUAlso mix the kinetic-energy density (meta-GGA)..FALSE.INCAR sheet
LNEBCELLVTST solid-state NEB: the cell changes along the path too..FALSE.NEB sheet
LNONCOLLINEARNoncollinear magnetism: each moment can point anywhere..FALSE. (.TRUE. if LSORBIT = .TRUE.)INCAR sheet
LOPTICSFrequency-dependent dielectric function in the independent-particle picture..FALSE.—
LORBITProjections onto atoms and orbitals: PROCAR, projected DOS and site moments.0 (which needs RWIGS; from LORBIT = 10 on, RWIGS is ignored)INCAR sheet
LORBMOMWrite the orbital moments to OUTCAR (spin–orbit runs only)..FALSE.Magnetism sheet
LPARDWrite band- or energy-resolved partial charge densities (PARCHG), e.g. for STM images..FALSE.—
LPHON_DISPERSIONPhonon dispersion along the QPOINTS path, for the primitive cell, from the supercell force constants of the same run (6.3.2 and later)..FALSE.—
LPHON_POLARDipole–dipole (LO–TO) correction for phonon dispersions of polar insulators (6.3.2 and later)..FALSE.Lecture 31
LREALEvaluate the projection operators in real space, which is faster for large cells..FALSE.INCAR sheet
LRPA.TRUE. leaves the exchange-correlation local-field effects out of LEPSILON and LCALCEPS..FALSE.—
LSORBITSpin–orbit coupling..FALSE.INCAR sheet
LSPIRALSpin spirals with the generalized Bloch theorem..FALSE.Magnetism sheet
LVACPOTAVPrint the vacuum potential on both sides of a slab to OUTCAR..FALSE.—
LVHARWrite the ionic plus Hartree potential to LOCPOT (no exchange-correlation): the choice for work functions..FALSE.—
LVTOTWrite the total local potential, exchange-correlation included, to LOCPOT..FALSE.—
LWAVEWrite WAVECAR at the end of the run..TRUE.INCAR sheet
LZEROZKeep the z component of the moments zero in a spin-spiral run..FALSE.—
MAGMOMStarting magnetic moment of each atom in μB, in POSCAR order.1.0 per atom for ISPIN = 2; 3 × 1.0 per atom for noncollinear runsINCAR sheet
MAXMIXHow many previous steps the Broyden mixer keeps.−45INCAR sheet
MDALGOThermostat: 1 Andersen, 2 Nosé–Hoover, 3 Langevin, 4 Nosé–Hoover chain (6.4.0), 5 CSVR (6.4.3).0 (legacy Nosé)AIMD and ML force fields sheet
METAGGAMeta-GGA functional, e.g. R2SCAN.the functional given by LEXCH in the POTCARINCAR sheet
ML_CTIFORBayesian error threshold that decides when to compute a step from first principles.0.02 or 0.002, depending on ML_CALGOAIMD and ML force fields sheet
ML_LMLFFSwitch on VASP's machine-learned force field (VASP 6.3.0 and later)..FALSE.AIMD and ML force fields sheet
ML_MODEForce-field mode: train, select, refit, run, or delta (6.6.0).none (with ML_LMLFF = .TRUE., VASP then trains)AIMD and ML force fields sheet
ML_OUTBLOCKHow often a prediction run (ML_MODE = run) writes output.10 in most casesAIMD and ML force fields sheet
ML_WTSIFWeight of the stress in the force-field fit.1.0 (5.0 with ML_IWEIGHT = 1)AIMD and ML force fields sheet
M_CONSTRTarget moment direction (or vector) of each atom for constrained runs, three numbers per atom.3*NIONS*0.0Magnetism sheet
NBANDSNumber of bands (orbitals) per k-point.max(nint(NELECT + 2)/2 + max(NIONS/2, 3), int(0.6 NELECT))INCAR sheet · Lecture 2
NBLOCKEvery NBLOCK steps VASP writes an XDATCAR frame and updates averages.1AIMD and ML force fields sheet
NBMODHow LPARD selects bands: band list, all bands, or an energy window (absolute or relative to the Fermi level).set from IBAND or EINT—
NCORENumber of cores that work together on one band.1INCAR sheet
NEDOSNumber of points on the DOS energy grid.301INCAR sheet
NELECTTotal number of electrons; set it for charged cells (fewer electrons for a positive charge).the valence electrons of the POTCARs (neutral cell)Lecture 2
NELMMaximum number of SCF steps per ionic step.60INCAR sheet
NELMDLNon-self-consistent steps at the start, before the density is updated.−12 if ISTART = 0, INIWAV = 1 and IALGO = 48 or 50; 0 if a WAVECAR is present; −5 otherwiseINCAR sheet
NELMINMinimum number of SCF steps per ionic step.2INCAR sheet
NFREEIBRION = 1: how many previous steps the quasi-Newton optimizer remembers; IBRION = 5, 6: displacements per direction.2 for IBRION = 5 and 6, otherwise 0Relaxation sheet
NHC_NCHAINSLength of the Nosé–Hoover chain (MDALGO = 4).0 (= NVE)AIMD and ML force fields sheet
NHC_PERIODTime scale of the Nosé–Hoover chain thermostat, in MD steps.40AIMD and ML force fields sheet
NPARLegacy: the number of band groups (MPI ranks ÷ NCORE).the number of MPI ranksINCAR sheet
NSIMNumber of bands optimized at once in the blocked algorithms.4INCAR sheet
NSWMaximum number of ionic steps.0INCAR sheet
NUPDOWNFixes the difference between spin-up and spin-down electrons, i.e. the total moment.not set (free)INCAR sheet
PMASSFictitious mass of the lattice for NpT (MDALGO = 3, ISIF = 3), in amu.1000AIMD and ML force fields sheet
POMASSAtomic masses (amu) per species, overriding the POTCAR values.from the POTCARAIMD and ML force fields sheet
POTIMStep size: the time step in fs for MD, a step scaling for relaxations, the displacement in Å for finite differences.0.5 for IBRION = 1, 2 and 3; 0.015 Å for IBRION = 5 and 6; none for molecular dynamics (must be set)INCAR sheet
PRECPrecision mode: sets the default FFT grids.Normal (Medium in VASP 4)INCAR sheet
PSTRESSAn external pressure in kB (1 kB = 0.1 GPa) that relaxations and NpT runs target.0Relaxation sheet
QSPIRALPropagation vector of a spin spiral, in units of the reciprocal lattice vectors.0 0 0Magnetism sheet
RANDOM_SEEDSeed of the random numbers (initial velocities, stochastic thermostats).from the system clockAIMD and ML force fields sheet
RWIGSRadius of the sphere around each species (Å) used to integrate local quantities.−1 (from the POTCAR when LORBIT ≥ 10)Magnetism sheet
SAXISSpin quantization axis of noncollinear runs: MAGMOM and the printed moments refer to it.0 0 1Magnetism sheet
SIGMASmearing width in eV.0.2INCAR sheet
SMASSNosé mass for MDALGO = 0 and 2 (−3 = NVE, −1 = velocity rescaling, ≥ 0 = Nosé thermostat); damping for IBRION = 3.−3AIMD and ML force fields sheet
SPRINGSpring constant between images; a negative value switches on nudging.−5NEB sheet
SYMPRECTolerance for finding symmetry from the POSCAR positions.1E-5INCAR sheet
SYSTEMA free-text title for the run, printed in the output files.unknown system—
TEBEGStarting temperature (K); velocities are drawn from it if POSCAR has none.0AIMD and ML force fields sheet
TEENDFinal temperature (K) of a linear ramp.TEBEGAIMD and ML force fields sheet
TIMETrial time step of the electronic algorithms ALGO = Damped and All.0.4—
VELOCITYWrite the velocities to vaspout.h5 (VASP 6.4 and later)..FALSE.AIMD and ML force fields sheet

How the sheets are checked

  • Every tag, default and recommendation is read on the VASP Wiki when its sheet is written, and the sheet says which VASP version it was checked against.
  • Every INCAR on a sheet is checked by the same rules as the INCAR checker, and the build rejects unknown or misspelled tags.
  • Shell commands are tested on real VASP output files.
  • Labels separate VASP's own advice from rules of thumb, and say when a setting needs a newer VASP or the VTST add-on.

Part of a course

These sheets are the practical side of Density Functional Theory and VASP, a free interactive course that builds the physics behind every tag, from the Schrödinger equation to Kohn–Sham DFT, k-points, plane waves and PAW.