GithubHelp home page GithubHelp logo

fermiq / tools-seekpath Goto Github PK

View Code? Open in Web Editor NEW

This project forked from materialscloud-org/tools-seekpath

0.0 0.0 0.0 7.43 MB

Online web version of the seekpath tool (using the tools-barebone framework)

Home Page: http://www.materialscloud.org/tools/seekpath

License: Other

Shell 0.03% JavaScript 99.40% Python 0.20% PHP 0.04% CSS 0.04% HTML 0.28% Dockerfile 0.01%

tools-seekpath's Introduction

tools-seekpath

In this repository we provide the code to deploy an 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.

This tool leverages seekpath, 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.
  • 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

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

The following is a screenshot of the selection window:

SeeK-path web service 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.

SeeK-path web service main output

Docker images are automatically built and hosted on DockerHub under the repository materialscloud/tools-seekpath.

If you want to run locally the latest version, you can execute:

docker pull materialscloud/tools-seekpath:latest
docker run -p 8092:80 materialscloud/tools-seekpath:latest

and then connect to http://localhost:8092 with your browser.

tools-seekpath's People

Contributors

giovannipizzi avatar elsapassaro avatar ltalirz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.