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

Uploaded Source

Built Distribution

ipyvasp-0.9.0-py2.py3-none-any.whl (135.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: ipyvasp-0.9.0.tar.gz
  • Upload date:
  • Size: 122.8 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.0.tar.gz
Algorithm Hash digest
SHA256 f98e5a8154b086ead318f859cfecce3cdc61eb0be99ae283de0a1b0f999595bb
MD5 848bd9309f856111ead4b2e48b5d9b8c
BLAKE2b-256 8f639756ba9ec95a4e1528f902631f88e8179e0b066cd98ba3e5f2041b69419c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-0.9.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 135.4 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.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82e5809302cd654636a54265c6085d2999eb226bca432c164b753bba9e38423c
MD5 361cba611ff37753b0b5c7e96f763f37
BLAKE2b-256 c902fdc4b3d7f9be2e19909bfa1855f83ae2898168ce0966e7eee54f2482590f

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