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.1.tar.gz (141.6 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.1-py2.py3-none-any.whl (153.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-1.2.1.tar.gz
  • Upload date:
  • Size: 141.6 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.1.tar.gz
Algorithm Hash digest
SHA256 57ca78647e78cc922bd97821a944c9df65184cfdfbe282b5cfeb7ec657c21f64
MD5 bb616820f79e6c71aeec479a0a3195a2
BLAKE2b-256 2af7cfcb80ff01a15d4cfc1c5511e274cb724ebd4d37f95c57f4826e11c0de8b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 153.8 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.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e8c86370f8a5e9784682bba947a6e3e4fecaaa55fb5ce489e6b1e1e3862c2e49
MD5 4d0639ec696473fd6800ac0c22c50ea2
BLAKE2b-256 6e0f4f7c70c00ac6cdec4d612e3f84ed1c5d0ffb7128f91048ef0744f4e8cf1d

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