.. title:: Tight-Binding Package for Large-scale Simulation
.. meta::
   :description: TBPLaS is a package for setting up and solving tight-binding models with emphasis
                 on large systems.                                                                                                                       


.. figure:: logo.png
    :alt: logo
    :align: center
    :scale: 25%

Welcome to the homepage of TBPLaS (**T**\ ight-**B**\ inding **P**\ ackage for **La**\ rge-scale
**S**\ imulation) !

As indicated by its name, TBPLaS is a package for setting up and solving tight-binding models, with
emphasis on handling large systems. It implements the tight-binding propagation method (TBPM) and
achieves linear scaling in CPU time and RAM costs with respect to the model size. The highly efficient
C++ core, hybrid OpenMP+MPI parallelization and GPU acceleration makes solving extra-large models with
billions of orbitals on computers with moderate hardware possible. Exact diagonalization, Green's function
and kernel polynomial methods are also implemented. The user API is designed following the object-oriented
paradigm and provides both Python and C++ implementations, offering both user friendliness and efficiency.

See :ref:`features` for a summary of the features, or have look at the :ref:`gallery` for demonstrations.
If you are interested, you can :doc:`install` it and start learning following the :doc:`tutorial/index`.

.. toctree::
    :maxdepth: 2
    :caption: Contents

    About <about/index.rst>
    Install <install.rst>
    Tutorials <tutorial/index.rst>
    API Reference <api.rst>
    Release Notes <release.rst>
    Contact <contact.rst>
    Developers <developers.rst>
    Publications <publication.rst>

* :ref:`genindex`