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-0.9.98.tar.gz (132.9 kB view details)

Uploaded Source

Built Distribution

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

ipyvasp-0.9.98-py2.py3-none-any.whl (145.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-0.9.98.tar.gz
  • Upload date:
  • Size: 132.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for ipyvasp-0.9.98.tar.gz
Algorithm Hash digest
SHA256 84b7e077524f428d433476a034afe55eb7d7212f50fb619c1730aea01cbfe1a3
MD5 69ac1dc264a2d64243bec058e9a51a59
BLAKE2b-256 cbef4f90d278f524c37f9795359e3b593676880aceb9b8cd3fd21a9d77b00616

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-0.9.98-py2.py3-none-any.whl
  • Upload date:
  • Size: 145.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for ipyvasp-0.9.98-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ab50aff7afd8c2edf8ff98776f1e0ea00ba56a64f802092ed31135853ec8c45f
MD5 7cab120e896be4fe1af9a97981ed01ef
BLAKE2b-256 9e90a1ed3f661717e0836ac836648d65e18eb45c05add3cad196e6589ae39b98

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