<!-- 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
# install the IDAES examples with a core set of dependencies
pip install idaes-examples
# install the IDAES examples with additional dependencies needed to run specific examples,
# e.g. `omlt` for surrogate modeling with OMLT
pip install "idaes-examples[omlt]"
# install the IDAES examples with dependencies need to build the documentation
pip install "idaes-examples[docs]"
```
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 serve
```
to start a Jupyter server to browser and open the notebooks for local execution and experimentation.
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 serve` 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: 25 Apr 2024
Raw data
{
"_id": null,
"home_page": null,
"name": "idaes-examples",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "IDAES, energy systems, chemical engineering, process modeling",
"author": "The IDAES Project",
"author_email": "Dan Gunter <dkgunter@lbl.gov>",
"download_url": null,
"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# install the IDAES examples with a core set of dependencies\npip install idaes-examples\n\n# install the IDAES examples with additional dependencies needed to run specific examples,\n# e.g. `omlt` for surrogate modeling with OMLT\npip install \"idaes-examples[omlt]\"\n\n# install the IDAES examples with dependencies need to build the documentation\npip install \"idaes-examples[docs]\"\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 serve\n```\nto start a Jupyter server to browser and open the notebooks for local execution and experimentation.\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 serve` command will generate the other versions, or you can run preprocessing manually with: `idaesx pre -d \"$(idaesx where)\\..\"`.\n\n## Build documentation\n\nRun the command `idaesx build` from the repository root to build the [JupyterBook](https://jupyterbook.org) \ndocumentation.\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----\nAuthor: Dan Gunter \nLast modified: 25 Apr 2024\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "IDAES Process Systems Engineering Examples",
"version": "2.6.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": "0706b83b2c51b664879eae95a3d41a8f1f38acd2d0a015da9c74db257f253010",
"md5": "9aa32027e100f7cd6b79dfc9ef0f07d7",
"sha256": "8b153cf06a2de201bb426ed740b4995745ec86ee53fca5041fd686709f3369e0"
},
"downloads": -1,
"filename": "idaes_examples-2.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9aa32027e100f7cd6b79dfc9ef0f07d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 54705467,
"upload_time": "2024-10-01T17:10:06",
"upload_time_iso_8601": "2024-10-01T17:10:06.449226Z",
"url": "https://files.pythonhosted.org/packages/07/06/b83b2c51b664879eae95a3d41a8f1f38acd2d0a015da9c74db257f253010/idaes_examples-2.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 17:10:06",
"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
