Skip to main content

A processing tool for VASP DFT input/output processing in Jupyter Notebook.

Project description

ipyvasp

An VASP-based DFT pre and post processing tool.

Install

Currently the package is being built and not stable. If you want to use development version, install this way:(recommended to install in a virtual environment)

git clone https://github.com/massgh/ipyvasp.git
cd ipyvasp
pip install -e .

Showcase Examples

Plot 2D BZ layer on top of 3D!

import ipyvasp as ipv
pos =  ipv.POSCAR('FCC POSACR FILE').set_zdir([1,1,1])
ax = pos.splot_bz(vectors = None,color='skyblue',lw=0.2,alpha=0.2,fill=True)

kpts = [[0,-1/2,0],[0,0,0]]
pos.splot_kpath(kpts,labels=[str(k) for k in kpts],zorder=-1) # At 3D BZ

pos2 = pos.transform(lambda a,b,c: (a-c, b-c, a+b+c)) # 111 plane
pos2.splot_bz('xy',ax=ax,zoffset=0.15,vectors=None,color='navy')

kp2 = pos.bz.map_kpoints(pos2.bz, kpts)
pos2.splot_kpath(kp2,labels=[str(k) for k in kp2.round(1).tolist()],color='navy',fmt_label=lambda lab: (lab+'\n', dict(va='center',color='navy')),zorder=3) 

ax.set_axis_off()

BZ

Interactively select bandstructure path by clicking on high symmetry points on plot!

KP

Apply operations on POSCAR and simultaneously view using plotly's FigureWidget in Jupyterlab side by side.

snip

More coming soon!

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

ipyvasp-0.9.5.tar.gz (124.1 kB view details)

Uploaded Source

Built Distribution

ipyvasp-0.9.5-py2.py3-none-any.whl (136.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ipyvasp-0.9.5.tar.gz.

File metadata

  • Download URL: ipyvasp-0.9.5.tar.gz
  • Upload date:
  • Size: 124.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for ipyvasp-0.9.5.tar.gz
Algorithm Hash digest
SHA256 5501e4fb9b27b3d4f18a9d5cc671ead5af985d950e9a9ccbc40eea9b87de6b00
MD5 084cda0ffe07ad09f086915ce30ae8c6
BLAKE2b-256 abd18d293fe8ebe192fcb36de7e28a6692655a0d24cfed09f452d0196f1614ae

See more details on using hashes here.

File details

Details for the file ipyvasp-0.9.5-py2.py3-none-any.whl.

File metadata

  • Download URL: ipyvasp-0.9.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 136.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for ipyvasp-0.9.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cdf8f22eef12d5458bfd46f57f0afa4e409b37c7f781a164ef9ae7ce9bb89c31
MD5 1162cf609ce435cb9e1a96989431ecea
BLAKE2b-256 ffeaa7a7a1d6ad3de33981f1ac6bf265d2285d0631d87a6c127800a862abd3a0

See more details on using hashes here.

Supported by

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