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.0.3.tar.gz (133.0 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.0.3-py2.py3-none-any.whl (145.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ipyvasp-1.0.3.tar.gz
Algorithm Hash digest
SHA256 63f66d88fd00fdf33d47aa3c4bb45ada61d49b95dc59aff5e02471a2c90545cf
MD5 ec2e94c44e694063b9a70156976f2ecc
BLAKE2b-256 31b16a4e523fa04a5cf4db315662e11696498d7a0702398a6b4bf8b5a4bd66f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 145.1 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.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dc6f3b6b80ad8015c49571be545859bbf12f866049961f033f63d3cfd3e018e4
MD5 a4d414e164f258b9fa6664d923c1a919
BLAKE2b-256 35ee1a299f5d1f7471ba7bafe2e45743a4b8e4740bc1945849a32e8b390fbbce

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