vibeqc.KPath¶

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

Bases: object

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

Parameters:

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

__init__(kpoints_cart, kpoints_frac, distances, labels, citation_numerics=())¶

Parameters:

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

Return type:

None

Methods

__init__(kpoints_cart, kpoints_frac, ...[, ...])

Attributes

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

kpoints_cart: ndarray¶

kpoints_frac: ndarray¶

distances: ndarray¶

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

citation_numerics: Tuple[str, ...] = ()¶

property n_points: int¶