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: A Session class, which stores and manipulates the state of the application. This app can then be connected to the frontend in multiple ways. Currently, it is possible to use the Session directly in the browser (thanks to pyodide) or connect it to the frontend via sockets (implemented as a flask app that uses flask-socketio).
  • Front-end: A javascript/typescript UI, which is developed using React. The build is shipped with the python module and it is also available at https://pfebrer.github.io/sisl-gui/.

User guide

Installation

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

pip install sisl-gui

Usage

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.3.0.tar.gz (5.6 MB view hashes)

Uploaded Source

Built Distribution

sisl_gui-0.3.0-py3-none-any.whl (5.6 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