SeeK-path
Test status for default branch:
SeeK-path is a python module to obtain 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.
Contents
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, 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).
How to install and how to use
Please check the SeeK-path user guide on ReadTheDocs.
Acknowledgements
The SeeK-path package was mainly developed by Giovanni Pizzi and is now maintained by Timo Reents.
Further Acknowledgements:
- Jae-Mo Lihm: k-point paths for the original unit cell (i.e., the one provided in input by the user) without standardization or symmetrization
License
The code is open-source (licensed with a MIT license, see LICENSE.txt).
Online service/tool
In the tools-seekpath repository we also provide the code to deploy an online service for the visualization of the band paths and primitive cells of the crystal structures. A live version is 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 files for seekpath 2.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| seekpath-2.2.2.tar.gz | 44.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| seekpath-2.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 123.5 kB
Release files / seekpath-2.2.2.tar.gz
| Download URL | seekpath-2.2.2.tar.gz |
|---|---|
| Size | 44.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3bb08b7fb21d5cff5fc27aff9904a865da5e0648fc0f8fef699642d88e27f2b
|
|
BLAKE2b-256 checksum How to use checksums |
8f7f19a5fdbf0dac0d2560458a66240f988096a55525c3fe9d8cd228a423318e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.2
|
Release files / seekpath-2.2.2-py3-none-any.whl
| Download URL | seekpath-2.2.2-py3-none-any.whl |
|---|---|
| Size | 78.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
701fa16528b56b5bcd2f4a5274295a7a9288a238a1e06b9380afb49e3ebd41f4
|
|
BLAKE2b-256 checksum How to use checksums |
ab837ff497c62ce4eb1e7356df12499c201e7cead5213529ba95ce128ba7c453
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.2
|
