vibe-sketcherDocumentation

vibesketcher.document.kpath

High-symmetry k-points and band paths of the first Brillouin zone (#189).

The points, their labels and the paths are those of W. Setyawan and S. Curtarolo, “High-throughput electronic band structure calculations: Challenges and tools”, Comput. Mater. Sci. 49, 299-312 (2010), doi:10.1016/j.commatsci.2010.05.010 (arXiv:1004.2974), Appendix A: the 14 Bravais lattices in 25 variants. Fractions in the paper refer to the reciprocal vectors of its standard primitive cell, which is built here from the conventional cell with the paper’s axis orderings (a < b < c for the orthorhombic lattices, a < b for C-centred orthorhombic, the unique axis first with alpha < 90 degrees for monoclinic). For triclinic lattices the paper chooses the primitive cell whose reciprocal vectors cross the centres of the first zone’s Bragg planes; that is the Niggli-reduced reciprocal basis here (I. Krivy and B. Gruber, Acta Cryst. A32, 297 (1976), through spglib), all-acute (TRI1b) or all-obtuse (TRI1a, TRI2a when k_gamma is 90).

The lattice is classified on its own (one lattice point per cell, at the length tolerance symprec), because the labels belong to the zone that is drawn: the Wigner-Seitz cell of the stored cell’s reciprocal lattice. The result says when the crystal’s point group is lower than the lattice’s, or when the stored cell holds more than one primitive cell (the zone is then a folded one); both are reported, never corrected.

Every point is checked to lie in the first zone before it is returned, within the strain the tolerance admits (a lattice accepted at symprec may be that far from ideal), so a convention that does not fit the cell is refused, not drawn. Needs the optional symmetry extra (spglib).

The paper gives no plane lattices. A slab (two periodic directions) is labelled on the section k_perp = 0 of the zone of its prism lattice: the plane lattice stacked along its normal at a spacing longer than every reduced in-plane vector, so the stacking adds a mirror and nothing else. That prism is TET, ORC, ORCC, HEX or MCL (unique axis along the normal) for the square, rectangular, centred rectangular, hexagonal and oblique plane lattices, and its zone is the plane zone times a k_perp interval, so the in-plane points of the paper’s table are the plane zone’s points, under the paper’s labels. The ase.lattice module of ASE (A. H. Larsen et al., J. Phys.: Condens. Matter 29, 273002 (2017)) uses the same labels for its square, rectangular, hexagonal and oblique lattices. The plane path is the paper’s path restricted to the plane (TET, ORC, HEX), and for ORCC and MCL, whose restricted paths are disconnected, the closed boundary of the irreducible wedge through the same points, as drawn for all five lattices by D. Röhlig et al., Phys. Rev. B 113, 144319 (2026), doi:10.1103/9ql7-t9rh, Fig. 7 (who rename some of the points). Wires are refused.

Functions

high_symmetry_path(structure, *[, symprec])

The lattice type, special points and band path of the stored cell's first zone.

reciprocal_rows(structure)

Rows b_i (1/A) with b_i .

Exceptions

KPathRefused

This structure has no Setyawan-Curtarolo path, or it does not fit the cell.

exception vibesketcher.document.kpath.KPathRefused[source]

Bases: ValueError

This structure has no Setyawan-Curtarolo path, or it does not fit the cell.

vibesketcher.document.kpath.high_symmetry_path(structure, *, symprec=0.001)[source]

The lattice type, special points and band path of the stored cell’s first zone.

A crystal gets one of the paper’s 25 variants; a slab gets one of the five plane lattices (see the module docstring). symprec is the length tolerance (angstrom) for classifying the lattice. Read-only; needs the symmetry extra.

Parameters:
Return type:

dict[str, Any]

vibesketcher.document.kpath.reciprocal_rows(structure)[source]

Rows b_i (1/A) with b_i . a_j = 2 pi delta_ij; periodic b_i lie in the periodic span.

A non-periodic cell vector is first replaced by its component normal to the periodic vectors (the determinant is unchanged), so a vacuum vector that is tilted does not tilt a slab’s zone out of its plane.

Parameters:

structure (PeriodicStructure)

Return type:

ndarray