.. QEView documentation master file, created by
   sphinx-quickstart on Mon Feb 24 22:23:14 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

QEView documentation
====================

===========================
Quantum Espresso Analysis and Visualization Tool
===========================

.. sidebar:: QEView 1.0.6

   This is the homepage QEView Version 1.0.6

      .. image:: _static/GitHub-logo.png
         :width: 75%
         :align: center
         :target: https://github.com/EgorcaA/QEView


Overview
--------
This tool is designed to streamline the analysis and visualization of results obtained from **Quantum Espresso** simulations, including:

- **Band Structure**
- **Density of States (DOS, pDOS)**
- **Wannier projection using Wannier90**

By simplifying the interpretation of complex data, this package provides an efficient and user-friendly approach while remaining flexible for customization.

Supported Systems
-----------------
The package supports:

- **2D and 3D materials**
- **Ferromagnetic (FM) and Paramagnetic (PM) configurations**

Key Features
------------
- **Visualization**: Generate clear and insightful visual representations of your simulation results.
- **Predefined Visualization Methods**: A simple and intuitive interface for efficient workflow.
- **Wannier90 Hamiltonian Loading**: Enables **band structure interpolation and plotting** for enhanced analysis.

Getting Started
--------------
Explore the **usage examples** to quickly get up to speed with the tool. Whether you are analyzing band structures or density of states, this package provides the necessary utilities to make your workflow more efficient and insightful.

----

For more details, refer to the respective sections of the documentation.