Skip to main content

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.

Metadata

Release files for VisualizePhonon 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for VisualizePhonon 0.0.2
File Size Uploaded Provenance Actions
visualizephonon-0.0.2.tar.gz 21.9 kB Without provenance Details for visualizephonon-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for VisualizePhonon 0.0.2
File Interpreter ABI Platform Actions
visualizephonon-0.0.2-py3-none-any.whl Python 3 none any Details for visualizephonon-0.0.2-py3-none-any.whl

Total release size: 32.5 kB

Release files / visualizephonon-0.0.2.tar.gz

Download URL visualizephonon-0.0.2.tar.gz
Size 21.9 kB
Tags Source
SHA-256 checksum
How to use checksums
0aa224b6407f1b5f33c713d6c089cbe25c20c2a5eb59e314bd1d3716d725c113
BLAKE2b-256 checksum
How to use checksums
b88751224e597d06abe75707138b9db1153cc41f9690ef3a3a899726d076f8c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release files / visualizephonon-0.0.2-py3-none-any.whl

Download URL visualizephonon-0.0.2-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d2959d7d425832a7232657fb2780507fb532a29c206bcdefcf416df05649b3ab
BLAKE2b-256 checksum
How to use checksums
f9c6db8465493217a9230ac9757b1aafbc410e9ef2d7ab919e7e2a890ccb6deb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Security for VisualizePhonon 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page