Skip to main content

                    Python Build Status Dependencies GitHub Issues Contributions welcome License

Scientific Python package for solving Slater Koster tight-binding hamiltonian. A python package in development for creating and solving slater koster tight-binding hamiltonians for various 1D 2D and 3D systems from topological insulators to strong correlations.

Documentation

Documentation can be found at https://pysktb.readthedocs.io

Features

  • Generate s,p,d interactions in any given lattice
  • Total energy for insulators and semimetals
  • Specify range of interaction with more then Nearest neibghor
  • Spin Polarized calculations
  • Spin orbit coupling (only for p orbitals as of now)
  • Plot orbital weighted colorplots
  • Integration with pymatgen structres
  • JIT optimized with numba
  • Parallelization on kpoints

Installation

pip install pysktb

Examples

Example usage shown in examples.ipynb

  1. 1D chain of sp (example of 1D topological Crystiline insulator SSH)
  • with orbital projection on s
  • DOS
  1. Graphene and band colorplot in BZ
  1. Intrinsic Spin-Orbit-Coupling Rashba effect in Halide Perovskites
  1. Buckled antimony Sb

  2. Low buckled Sb Surface states with SOC - Topological Crystalline Insulator

Optimized

  • with jit
- Parallelized over k

Features to be added

  • Complete pymatgen integration (high on priority)
  • Berry phase calculation (high on priority) already implemented need to interface
  • Parallelization on kpoints and orbitals.
  • scipy sparse matrix optimized
  • Spin Orbit Coupling for d,f
  • Bogoliubov-de-Gennes (BdG) solutions for the given system for Superconductivity
  • Interface with ASE structures
  • Create finite structures and slabs for Topological calculations within the code (requires pymatgen right now)
  • Greens function DOS
  • Convert all operations to sympy, so that one can output analytical Tightbinding matrix elements for ease of access
  • Low energy k.p hamiltonian from sympy

Citation

If you are using the code, please consider citing it with the followig bib DOI

@misc{https://doi.org/10.5281/zenodo.4311595,
  doi = {10.5281/ZENODO.4311595},
  url = {https://zenodo.org/record/4311595},
  author = {Radha,  Santosh Kumar},
  title = {santoshkumarradha/pysktb: Tightbinding Electronic structure codes},
  publisher = {Zenodo},
  year = {2020},
  copyright = {Open Access}
}

License

MIT

Metadata

Release files for pysktb 0.5.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysktb 0.5.6
File Size Uploaded
pysktb-0.5.6.tar.gz 19.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pysktb 0.5.6
File Interpreter ABI Platform
pysktb-0.5.6-py3-none-any.whl Python 3 none any Details

Total release size: 39.2 kB

Release files / pysktb-0.5.6.tar.gz

Download URL pysktb-0.5.6.tar.gz
Size 19.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7ee9e0df637df93a294046b645415f35903c4815ff2c8ffc8fd0270dbf8add87
BLAKE2b-256 checksum
How to use checksums
d3767e6c250d09f9851ac4a380b744f9d144b748ebadebd754cb52916eafa018
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.1

Release files / pysktb-0.5.6-py3-none-any.whl

Download URL pysktb-0.5.6-py3-none-any.whl
Size 19.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0669ba09ae5b309c0bfe38e81dd0a74fbcf39fd76200a975020b58640dab8adf
BLAKE2b-256 checksum
How to use checksums
28ce51b60f55784ff1b2da0ea71081965b90b6828b6fdd2f5ae9e5a7a570b01e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.1

Release history Release notifications | RSS feed

This release

0.5.6 This release

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page