Skip to main content

Graphical interface for the sisl visualization module

Project description

This is the graphical interface that you can use to interact with sisl's visualization module.

It consists of two parts:

  • Back-end: The backend is implemented in python. The most important part is the Session class which stores and manages the app state. The Session can be connected to the frontend either using pyodide (it runs directly on the browser) or through sockets (implemented with flask and flask-socketio).
  • Front-end: A javascript/typescript UI, which is developed using React. The build is shipped with the python package and also available at

User guide


It is extremely simple to install sisl-gui with pip:

pip install sisl-gui


From the browser

This is the simplest way, since it doesn't have any requirements. You don't even need to install it as mentioned in the previous section, just go to

From a terminal

You can use the sisl-gui command.

From python

import sisl_gui

app = sisl_gui.launch()

Project details

Download files

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

Source Distribution

sisl-gui-0.4.1.tar.gz (6.3 MB view hashes)

Uploaded Source

Built Distribution

sisl_gui-0.4.1-py3-none-any.whl (6.4 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page