VASPKIT
Overview
VASPKIT: Aims at providing a powerful and user-friendly interface to perform high throughput analysis of various material properties from the raw calculated data using the widely-used VASP code. The program can be conveniently run under either the interactive user interface or command line mode.
Configuration for Users
Vaspkit was installed specifically for the design-lab group.
To configure your profile to use vaspkit, a configuration file needs to be copied into your home folder:
cd ~
cp /project/design-lab/software/vaspkit/vaspkit.1.5.1/how_to_set_environment_variables .vaspkit
You’ll notice within the .vaspkit
file that the VASPKIT_UTILITIES_PATH
and PYTHON_BIN
settings are already appropriately set to the version being used.
The PYTHON_BIN
variable points to a python conda environment containing the various package dependencies required.
You will need to edit the
.vaspkit
file according to your needs. For example, which version ofVASP
are you using, and folder locations forLDA
,PBE
andGGA
paths:VASP5 .TRUE. # .TRUE. or .FALSE.; Set .FALSE. if you are using vasp.4.x LDA_PATH ~/POTCAR/LDA # Path of LDA potential. PBE_PATH ~/POTCAR/PBE # Path of PBE potential. GGA_PATH ~/POTCAR/GGA # Path of PW91 potential. ...
There are also some details on using PBS to submit jobs. Since our cluster uses the SLURM job scheduler, and not PBS, these details will need to be updated accordingly, specific to SLURM.
Since using VASPKIT is out of our domain knowledge, we are happy to work with a user on how best to achieve this.
Make sure that the path of vaspkit’s executables are exported to your bashrc file:
echo 'export PATH=/project/design-lab/software/vaspkit/vaspkit.1.5.1/bin:$PATH' >> ~/.bashrc
Lastly, source your .bashrc file to use the vaspkit commands in your profile:
Multicore
At this stage, it appears that the vaspkit
application can, itself, submit multi node jobs. We are happy to work with a user to better understand how this occurs, and update this section accordingly.