VASPKIT: A User-friendly Interface Facilitating High-throughput Computing and Analysis Using VASP Code

Abstract

We present the VASPKIT, a command-line program that aims at providing a powerful and user-friendly interface to perform high-throughput analysis of a variety of material properties from the raw data produced by the VASP code. It consists of mainly the pre- and post-processing modules. The former module is designed to prepare and manipulate input files such as the necessary input files generation, symmetry analysis, supercell transformation, k-path generation for a given crystal structure. The latter module is designed to extract and analyze the raw data about elastic mechanics, electronic structure, charge density, electrostatic potential, linear optical coefficients, wave function plots in real space, and etc. This program can run conveniently in either interactive user interface or command line mode. The command-line options allow the user to perform high-throughput calculations together with bash scripts. This article gives an overview of the program structure and presents illustrative examples for some of its usages. The program can run on Linux, MacOS, and Windows platforms. The executable versions of VASPKIT and the related examples, together with the tutorials, are available in its official website vaspkit.com.

33 pages, 19 figures

References in corpus (4)

• Quantum ESPRESSO: a modular and open-source software project for quantum simulations of materials
• Advanced capabilities for materials modelling with Quantum ESPRESSO
• Necessary and Sufficient Elastic Stability Conditions in Various Crystal Systems
• Quasiparticle band structure based on a generalized Kohn-Sham scheme

Cited by in corpus (218)

• Monolayer fullerene networks as photocatalysts for overall water splitting
• Electronic and magnetic excitations in La${}_3$Ni${}_2$O${}_7$
• A unique van Hove singularity in kagome superconductor CsV${}_{3-x}$Ta${}_x$Sb${}_5$ with enhanced superconductivity
• Ultrahigh thermal conductivity and strength in direct-gap semiconducting graphene-like BC6N: A first-principles and classical investigation
• Structural, electronic, thermal and mechanical properties of C60-based fullerene two-dimensional networks explored by first-principles and machine learning
• Silabenzene Incorporated Covalent Organic Frameworks
• Visualization of Chiral Electronic Structure and Anomalous Optical Response in a Material with Chiral Charge Density Waves
• Imperfections are not 0 K: free energy of point defects in crystals
• Intertwining of magnetism and charge ordering in kagome FeGe
• Electrically tunable magnetism and unique intralayer charge transfer in Janus monolayer MnSSe for spintronics applications
• Mutual modulation via charge transfer and unpaired electrons of catalyt-ic site for superior intrinsic activity of N2 reduction: from high-throughput computations assisted with machine learning perspective
• Structure-Composition-Property Relationships in Antiperovskite Nitrides: Guiding a Rational Alloy Design
• Ferrimagnetic Regulation of Weyl Fermions in a Noncentrosymmetric Magnetic Weyl Semimetal
• Two-dimensional rare-earth Janus 2$\text{H}$-Gd$\text{XY}$ ($\text{X}$,$\text{Y}$=Cl, Br, I, $\text{X}$$\ne$$\text{Y}$) monolayers: Bipolar ferro-magnetic semiconductors with high Curie temperature and large valley polarization
• Highly Efficient Hydrogen Storage of Sc Decorated Biphenylene Monolayer near Ambient-temperature: An Ab-initio Simulation
• Van Hove tuning of AV3Sb5 kagome metals under pressure and strain
• Con-CDVAE: A method for the conditional generation of crystal structures
• Zeeman effect in centrosymmetric antiferromagnets controlled by an electric field
• Nano-imaging of the edge-dependent optical polarization anisotropy of black phosphorus
• Quantum oscillations revealing topological band in kagome metal ScV6Sn6
• Machine-learning interatomic potential for molecular dynamics simulation of ferroelectric KNbO3 perovskite
• Dynamics and Resilience of the Charge Density Wave in a bilayer kagome metal
• Scaling of Berry-curvature monopole dominated large linear positive magnetoresistance
• Orbital hybridization-driven charge density wave transition in CsV3Sb5 kagome superconductor
• Calculated Effects of Vacancy and Ti-doping in 2D Janus MoSSe for Photocatalysis
• Boosting photocatalytic water splitting of polymeric C${}_{60}$ by reduced dimensionality from 2D monolayer to 1D chain
• Fragile Symmetry-Protected Half Metallicity in Two-Dimensional van der Waals Magnets: A Case Study of Monolayer FeCl2
• Highly Modulated Dual Semimetal and Semiconducting Gamma-GeSe with Strain Engineering
• Oxygen Deficient α-MoO3 with Promoted Adsorption and State-Quenching of H2O for Gas Sensor: A DFT Study
• Electronic state unfolding for plane waves: energy bands, Fermi surfaces and spectral functions
• First principles feasibility assessment of a topological insulator at the InAs/GaSb interface
• Inhibition of steel corrosion with imidazolium-based compounds -- experimental and theoretical study
• Multiscale simulations of growth-dominated Sb${}_2$Te phase-change material for non-volatile photonic applications
• Large photo-induced tuning of ferroelectricity in sliding ferroelectrics
• Multi-k magnetic structure and large anomalous Hall effect in candidate magnetic Weyl semimetal NdAlGe
• AI-Driven Accelerated Discovery of Intercalation-type Cathode Materials for Magnesium Batteries
• Enforced symmetry breaking for anomalous valley Hall effect in two-dimensional hexagonal lattices
• Two-dimensional Dual-Switchable Ferroelectric Altermagnets: Altering Electrons and Magnons
• First-principles study on phase stability and physical properties of B-site ordered Nd${}_2$FeCrO${}_6$ double perovskite
• Strain Engineering of 2D-C3N5 Monolayer and its Application in Overall Water-Splitting: A Hybrid Density Functional Study
• Unusual magnetotransport and anomalous Hall effect in quasi-two-dimensional van der Waals ferromagnet Fe${}_4$GeTe${}_2$
• Superconductivity of Light-Elements Doped H${}_3$S
• Large in-plane negative piezoelectricity and giant nonlinear optical susceptibility in elementary ferroelectric monolayers
• Intrinsic and tunable quantum anomalous Hall effect and magnetic topological phases in XYBi2Te5
• Fast Intercalation of Lithium in Semi-Metallic γ-GeSe Nanosheet: A New Group-IV Monochalcogenide for Lithium-Ion Battery Application
• Electronic Origin of Non-Zone-Center Phonon Condensations: Octahedral Rotations as A Case Study
• Protection of Ising spin-orbit coupling in bulk misfit superconductors
• Benchmarking exchange-correlation potentials with the mstar60 dataset: Importance of the nonlocal exchange potential for effective mass calculations in semiconductors
• Momentum matching and band-alignment type in van der Waals heterostructures: Interfacial effects and materials screening
• Emerging negative Poisson's ratio driven by strong intralayer interaction response in rectangular transition metal chalcogenides
• Modeling Extensive Defects in Metals through Classical Potential-Guided Sampling and Automated Configuration Reconstruction
• Synthesis of metalloborophene nanoribbons on Cu(110)
• Near-Infrared and Visible-range Optoelectronics in 2D Hybrid Perovskite/Transition Metal Dichalcogenide Heterostructures
• Decoding the hidden dynamics of super-Arrhenius hydrogen diffusion in multi-principal element alloys via machine learning
• Revealing the two-dimensional electronic structure and anisotropic superconductivity in a natural van der Waals superlattice (PbSe)${}_{1.14}$NbSe${}_2$
• Post-Transition Metal Sn-Based Chalcogenide Perovskites: A Promising Lead-Free and Transition Metal Alternative for Stable, High-Performance Photovoltaics
• Anisotropic superconductivity in topological crystalline metal Pb${}_{1/3}$TaS${}_2$ with multiple Dirac fermions
• Controlled Curie temperature, magnetocrystalline anisotropy, and valley polarization in 2D ferromagnetic Janus 2H-VSeS monolayer
• Multimechanism quantum anomalous Hall and Chern number tunable states in germanene (silicene, stanene)/$M$Bi${}_2$Te${}_4$ heterostructures
• Exploring Fermi Surface Nesting and the Nature of Heavy Quasiparticles in the Spin-Triplet Superconductor Candidate CeRh${}_2$As${}_2$
• Understanding and predicting trends in adsorption energetics on monolayer transition metal dichalcogenides
• Structural and Electronic Properties of Ta2O5 with One Formula Unit
• Accelerating the prediction of stacking fault energy by combining ab initio calculations and machine learning
• Conversion of La${}_2$Ti${}_2$O${}_7$ to LaTiO${}_2$N via Ammonolysis: An ab-initio Investigation
• Triggering superconductivity, semiconducting states, and ternary valley structure in graphene via functionalization with Si-N layers
• Enhanced Magnetism in Heterostructures with Transition-Metal Dichalcogenide Monolayers
• Universal machine learning interatomic potentials poised to supplant DFT in modeling general defects in metals and random alloys
• ${}^{229}$Th Nuclear Spectroscopy in an Opaque Material: Laser-Based Conversion Electron Mössbauer Spectroscopy of ${}^{229}$ThO${}_2$
• Synthesis and physical properties of a new layered ferromagnet, Cr1.21Te2
• Electronic Structure and Vibrational Stability of Copper-substituted Lead Apatite (LK-99)
• Uniaxial strain tuning of charge modulation and singularity in a kagome superconductor
• Altermagnetism in Two Dimensional Ca${}_2$RuO${}_4$ Perovskite
• Remarkably Enhanced Dynamic Oxygen Migration on Graphene Oxide Supported by Copper Substrate
• Transition from antiferromagnets to altermagnets: Symmetry-Breaking Theory
• Abnormal behavior of preferred formation of cationic vacancy from the interior in γ-GeSe monolayer with the stereo-chemical antibonding lone-pair state
• Low-temperature acanthite-like phase of Cu${}_2$S: A first-principles study on electronic and transport properties
• Frustration-induced magnetic bimerons in transition metal halide CoX2 (X = Cl, Br) monolayers
• Symmetry-breaking induced surface magnetization in non-magnetic RuO${}_2$
• Structural phase transition in monolayer gold(I) telluride: From a room-temperature topologicalinsulator to an auxetic semiconductor
• Global optimization in the discrete and variable-dimension conformational space: The case of crystal with the strongest atomic cohesion
• Origin of Anomalous Hall effect in Cr-doped RuO${}_2$
• Tip-induced creation and Jahn-Teller distortions of sulfur vacancies in single-layer MoS${}_2$
• ElasTool: An automated toolkit for elastic constants calculation
• Anisotropic Electrene T'-Ca2P with Electron Gas Magnetic Coupling as Anode Material for Na/K Ion Batteries
• Quasi-one-dimensional sliding ferroelectricity in NbI${}_4$
• Ferroelasticity tunable altermagnets
• Computational Study of Li+ Solvation Structures in Fluorinated Ether, Non-Fluorinated Ether, and Organic Carbonate-Based Electrolytes at Low and High Salt Concentrations
• High-Throughput Screening of 2D Photocatalyst Heterostructures with Suppressed Electron-Hole Recombination for Solar Water Splitting
• Disordered charge density waves in the kagome metal FeGe
• Predicting the Early Stages of Solid-State Precipitation in Al-rich Al-Pt Alloys
• Correlation: An Analyzing Tool for Liquids and for Amorphous Solids
• Exploring d-Wave Magnetism in Cuprates from Oxygen Moments
• Engineering of a Layered Ferromagnet via Graphitization: An Overlooked Polymorph of GdAlSi
• Avoided metallicity in a hole-doped Mott insulator on a triangular lattice
• Charge order induced Dirac pockets in the nonsymmorphic crystal TaTe${}_4$
• Electrically tunable Gilbert damping in van der Waals heterostructures of two-dimensional ferromagnetic metals and ferroelectrics
• Realized Stable BP-N at Ambient Pressure by Phosphorus Doping
• Optimizing density-functional simulations for two-dimensional metals
• Spontaneous in-plane anomalous Hall response observed in a ferromagnetic oxide
• Theory of Electro-Ionic Perturbations at Supported Electrocatalyst Nanoparticles
• Optimizing Lead-Free Chalcogenide Perovskites for High-Efficiency Photovoltaics via Alloying Strategies
• Revealing the topological phase diagram of ZrTe${}_5$ using the complex strain fields of microbubbles
• KPROJ: A Program for Unfolding Electronic and Phononic Bands
• Ferroelectric Antiferromagnetic Lifting of Spin-Valley Degeneracy
• Locally Spontaneous Dynamic Oxygen Migration on Biphenylene: A DFT Study
• HTESP (High-throughput electronic structure package): a Package for the high-throughput $ab$ $initio$ calculations
• Exploring the energy landscape of aluminas through machine learning interatomic potential
• Universally optimizable strategy for magnetic gaps towards high-temperature quantum anomalous Hall states via magnetic-insulator/topological-insulator building-blocks
• Tuning the Electronic Properties of Two-Dimensional Lepidocrocite Titanium Dioxide Based Heterojunctions
• Two-dimensional carrier gas at a polar interface without surface band gap states: A first-principles perspective
• Optimal model of semi-infinite graphene for ab initio calculations of reactions at graphene edges by the example of zigzag edge reconstruction
• Materials discovery acceleration by using condition generative methodology
• Orbital textures and evolution of correlated insulating state in monolayer 1T phase transition metal dichalcogenides
• Controllable spin splitting in 2D Ferroelectric few-layer ${$γ}$-GeSe
• Polytypic Quantum Wells in Si and Ge: Impact of 2D Hexagonal Inclusions on Electronic Band Structure
• Application of murexide as a capping agent for fabrication of magnetite anodes for supercapacitors: experimental and first-principle studies
• Optimizing Hubbard U parameters for Enhanced Description of Electronic and Magnetic Properties in CrI${}_3$ Monolayers and Bilayers
• Band unfolding with a general transformation matrix: from code implementation to interpretation of photoemission spectra
• Unidirectional Nano-Modulated Binding and Electron Scattering in Epitaxial Borophene
• Surface region band enhancement in noble gas adsorption assisted ARPES on kagome superconductor RbV3Sb5
• Reconstruction of Zigzag Graphene Edges: Energetics, Kinetics and Residual Defects
• Fate of multipolar physics in $5d^2$ double perovskites
• Adsorption tuning of polarity and magnetism in AgCr2S4 monolayer
• Hexagonal boron-carbon fullerene heterostructures; Stable two-dimensional semiconductors with remarkable stiffness, low thermal conductivity and flat bands
• Noncollinear ferrielectricity and hydrogen-induced ferromagnetic polar half-metallicity in MnO${}_3$Cl
• MPd5 kagome superconductors studied by density functional calculations
• Enhanced Superconductivity and Electron Correlations in Intercalated ZrTe${}_3$
• Emergent half-metal with mixed structural order in (111)-oriented (LaMnO${}_3$)${}_{2n}$|(SrMnO${}_3$)${}_n$ superlattices
• Probing Optoelectronic Properties of Stable Vacancy-Ordered Double Perovskites: Insights from Many-Body Perturbation Theory
• Topological electronic states in holey graphyne
• Anisotropic and isotropic elasticity and thermal transport in monolayer C${}_{24}$ networks from machine-learning molecular dynamics
• Twisting in h-BN bilayers and their angle-dependent properties
• Phase engineering of MoS${}_2$ monolayers: A pathway to enhanced lithium-polysulfide battery performance
• High Temperature Quantum Emission from Covalently Functionalized van der Waals Heterostructures
• Revealing the Electronic Structure of van der Waals Antiferromagnetic NiPS${}_3$ through Synchrotron-Based $\mu$-ARPES and Alkali Metal Dosing
• In-Plane Anisotropy-Driven Directional Charge Transport in van der Waals p-n Heterojunction
• Towards atomistic understanding of Iron phosphate glass: a first-principles based DFT modeling and study of its physical properties
• $\mu$2mech: a Software Package Combining Microstructure Modeling and Mechanical Property Prediction
• Competing Lattice Instability and Magnetism on the Surface of Kagome Metals
• Unveiling the Lithium-Ion Transport Mechanism in Li2ZrCl6 Solid-State Electrolyte via Deep Learning-Accelerated Molecular Dynamics Simulations
• Doping-tunable Fermi surface with persistent topological Hall effect in axion candidate EuIn${}_2$As${}_2$
• Large Magnetoresistance and Weak Antilocalization in V1-delta Sb2 Single Crystal
• Unraveling the optical contrast in Sb2Te and AgInSbTe phase-change materials
• Efficient GPU-Accelerated Training of a Neuroevolution Potential with Analytical Gradients
• Understanding and Optimizing the Sensitization of Anatase Titanium Dioxide Surface with Hematite Clusters
• Spin and current transport in the robust half-metallic magnet $c$-CoFeGe
• Introducing antiferromagnetic ordering on the surface states of Bi2Se3 topological insulator by Europium doping
• Electric-field induced half-metallicity in a two-dimensional ferromagnetic Janus VSSe bilayer
• Active learning based generative design for the discovery of wide bandgap materials
• Discovery of an ultrastable antiferromagnetic two-dimensional CrF3 phase with anisotropic quasi-one-dimensional mechanical, electronic, and thermal properties
• Incommensurate Spiral Spin Order in CaMn${}_2$Bi${}_2$ observed via High Pressure Neutron Diffraction
• Coexisting Kagome and Heavy Fermion Flat Bands in YbCr${}_6$Ge${}_6$
• Zeeman-type spin splittings in strained d-wave altermagnets
• Photochemical Anisotropy and Direction-dependent Optical Absorption in Semiconductors
• Towards Identifying the PL6 Center in SiC: From First-Principles Screening to Hyperfine Validation of Competing Defect Candidates
• Bulk OsO2 Single Crystals: Superior Catalysts for Water Oxidation
• Stacking of charge-density waves in 2H-NbSe${}_2$ bilayers
• Evidence of a two-dimensional nitrogen crystalline structure on silver surfaces
• Dirac fermions in the altermagnet Ce4Sb3
• Fermiology and transport properties of the proposed topological crystalline insulator SrAg4Sb2
• Site-selective polar compensation of Mott electrons in a double perovskite heterointerface
• Single-Layer Di-titanium oxide Ti2O MOene: Multifunctional Promises for Electride, Anode Materials, and Superconductor
• Unveiling the impact of trivalent metal cation transmutation on Cs${}_2$AgM(III)Cl${}_6$ double perovskites using many-body perturbation theory
• Ab initio Prediction of Mechanical, Electronic, Magnetic and Transport Properties of Bulk and Heterostructure of a Novel Fe-Cr based Full Heusler Chalcogenide
• Inter-quintuple layer coupling and topological phase transitions in the chalcogenide topological insulators
• HTSC-2025: A Benchmark Dataset of Ambient-Pressure High-Temperature Superconductors for AI-Driven Critical Temperature Prediction
• Theoretical Predictions of MB5N5: Atom-Stuffed Boronitride Clathrate Cages Derived from the High-Pressure Superhydride
• Change in Magnetic Order in NiPS3 Single Crystals Induced by a Molecular Intercalation
• Magnetic collapse in Fe${}_3$Se${}_4$ under high pressure
• Mapping the three-dimensional fermiology of the triangular lattice magnet EuAg${}_4$Sb${}_2$
• Surface Reconstructions in Thin-Films of Magnetic Topological Insulator MnBi${}_2$Te${}_4$
• Tailoring Robust Quantum Anomalous Hall Effect via Entropy-Engineering
• Machine-Learned Interatomic Potential for Predictive Simulation of MoS2 Epitaxy
• Angular dependence of the interlayer coupling at the interface between two dimensional materials 1T-PtSe${}_2$ and graphene
• Guest-induced phase transition leads to polarization enhancement in MHyPbCl3
• MoireStudio: A Universal Twisted Electronic Structure Calculation Package
• Effects of Compression on the Local Iodine Environment in Dipotassium Zinc Tetraiodate(V) Dihydrate K2Zn(IO3)4.2H2O
• Anomalous Hall effect from nonlinear magnetoelectric coupling
• Possible gapless helical edge states in hydrogenated graphene
• Kinetically Arrested Twin-Domain State in Formamidinium Lead Iodide
• Signature of Topological Semimetal in Harmonic-honeycomb ReO3
• Defect engineering of ultrathin gallium nitride via electric fields for advanced electronic, magnetic, and gas sensing applications
• Orbital-Energy Splitting in Anion Ordered Ruddlesden-Popper Halide Perovskites for Tunable Optoelectronic Applications
• Interpretation of Crystal Energy Landscapes with Kolmogorov-Arnold Networks
• Efficiency of band edge optical transitions of 2D monolayer materials: A high-throughput computational study
• Benchmarking Chemically Scalable Machine-Learning Interatomic Potentials for Large-Scale Simulations of Multicomponent Alloys
• Functionalities of Au2O, Au2O3, Au2O3-x, and nanosheets, including spontaneous polarization, using DFT and hybrid functional
• An ab initio approach to anisotropic alloying into the Si(001) surface
• Theoretical Study on the Structural and Thermodynamic Properties of U-He compounds under High Pressure
• Uniaxial stress tuning of interfacial thermal conductance in cubic BAs/4H-SiC heterostructures
• Dynamic Modulation of Electronic and Optical Properties in GaN Bilayers by Interlayer Sliding
• Dimensional crossover and emergence of novel phases in puckered PdSe${}_2$ under pressure
• Electrically switchable non-relativistic Zeeman spin splittings in collinear antiferromagnets
• Strain Tunable Photocatalytic Ability of $B{C}_{6}N$ Monolayer
• Orbital-selective spin-triplet superconductivity in infinite-layer LaNiO${}_2$
• Precompression engineering of metal-insulator transition and magnetism in designed breathing kagome systems
• First-principles study of the bandgap renormalization and optical property of $\beta$-LiGaO${}_2$
• Realization of Nearly Dispersionless Bands with Strong Orbital Anisotropy from Destructive Interference in Twisted Bilayer MoS2
• Moiré potential, lattice corrugation, and band gap spatial variation in a twist-free MoS2/MoTe2 heterobilayer
• Extrinsic nature of the polarization in hafnia ferroelectrics
• Symmetry-breaking-induced topology in FeSe
• Deformation mechanisms and compressive response of NbTaTiZr alloy via machine learning potentials
• Tunable polar distortions and magnetism in Gd${}_x$La${}_{1-x}$PtSb epitaxial films
• Elastic properties of amorphous LiTaCl${}_6$ solid-state electrolyte
• Discovery of Van Hove Singularities: Electronic Fingerprints of 3Q Magnetic Order in a van der Waals Quantum Magnet
• Quantized Spin Hall Effect in Three-Dimensional Nodal-Ring Semimetal: Geometric Scaling and Symmetry-Engineered Spin Response
• Quantum oscillation fingerprints of altermagnetism in hole-doped RuO2
• Electrochromism of Ni-deficient nickel oxide -- Theoretical justification
• Pressure-Driven Structural Phase Competition and Functional Response in Layered LiInP2S6
• Water reactions on reconstructed rutile TiO${}_2$: a DFT / DFTB approach
• Single crystal growth, structural and physical properties, and absence of a charge density wave in Ti_{0.85}Fe6Ge6
• Engineering stacking-induced topological phase transitions in bilayer heterostructures
• Theory of unconventional magnetism in a Cu-based kagome metal
• Strain-Engineered s-C${}_3$N${}_6$ Monolayer for Efficient Water Splitting: A first-principles study
• High-temperature observation of intralayer, interlayer, and Rydberg excitons in bulk van der Waals alloy single crystals
• Emergence of spin-orbit coupled ferromagnetic surface state derived from Zak phase in a nonmagnetic insulator FeSi
• Pair anisotropy in disordered magnetic systems
• Understanding oxide surface stability: Theoretical insights from silver chromate