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

This version

1.0.2

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.2.tar.gz (133.1 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.2-py2.py3-none-any.whl (145.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ipyvasp-1.0.2.tar.gz
  • Upload date:
  • Size: 133.1 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.2.tar.gz
Algorithm Hash digest
SHA256 7053fe486a91687dc981fb97f2cc9b2f5835450d04fc73aebeab68f5371a6cba
MD5 2574fd41a82b9998a826ed5b5ceea5fc
BLAKE2b-256 49ce9d993b7919b35b9d004a140bcab511038505368f521038302b7c3c4d53d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyvasp-1.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 145.2 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.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 032e91064d5f3d85f55d587d24414c4f44fd596eb21799735a1f4f2051bb565f
MD5 8b85fc6eabacfe2bce8f79ec57cdd407
BLAKE2b-256 a1fa0cbfaaebf40b52b587f817d5a6cd7040836dec743c543a879f93472345c9

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