Skip to main content

A tool for analyzing vibrational modes from VASP OUTCAR files

Project description

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:

"""bash $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:

"""bash 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

visualizephonon-0.0.2.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

visualizephonon-0.0.2-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file visualizephonon-0.0.2.tar.gz.

File metadata

  • Download URL: visualizephonon-0.0.2.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for visualizephonon-0.0.2.tar.gz
Algorithm Hash digest
SHA256 0aa224b6407f1b5f33c713d6c089cbe25c20c2a5eb59e314bd1d3716d725c113
MD5 dd4cb5aaf0a8087aa2e454277463b97b
BLAKE2b-256 b88751224e597d06abe75707138b9db1153cc41f9690ef3a3a899726d076f8c6

See more details on using hashes here.

File details

Details for the file visualizephonon-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for visualizephonon-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d2959d7d425832a7232657fb2780507fb532a29c206bcdefcf416df05649b3ab
MD5 ddfdcaa7e35f8ab195f3e4f58865fda6
BLAKE2b-256 f9c6db8465493217a9230ac9757b1aafbc410e9ef2d7ab919e7e2a890ccb6deb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page