Skip to main content

A python package to vizualize orbital-resolved band structure and DOS

Project description

Orbvis

Orbital-resolved band structure and DOS vizualization tool


Overview

orbvis is a Python package for visualizing orbital-resolved electronic band structures and density of states (DOS). It is designed to work with output from VASP, and provides clean plots suitable for publication.


Features

  • Orbital-resolved band structure plotting (orbscatter)
  • Partial density of states (pDOS) plotting (plot_pdos)
  • Easy configuration via plain text files (Similar to VASP INCAR file)
  • Modular structure with band and dos submodules
  • Distinct orbital colors via distinctipy
  • Command-line interface (CLI) support

Documentation

Comprehensive documentation is available in the docs directory of the GitHub repository.


Examples

Explore example scripts and usage scenarios in the examples directory.


Contact

For questions, feature requests, or bug reports, please open an issue:issues


Installation

Using pip

pip install orbvis

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orbvis-1.0.2.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

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

orbvis-1.0.2-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orbvis-1.0.2.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for orbvis-1.0.2.tar.gz
Algorithm Hash digest
SHA256 3a97de6798a0c9ba62e397a7aeba154adea8901204b2a1a3500c38b23ca74755
MD5 0546388b8f57344ce0fbea287665fa37
BLAKE2b-256 8700eec10ea6ea61eff04dfdf547cdc8ed963347dfd486e0eb5dd82a4e1457f6

See more details on using hashes here.

File details

Details for the file orbvis-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: orbvis-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for orbvis-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b33a86ed2ebecde53200b6f02258c313bff429ebafaa41386ebef7f7cc23e5c0
MD5 7d7f1e6d440acb6443ec9b47b0f1734d
BLAKE2b-256 80ef099db456f11674ab82deccd0233e3fdfcffc187c9a6a4c770443ffcf461f

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