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.1.0.tar.gz (133.3 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.0-py2.py3-none-any.whl (145.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-1.1.0.tar.gz
  • Upload date:
  • Size: 133.3 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.0.tar.gz
Algorithm Hash digest
SHA256 87a347ddd800b0e7a07436c563808861e406fbb51b34a1786777a6ad8dbf5e1a
MD5 89e1b160a2f786fd4647b222fc5c64c6
BLAKE2b-256 1fa9d60672e16c49c724d4b0555e70891220bf204dd18436f16a7c861ce8b2a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 145.4 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.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 baf8690684aea96d59c89dc89c310ad0393f908d388ba8a84f623f2db9cef167
MD5 36e925dc851d7ca806c1873d334ee428
BLAKE2b-256 9ddb471c24b8994ada4d002d6b59dc9673942295e7a793a909c77084715fd955

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