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

This version

1.1.8

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.8.tar.gz (136.7 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.8-py2.py3-none-any.whl (148.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-1.1.8.tar.gz
  • Upload date:
  • Size: 136.7 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.8.tar.gz
Algorithm Hash digest
SHA256 3a332a78a7593441d116a37bb9cd77c236e8965749261fe0aa99974400b809a9
MD5 e13faff2547fe5537b8b5a0008029e59
BLAKE2b-256 77fdc3e40fb3d382d388b5428c2615127637d89bce58c772bb755c349ca5a41d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.1.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 148.9 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.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c9d97499a8690e6bd25cc3187cfb1579e916522d8b8ced81506b0001e190cf09
MD5 012b4ed684a969384c0cf75ae178ef4a
BLAKE2b-256 e9f711cca401ab7ab4ecadb64bccaae1e77889ba5528be5971ddc56975f22a96

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