Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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

Project Description

Test status: branch master: ; branch develop:

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.

1   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.

2   Contributors

  • Tiziano Müller (UZH, Switzerland) for the CP2K input file generator and added a number of new input formats (XYZ, PDB, …)

4   License

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

5   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 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

This version
History Node

1.8.1

History Node

1.8.0

History Node

1.7.1

History Node

1.7.0

History Node

1.6.0

History Node

1.5.0

History Node

1.4.0

History Node

1.3.0

History Node

1.2.0

History Node

1.1.1

History Node

1.1.0

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
seekpath-1.8.1-py2.py3-none-any.whl
(89.0 kB) Copy SHA256 Hash SHA256
Wheel py2.py3 Feb 12, 2018
seekpath-1.8.1.tar.gz
(49.3 kB) Copy SHA256 Hash SHA256
Source None Feb 12, 2018

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting