triqs.lattice.utils.TB_from_wannier90

triqs.lattice.utils.TB_from_wannier90(seed, path='./', extend_to_spin=False, add_local=None)[source]

Read Wannier90 output and convert it to a TBLattice object.

Reads the Wannier90 real-space lattice vectors from <seed>.wout and the real-space hoppings from <seed>_hr.dat.

Parameters:

seedstr: Seedname of the Wannier90 run, i.e. the basename of the *_hr.dat file.
pathstr, default ‘./’: Path to the directory containing the Wannier90 output files.
extend_to_spinbool, default False: If True, extend the hopping Hamiltonian with a trivial spin index.
add_localnumpy.ndarray, optional: Local term of shape (Norb, Norb) to add to hopping[(0, 0, 0)].

Returns: