Skip to content

Anny-Moon/TBTK

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DOI

Welcome to the Tight Binding Toolkit - TBTK

For an introduction to the library, see http://dafer45.github.io/TBTK

###########################

Installation instructions

########################### Without CUDA (gpu)

source init_session.sh  
./install.sh

With CUDA (gpu)

source init_session.sh
./install -CUDA

#############

Update TBTK

############# After pulling the latest version of TBTK, execute the following command from the TBTK root folder to update the library:

Without CUDA (gpu)

./update.sh

With CUDA (gpu)

./update.sh -CUDA

####################

Initialize session

#################### Each time a new terminal session is opened, execute the following command from the TBTK root folder:

source init_session.sh

#########

License

######### TBTK is free to use under the Appache 2.0 license (see the file 'License'). Please give attribution in accordance with the 'Cite' section below.

Cite

####To cite TBTK, mention TBTK in the text and cite the DOI for this project.
DOI
Kristofer Björnson, & glaurung24. (2016). dafer45/TBTK: Initial release [Data set].
Zenodo. http://doi.org/10.5281/zenodo.162730

####If you use the ChebyshevSolver to produce results, please also cite the following references
A. Weiße, G. Wellein, A. Alvermann, and H. Fehske,
Rev. Mod. Phys. 78, 275 (2006).

L. Covaci, F. M. Peeters, and M. Berciu,
Phys. Rev. Lett. 105, 167006 (2010).

#####################

Additional features

##################### Due to their dependence on external libraries, certain TBTK features are not installed by default. These are intended to eventually make it into the default installation, but currently has to be configured manually to work. The current components that do not work by default, and the corresponding reasons are listed below:

Library

ArnoldiSolver

Depends on the external libraries ARPACK (http://www.caam.rice.edu/software/ARPACK/) and SuperLU (http://crd-legacy.lbl.gov/~xiaoye/SuperLU/).

Tools

TBTKImageToModel

Depends on the external library openCV (http://opencv.org/).

Visualization

TBTKVisualizer

Depends on the external library OGRE (http://www.ogre3d.org/).

Templates

TopologicalInsulator3D

Depends on the external library FFTW (http://www.fftw.org/).

If you are interested in installing one or several of these features already now, please contact the developer at kristofer.bjornson@physics.uu.se for further instructions.

About

c++ library for solving general bilinear Hamiltonians

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 91.1%
  • Cuda 3.1%
  • Makefile 1.3%
  • Python 1.3%
  • CMake 1.0%
  • Roff 0.9%
  • Other 1.3%