pyVASPlot

Welcome to pyVASPlot documentation!

pyVASPlot provides tools for analyzing and visualizing electronic-structure data produced by VASP. It is designed to make common analysis workflows easier to reproduce, automate, and customize.

Note

pyVASPlot is under active development, and its API may change between releases. The documentation is also under development and will evolve as the package grows.

Features

• VASP electronic-structure analysis

• Publication-quality visualization

• Python-based and scriptable workflows

• API documentation and examples

• Modern Python tooling with Ruff and uv

Contents

User Guide

• Introduction
  • Project Goals

Examples

• Getting started
  • Show the unit cell with atoms
  • Plot the calculation path
  • Plot the band structure
  • Plot a section of calculated band structure with symmetry M-G-M

API Reference

• pyvasplot
  • pyvasplot.plotting
  • pyvasplot.select

Development

• Changelog
• Contributing