vibeqc.KPath¶

class vibeqc.KPath(kpoints_cart, kpoints_frac, distances, labels)[source]¶

Bases: object

A discretised k-path — sequence of k-points with cumulative arc length (for the x-axis when plotting) and labelled high-symmetry points (for the x-axis tick marks).

Parameters:

kpoints_cart (ndarray)
kpoints_frac (ndarray)
distances (ndarray)
labels (List[Tuple[float, str]])

__init__(kpoints_cart, kpoints_frac, distances, labels)¶

Parameters:

kpoints_cart (ndarray)
kpoints_frac (ndarray)
distances (ndarray)
labels (List[Tuple[float, str]])

Return type:

None

Methods

__init__(kpoints_cart, kpoints_frac, ...)

Attributes

`n_points`
`kpoints_cart`
`kpoints_frac`
`distances`
`labels`

kpoints_cart: ndarray¶

kpoints_frac: ndarray¶

distances: ndarray¶

labels: List[Tuple[float, str]]¶

property n_points: int¶