Metadata-Version: 2.1
Name: sisl-gui
Version: 0.3.1
Summary: Graphical interface for the sisl visualization module
Home-page: http://github.com/pfebrer/sisl-gui
Author: Pol Febrer
Author-email: pfebrer96@gmail.com
License: MIT
Description: This is the graphical interface that you can use to interact with [sisl's](https://github.com/zerothi/sisl) visualization module.
        
        It consists of two parts:
        - [Back-end](sisl_gui): 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](frontend): A javascript/typescript UI, which is developed using [React](https://reactjs.org/). The build is
        shipped with the python package and 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 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 https://pfebrer.github.io/sisl-gui/.
        
        ### From a terminal
        
        You can use the `sisl-gui` command.
        
        ### From python
        
        ```python
        import sisl_gui
        
        app = sisl_gui.launch()
        ```
        
        # 
Platform: UNKNOWN
Description-Content-Type: text/markdown
