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.2.0.tar.gz (140.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.2.0-py2.py3-none-any.whl (152.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-1.2.0.tar.gz
  • Upload date:
  • Size: 140.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.2.0.tar.gz
Algorithm Hash digest
SHA256 4afdf3002507a02c2eca5fc973db9ee00ba9b8ac4f3e8bd3e5a5fbc32fe12a41
MD5 359ede40432b5c59697ae292772a275e
BLAKE2b-256 91b54006790c9d4f56d9c6106c45fd21742d6328e4c2287b3be64c2c0c4fe5b2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 152.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.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f2d070eb514d20685481099f24d7381949c6dce89a209c6b18bd54dc513de731
MD5 2d98eb12a1e76a7039acc15a25526baf
BLAKE2b-256 a5280227acc8822d5593c147070a2efc3bd59bd344302c14a8a6b3947b2514e3

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