legume.Lattice.bz_path

Lattice.bz_path(pts, ns)

Make a path in the Brillouin zone.

Parameters:

• pts (list) – A list of points. Each element can be either a 2-element array defining (kx, ky), or one of {‘G’, ‘K’, ‘M’} for a ‘hexagonal’ Lattice type, or one of {‘G’, ‘X’, ‘M’} for a ‘square’ Lattice type.
• ns (int or list) – A list of length either 1 or len(pts) - 1, specifying how many points are to be added between each two pts.

Returns:

path – A dictionary with the ‘kpoints’, ‘labels’, and the ‘indexes’ corresponding to the labels.

Return type:

dict