A module to obtain and visualize k-vector coefficients and obtain band paths in the Brillouin zone of crystal structures
SeeK-path is a python 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.
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, Comp. Mat. Sci. 128, 140 (2017) (JOURNAL LINK, arXiv link).
- You should also cite spglib that is an essential library used in the implementation: A. Togo, I. Tanaka, “Spglib: a software library for crystal symmetry search”, arXiv:1808.01590 (2018) (spglib arXiv link).
- Tiziano Müller (UZH, Switzerland) for the CP2K input file generator and added a number of new input formats (XYZ, PDB, …)
The code is open-source (licensed with a MIT license, see LICENSE.txt).
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 Materials Cloud web portal.
The following is a screenshot of the selection window:
And the following is a screenshot of the main output window, showing the Brillouin zone, the primitive crystal structure, the coordinates of the k-points and the suggested band path.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size seekpath-1.9.3-py2.py3-none-any.whl (89.4 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View hashes|
|Filename, size seekpath-1.9.3.tar.gz (51.6 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for seekpath-1.9.3-py2.py3-none-any.whl