sisl-gui

Name	sisl-gui JSON
Version	0.4.1 JSON
	download
home_page	http://github.com/pfebrer/sisl-gui
Summary	Graphical interface for the sisl visualization module
upload_time	2024-04-04 09:39:49
maintainer	None
docs_url	None
author	Pol Febrer
requires_python	None
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            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()
```

# 


            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/pfebrer/sisl-gui",
    "name": "sisl-gui",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Pol Febrer",
    "author_email": "pfebrer96@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/18/4d/4b91e1cf65ca6e6a03e0eeed44a9c92089f2da67ed80b9f00b60121acd8c/sisl-gui-0.4.1.tar.gz",
    "platform": null,
    "description": "This is the graphical interface that you can use to interact with [sisl's](https://github.com/zerothi/sisl) visualization module.\n\nIt consists of two parts:\n- [Back-end](sisl_gui): The backend is implemented in python. The most important part is the `Session` class which stores\nand manages the app state. The `Session` can be connected to the frontend either using pyodide (it runs directly on the browser)\nor through sockets (implemented with `flask` and `flask-socketio`).\n- [Front-end](frontend): A javascript/typescript UI, which is developed using [React](https://reactjs.org/). The build is\nshipped with the python package and also available at https://pfebrer.github.io/sisl-gui/.\n\n# User guide\n\n## Installation\n\nIt is extremely simple to install `sisl-gui` with `pip`:\n\n```\npip install sisl-gui\n```\n\n## Usage\n\n### From the browser\n\nThis is the simplest way, since it doesn't have any requirements. **You don't even need to install it** as mentioned\nin the previous section, just go to https://pfebrer.github.io/sisl-gui/.\n\n### From a terminal\n\nYou can use the `sisl-gui` command.\n\n### From python\n\n```python\nimport sisl_gui\n\napp = sisl_gui.launch()\n```\n\n# \n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Graphical interface for the sisl visualization module",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "http://github.com/pfebrer/sisl-gui"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b30c8194d94e179350aa448803a3c8c79576d816498cf242beacba8f1302608",
                "md5": "8825b4fdd69095c66cf0602b70170478",
                "sha256": "7998a7cccb6308fcabecf903843ca46535794db28fc92c039f9e8072a25bc099"
            },
            "downloads": -1,
            "filename": "sisl_gui-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8825b4fdd69095c66cf0602b70170478",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6358249,
            "upload_time": "2024-04-04T09:39:45",
            "upload_time_iso_8601": "2024-04-04T09:39:45.456040Z",
            "url": "https://files.pythonhosted.org/packages/7b/30/c8194d94e179350aa448803a3c8c79576d816498cf242beacba8f1302608/sisl_gui-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "184d4b91e1cf65ca6e6a03e0eeed44a9c92089f2da67ed80b9f00b60121acd8c",
                "md5": "41bea1215c897ce142b33f81370092d7",
                "sha256": "41d34a5515400cb2541f40c8bc92c76d82a2bfca94b5b3fa443482e2f1fb40a8"
            },
            "downloads": -1,
            "filename": "sisl-gui-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "41bea1215c897ce142b33f81370092d7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6332558,
            "upload_time": "2024-04-04T09:39:49",
            "upload_time_iso_8601": "2024-04-04T09:39:49.907600Z",
            "url": "https://files.pythonhosted.org/packages/18/4d/4b91e1cf65ca6e6a03e0eeed44a9c92089f2da67ed80b9f00b60121acd8c/sisl-gui-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-04 09:39:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pfebrer",
    "github_project": "sisl-gui",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sisl-gui"
}