Skip to content

Commit 28932a2

Browse files
committed
feat: enhance README header with a logo and badges, and conditionally define the installer icon path.
1 parent fe3a3c9 commit 28932a2

2 files changed

Lines changed: 19 additions & 4 deletions

File tree

.github/workflows/build.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,11 @@ jobs:
144144
RequestExecutionLevel admin
145145
146146
!define MUI_ABORTWARNING
147-
!define MUI_ICON "dist\TBSOC\_internal\icon.ico"
147+
148+
; Try to use icon if it exists, otherwise skip
149+
!if /FileExists "resources\icon.ico"
150+
!define MUI_ICON "resources\icon.ico"
151+
!endif
148152
149153
!insertmacro MUI_PAGE_WELCOME
150154
!insertmacro MUI_PAGE_LICENSE "LICENSE"

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1-
# TBSOC (Wannier + On-site SOC)
1+
<div align="center">
2+
<img src="tbsoc_logo.png" alt="TBSOC Logo" width="100"/>
3+
4+
# TBSOC (Wannier + On-site SOC)
5+
6+
**A lightweight, high-performance Python package for adding On-Site Spin-Orbit Coupling to Wannier90 Tight-Binding models**
7+
8+
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
9+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
10+
[![JAX](https://img.shields.io/badge/powered%20by-JAX-orange.svg)](https://github.com/google/jax)
11+
12+
</div>
213

3-
**TBSOC** is a lightweight, high-performance Python package designed to add On-Site Spin-Orbit Coupling (SOC) to Wannier90 Tight-Binding (TB) models. It allows users to estimate accurate SOC strengths ($\lambda$) by automatically fitting TB band structures to DFT calculations.
14+
---
415

5-
## Key Features
16+
## Key Features
617
- **High Performance**: Powered by **JAX** and **Just-In-Time (JIT)** compilation for lightning-fast fitting (<1s for typical systems).
718
- **Auto-Alignment**: Automatically detects the correct matching between TB and DFT bands, including partial band overlap when DFT has fewer bands than TB.
819
- **Physically-Aware**: Uses **Gaussian-weighted loss** centered at the Fermi level to prioritize accuracy near the Fermi surface.

0 commit comments

Comments
 (0)