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.3.tar.gz (123.3 kB view details)

Uploaded Source

Built Distribution

ipyvasp-0.9.3-py2.py3-none-any.whl (135.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: ipyvasp-0.9.3.tar.gz
  • Upload date:
  • Size: 123.3 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.3.tar.gz
Algorithm Hash digest
SHA256 3ab2192c79805b7999b6476d792ca8de04fb7c8a283b1c99e6a112d957ca0094
MD5 ebfe7e9c50efbb298f10375a7d0f4165
BLAKE2b-256 3c666b7742f95bf2ef9e0b35b3929cee26bf09e783672c632b9110bd2218cb32

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-0.9.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 135.9 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.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 396393fe4326fc8e1da831172b7d28644372669383319ed81b97fbe43da4cc4b
MD5 e19402a008b3c8c772d31efa04e2bdce
BLAKE2b-256 4ce18487c57ddad01d8318760701e8dcc35b3d29ed82053b7c05d569d4fc4456

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