giovannipizzi/seekpath repository overview

⁠Important note on the docker images

NOTE!! From seekpath v2.0, the web tool has been moved to tools-seekpath, available here: https://github.com/materialscloud-org/tools-seekpath⁠

The corresponding docker image on docker hub is here: https://hub.docker.com/repository/docker/materialscloud/tools-seekpath⁠

Therefore, this docker hub image is frozen and only contains versions < 2, for people who are still referring to these, but will not be updated anymore.

⁠Seekpath readme

######### SeeK-path #########

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.

.. contents::

.. section-numbering::

⁠=========== 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_).

⁠============ Contributors

• Tiziano Müller (UZH, Switzerland) for the CP2K input file generator and added a number of new input formats (XYZ, PDB, ...)
• Hung Pham (University of Minnesota, USA) for the CRYSTAL and VASP input file generators

⁠============================= How to install and how to use

Please visit the SeeK-path user guide is on Read the docs_.

⁠======= 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 Materials Cloud_ web portal.

The following is a screenshot of the selection window:

.. image:: https://raw.githubusercontent.com/giovannipizzi/seekpath/master/webservice/screenshots/selector.png⁠ :alt: SeeK-path web service selection window :width: 50% :align: center

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.

.. image:: https://raw.githubusercontent.com/giovannipizzi/seekpath/master/webservice/screenshots/mainwindow.png⁠ :alt: SeeK-path web service main output :width: 50% :align: center

.. _HPKOT paper: http://dx.doi.org/10.1016/j.commatsci.2016.10.015⁠ .. _JOURNAL LINK: http://dx.doi.org/10.1016/j.commatsci.2016.10.015⁠ .. _arXiv link: https://arxiv.org/abs/1602.06402⁠ .. _spglib: http://atztogo.github.io/spglib/⁠ .. _Materials Cloud: http://www.materialscloud.org/tools/seekpath/⁠ .. _docker hub: https://hub.docker.com/r/giovannipizzi/seekpath/⁠ .. _user guide is on Read the docs: http://seekpath.readthedocs.io⁠ .. _spglib arXiv link: https://arxiv.org/abs/1808.01590⁠