Skip to content

ToAmano/VisualizePhonon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VisualizePhonon

Phonon visualization tool from VASP OUTCAR

Installation

We support both local and pypi installation.

For local installation:

$git clone https://github.com/ToAmano/VisualizePhonon.git
$cd VisualizePhonon
$pip install .

For pip installation:

$pip install VisualizePhonon

Usage

After installation, we have "vaspvis.py" command to extract data from OUTCAR.

%vaspvis generate --help
usage: vaspvis generate [-h] [--input INPUT] [--format {xsf,xyz,asy}]
                        [--mode MODE] [--scale SCALE]

options:
  -h, --help            show this help message and exit
  --input INPUT, -i INPUT
                        input data. VASP OUTCAR is supported.
  --format {xsf,xyz,asy}, -f {xsf,xyz,asy}
                        Output data format. default to xsf
  --mode MODE, -m MODE  The vibration mode. -1 for all modes. default to -1.
  --scale SCALE, -s SCALE
                        Scale factor of the eigenvector. default to 1.

The following example extracts all the modes to xsf format:

vaspvis generate -i OUTCAR -f xsf -m -1 -s 1.0

You can find an example in the "examples/" directory.

Citation

If you find the tool useful and use it in the publication, please consider citing the following paper.

Other similar tools

There are several similar tools to extract phonon modes from VASP OUTCAR.

About

Phonon visualization tool from VASP OUTCAR

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages