Skip to content

Chengcheng-Xiao/WOBSTER

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wannier-orbital Basis Suite Towards Electronic-Structure Reconstruction (WOBSTER)

A post-processing tool written in python to get Wannier Orbital Overlap Population (WOOP), Wannier Orbital Hamiltonian Population (WOHP)* from Wannier90 package.

Before getting into things, you might want to check out the following paper:

  1. *Population Analysis with Wannier Orbitals

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

For the script to work, you need to have an valid installation of python (2.7.x). Also, numpy package are needed, you can install them by pip:

pip install numpy

or by conda

conda install numpy

if you use a supercomputer and don't have enough privilege:

  1. install anaconda by downloading from here and upload it to your directory.
  2. using queue system to install anaconda by chmod 755 anaconda*.sh && ./anaconda*.sh
  3. install numpy by download them from here, upload them as well.
  4. manually install package by conda install numpy*.tar.bz2.

Useage

File need for calculation:

  1. wannier90_u.mat
  2. wannier90.eig
  3. wannier90_hr.dat

Detailed preparation for Wannier90 generated files can be found in Wanneir90's user guide, or in the example folder.

Make WOBSTER visiable to python by:

export PYTHONPATH=$PYTHONPATH:/path/to/this/repo

Please read input.py for more information.

Running the tests

Go check the description in example folder. This code is provided as a python package without a command line interface. To run code, simply lunch a python interpreter and:

from wobster.WOBSTER import *
from wobster.w90io import *

For detailed usage, please consult input.py.

How to cite

For the method please cite the following paper in any publications arising from the use of this code:

Sudipta Kundu,Satadeep Bhattacharjee, Seung-Cheol Lee and Manish Jain Population Analysis with Wannier Orbitals,arXiv

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

Wannier-orbital Basis Suite Towards Electronic-Structure Reconstruction

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published