seekpath 1.0.0

A module to obtain and visualize k-vector coefficients and obtain band paths in the Brillouin zone of crystal structures

SeeK-path is a module to obtain and visualize band paths in the Brillouin zone of crystal structures.

The definition of k-point labels follows crystallographic convention, as defined and discussed in the HPKOT paper. Moreover, the Bravais lattice is detected properly using the spacegroup symmetry. Also the suggested band path provided in the HPKOT paper is returned. Systems without time-reversal and inversion-symmetry are also properly taken into account.

How to cite

If you use this tool, please cite the following work:

• Y. Hinuma, G. Pizzi, Y. Kumagai, F. Oba, I. Tanaka, Band structure diagram paths based on crystallography, arXiv:1602.06402 (2016) (JOURNAL LINK).

• You should also cite spglib that is an essential library used in the implementation.

How to install

To install, use pip install seekpath.

License

The code is open-source (licensed with a MIT license, see LICENSE.txt).

Online service/tool

In this repository we also provide the code to deploy a online service for the visualization of the band paths and primitive cells of the crystal structures. A live demo is currently hosted on the MaterialsCloud web portal.