<!-- Badges -->
[](https://mybinder.org/v2/gh/lbianchi-lbl/examples/binder?labpath=idaes_examples%2Fnotebooks%2Fdocs)
[](https://github.com/IDAES/examples/actions/workflows/core.yml)
[](https://idaes-examples.readthedocs.io/en/latest/?badge=latest)
# IDAES Examples
This repository contains example Jupyter Notebooks that demonstrate and explain
the capabilities of the IDAES platform.
Below are basic instructions to install, view, and run the examples.
**For Developers**: If you are a developer who wishes to modify or add new notebooks, please refer to the file *README-developer.md*.
**Categories of examples**
In the source code repository, you may note that there are a number of examples that are not in the documentation.
There are two main categories of examples:
- "Docs" examples (under `idaes_examples/notebooks/docs`), which are tested and built into this documentation.
- "Active" examples (under `idaes_examples/notebooks/active`) that are tested but *not* in the documentation.
There is also a third category of "Held" examples (under `idaes_examples/notebooks/held`),
which could in the next release of IDAES in Docs or Active, or could be removed.
These are *not* tested and *not* in the docs, and should generally be ignored by non-developers.
## Installation
This repository can be installed with *pip*:
```shell
# RECOMMENDED: this will install the IDEAS examples, accessory code,
# plus the Graphical User Interface (GUI) to browse them (see section below)
pip install "idaes-examples[gui]"
```
We recommend you use a virtual environment tool such as
[Miniconda](https://docs.conda.io/en/latest/miniconda.html)
to install and run the notebooks in an isolated environment.
## Run examples
Use the command
```
idaesx gui
```
to get a simple graphical UI that lets you
browse and open notebooks (with Jupyter) for local execution and experimentation.
The GUI will show the description of each notebook and allow selection of tutorial or exercise versions of the notebook, if these exist.
Alternately, you may use Jupyter notebook's file browser in the installed notebooks directory,
using the `idaesx where` command to find that directory:
`jupyter notebook $(idaesx where)`.
Only the source notebooks (ending in '_src.ipynb') are included in the repository.
The `idaesx gui` command will generate the other versions, or you can run preprocessing manually with: `idaesx pre -d "$(idaesx where)\.."`.
## Build documentation
Run the command `idaesx build` from the repository root to build the [JupyterBook](https://jupyterbook.org)
documentation.
*Note: This will take quite a while, as each example must be run first.
You may want to step out and enjoy a beverage.*
----
Author: Dan Gunter
Last modified: 17 Feb 2023
Raw data
{
"_id": null,
"home_page": "",
"name": "idaes-examples",
"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": "",
"platform": null,
"description": "<!-- Badges -->\n[](https://mybinder.org/v2/gh/lbianchi-lbl/examples/binder?labpath=idaes_examples%2Fnotebooks%2Fdocs)\n[](https://github.com/IDAES/examples/actions/workflows/core.yml)\n \n[](https://idaes-examples.readthedocs.io/en/latest/?badge=latest)\n\n# IDAES Examples\n\nThis repository contains example Jupyter Notebooks that demonstrate and explain \nthe capabilities of the IDAES platform.\n\nBelow are basic instructions to install, view, and run the examples.\n\n**For Developers**: If you are a developer who wishes to modify or add new notebooks, please refer to the file *README-developer.md*.\n\n**Categories of examples**\n\nIn the source code repository, you may note that there are a number of examples that are not in the documentation.\nThere are two main categories of examples:\n\n - \"Docs\" examples (under `idaes_examples/notebooks/docs`), which are tested and built into this documentation.\n - \"Active\" examples (under `idaes_examples/notebooks/active`) that are tested but *not* in the documentation.\n\nThere is also a third category of \"Held\" examples (under `idaes_examples/notebooks/held`),\nwhich could in the next release of IDAES in Docs or Active, or could be removed.\nThese are *not* tested and *not* in the docs, and should generally be ignored by non-developers.\n\n## Installation\n\nThis repository can be installed with *pip*:\n\n```shell\n# RECOMMENDED: this will install the IDEAS examples, accessory code,\n# plus the Graphical User Interface (GUI) to browse them (see section below)\npip install \"idaes-examples[gui]\"\n```\n\nWe recommend you use a virtual environment tool such as\n[Miniconda](https://docs.conda.io/en/latest/miniconda.html)\nto install and run the notebooks in an isolated environment.\n\n## Run examples\n\nUse the command \n```\nidaesx gui\n```\nto get a simple graphical UI that lets you \nbrowse and open notebooks (with Jupyter) for local execution and experimentation.\nThe GUI will show the description of each notebook and allow selection of tutorial or exercise versions of the notebook, if these exist.\n\nAlternately, you may use Jupyter notebook's file browser in the installed notebooks directory,\nusing the `idaesx where` command to find that directory:\n`jupyter notebook $(idaesx where)`.\n\nOnly the source notebooks (ending in '_src.ipynb') are included in the repository.\nThe `idaesx gui` command will generate the other versions, or you can run preprocessing manually with: `idaesx pre -d \"$(idaesx where)\\..\"`.\n\n\n## Build documentation\n\nRun the command `idaesx build` from the repository root to build the [JupyterBook](https://jupyterbook.org) \ndocumentation.\n\n\n*Note: This will take quite a while, as each example must be run first.\nYou may want to step out and enjoy a beverage.*\n\n\n----\nAuthor: Dan Gunter \nLast modified: 17 Feb 2023\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "IDAES Process Systems Engineering Examples",
"version": "2.4.0",
"project_urls": {
"github": "https://github.com/idaes/examples",
"issues": "https://github.com/idaes/examples/issues"
},
"split_keywords": [
"idaes",
"energy systems",
"chemical engineering",
"process modeling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "889f14997b9368ed627958a10397aadf4660b6832bd3ddfb092a95fbec7fc37a",
"md5": "317b2fc9fe01c11823fc8a68492edf1d",
"sha256": "5f659c25112effdc6beff0fd9229b41e65304c7322ad79faddef1e2f55033ef5"
},
"downloads": -1,
"filename": "idaes_examples-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "317b2fc9fe01c11823fc8a68492edf1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 56009564,
"upload_time": "2024-03-01T07:24:11",
"upload_time_iso_8601": "2024-03-01T07:24:11.660819Z",
"url": "https://files.pythonhosted.org/packages/88/9f/14997b9368ed627958a10397aadf4660b6832bd3ddfb092a95fbec7fc37a/idaes_examples-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 07:24:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "idaes",
"github_project": "examples",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "idaes-examples"
}
JSON
