Skip to main content

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

Project description

IPyVASP

DOI Binder PyPI Downloads

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 .

Documentataion

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

BandsWidget More coming soon! You can test these examples on Binder.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

ipyvasp-1.1.5.tar.gz (136.3 kB view details)

Uploaded Source

Built Distribution

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

ipyvasp-1.1.5-py2.py3-none-any.whl (148.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-1.1.5.tar.gz
  • Upload date:
  • Size: 136.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for ipyvasp-1.1.5.tar.gz
Algorithm Hash digest
SHA256 e285a64d0bca2cd740e03393f084891a9c2707ea565e852ce7333e76f597eba6
MD5 7958639c77176aca3391fae5ffc3fe40
BLAKE2b-256 0f71086249980cc5bc627c2af958d7f4e20a14215420e03970f61da0f660a723

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 148.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for ipyvasp-1.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 180325d42b94d10c5164d05d230ffc85dd761ab53248056e64a8c1786ea6c9b7
MD5 cfe1370ecd0ebbd97b3a19bdb77b401a
BLAKE2b-256 9fed13407716a712bec42296b392252eb5941340d73f59ff7b5e93bd7288bb53

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