Metadata-Version: 2.4
Name: orbvis
Version: 1.0.2
Summary: A python package to vizualize orbital-resolved band structure and DOS
Author: Taradutt Pattnaik
License: MIT
Project-URL: Repository, https://github.com/staradutt/orbvis
Project-URL: Documentation, https://github.com/staradutt/orbvis/tree/main/docs
Project-URL: Examples, https://github.com/staradutt/orbvis/tree/main/examples
Project-URL: Issues, https://github.com/staradutt/orbvis/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Requires-Dist: distinctipy>=1.3
Requires-Dist: matplotlib>=3.6
Dynamic: license-file

# 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](https://github.com/staradutt/orbvis/tree/main/docs) directory of the GitHub repository.

---

## Examples

Explore example scripts and usage scenarios in the [examples](https://github.com/staradutt/orbvis/tree/main/examples) directory.

---

## Contact

For questions, feature requests, or bug reports, please open an issue:[issues](https://github.com/staradutt/orbvis/issues)

---
## Installation

### Using pip

```bash
pip install orbvis

