unPHold
unPHold unfolds phonon band structures from a supercell calculation onto a primitive-cell Brillouin zone and characterizes each mode.
GitHub repo: sabia-group/unPHold
What unPHold does
A supercell has a smaller Brillouin zone than the primitive cell it is built from, so its phonon branches appear as folded copies of the primitive-cell dispersion. Unfolding reverses this down-folding: from a supercell phonon calculation it recovers the effective primitive-cell dispersion.
Beyond unfolding supercell phonon bands, unPHold also characterizes individual modes and visualizes their real-space displacement pattern.
Scope
- 3D and 2D supercells, moiré superlattices, defected structures
- Relaxed / deregistered structures
- Phonon mode characterization
Features
- Atom matching for defective, deregistered, and layer-resolved systems.
- Per-mode unfolding weights and unfolded band structure visualization.
- Mode-character metrics: acoustic participation ratio (APR), longitudinality (L), and out-of-plane verticality (V).
- Built on phonopy: unPHold reuses phonopy's force constants and structural metadata, so it works with any force-constant source, including DFT codes and machine-learning interatomic potentials (MLIPs).
Getting started
- Installation
- Theory: unfolding, mode-character metrics
- Tutorials: Si bulk, twisted bilayer graphene, and defect graphene monolayer