# IDAES User Interfaces (IDAES-UI)
[Repository on GitHub](https://github.com/IDAES/idaes-ui/)
[IDAES project website](https://idaes.org)
Copyright 2023 by The IDAES Project Team. See `COPYRIGHT.md` file for details.
You are free to copy, modify, and distribute IDAES-UI with attribution under the terms of the MIT license. See `LICENSE.md` file for details.
## Overview
This repository contains user interfaces for the [Institute for the Design of Advanced Energy Systems (IDAES)](https://idaes.org) Integrated Platform (IDAES-IP).
The primary user interface is the **Flowsheet Visualizer** (FV),
a web-based user interface that can visualize and explore the
properties of computational models ("flowsheets") created using the IDAES Python APIs.
## Installation
IDAES-UI is installed as part of the IDAES Integrated Platform (IDAES-IP).
Please see the README of the [IDAES-PSE repository](https://github.com/IDAES/idaes-pse) and/or the full [IDAES install instructions](https://idaes-pse.readthedocs.io/en/stable/tutorials/getting_started/index.html) for details.
In a nutshell, you want to add *[ui]* to the list of optional dependencies when you run the main IDAES installation command (*pip* or *conda*).
For example: `pip install idaes[ui]`
## More information
Please refer to the [online documentation](https://idaes-ui.readthedocs.io) for more information about the capabilities of this package.
If you have cloned this repository from [GitHub](https://github.com/IDAES/idaes-ui/), you can find the source files for the Sphinx-generated HTML documentation in the `docs` subdirectory.
Raw data
{
"_id": null,
"home_page": "",
"name": "idaes-ui",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "IDAES,energy systems,chemical engineering,process modeling",
"author": "The IDAES Project",
"author_email": "Dan Gunter <dkgunter@lbl.gov>",
"download_url": "https://files.pythonhosted.org/packages/75/db/988be346d92b8f44bc452e09e3d798123fa9356785f63d1a7f0611c6c682/idaes-ui-0.23.12.tar.gz",
"platform": null,
"description": "# IDAES User Interfaces (IDAES-UI)\n[Repository on GitHub](https://github.com/IDAES/idaes-ui/) \n[IDAES project website](https://idaes.org)\n\nCopyright 2023 by The IDAES Project Team. See `COPYRIGHT.md` file for details.\n\nYou are free to copy, modify, and distribute IDAES-UI with attribution under the terms of the MIT license. See `LICENSE.md` file for details.\n\n## Overview\n\nThis repository contains user interfaces for the [Institute for the Design of Advanced Energy Systems (IDAES)](https://idaes.org) Integrated Platform (IDAES-IP).\n\nThe primary user interface is the **Flowsheet Visualizer** (FV),\na web-based user interface that can visualize and explore the\nproperties of computational models (\"flowsheets\") created using the IDAES Python APIs.\n\n## Installation\n\nIDAES-UI is installed as part of the IDAES Integrated Platform (IDAES-IP).\nPlease see the README of the [IDAES-PSE repository](https://github.com/IDAES/idaes-pse) and/or the full [IDAES install instructions](https://idaes-pse.readthedocs.io/en/stable/tutorials/getting_started/index.html) for details. \nIn a nutshell, you want to add *[ui]* to the list of optional dependencies when you run the main IDAES installation command (*pip* or *conda*).\nFor example: `pip install idaes[ui]`\n\n## More information\n\nPlease refer to the [online documentation](https://idaes-ui.readthedocs.io) for more information about the capabilities of this package.\n\nIf you have cloned this repository from [GitHub](https://github.com/IDAES/idaes-ui/), you can find the source files for the Sphinx-generated HTML documentation in the `docs` subdirectory.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "IDAES PSE Platform UI",
"version": "0.23.12",
"project_urls": {
"github": "https://github.com/idaes/idaes-ui",
"issues": "https://github.com/idaes/idaes-ui/issues"
},
"split_keywords": [
"idaes",
"energy systems",
"chemical engineering",
"process modeling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfcb7d6f85114342be1c525f0753bb5c593ac7413221cfd58f1657c9ab01ec94",
"md5": "37088979569b31b006e29f18ddd7cd62",
"sha256": "7d72756cdcd80d88f05a4ea433b05097a2da9ce8a65aabacf3f657f3aa32c57f"
},
"downloads": -1,
"filename": "idaes_ui-0.23.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37088979569b31b006e29f18ddd7cd62",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5979826,
"upload_time": "2023-12-08T21:15:01",
"upload_time_iso_8601": "2023-12-08T21:15:01.538628Z",
"url": "https://files.pythonhosted.org/packages/bf/cb/7d6f85114342be1c525f0753bb5c593ac7413221cfd58f1657c9ab01ec94/idaes_ui-0.23.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "75db988be346d92b8f44bc452e09e3d798123fa9356785f63d1a7f0611c6c682",
"md5": "a6554b8925202a78d74b3f03aff85b09",
"sha256": "393864f42d3553bb357f2709b5a69a5906f758bea80f19a2cd7629ae828ad3c1"
},
"downloads": -1,
"filename": "idaes-ui-0.23.12.tar.gz",
"has_sig": false,
"md5_digest": "a6554b8925202a78d74b3f03aff85b09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13878095,
"upload_time": "2023-12-08T21:15:04",
"upload_time_iso_8601": "2023-12-08T21:15:04.242142Z",
"url": "https://files.pythonhosted.org/packages/75/db/988be346d92b8f44bc452e09e3d798123fa9356785f63d1a7f0611c6c682/idaes-ui-0.23.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 21:15:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "idaes",
"github_project": "idaes-ui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "idaes-ui"
}
JSON
