Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Reorganize unit model notebooks, minor CSTR updates #80

Merged
merged 4 commits into from
Dec 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ in the appropriate folder under `src/` with that name. For example, if you are a
that are being added under that subfolder. For each notebook, add an entry with the name of the notebook,
exactly matching the filename, a colon, and the description. Use existing entries as a template.

6. If you added a subfolder, add this to the `build.yml` file, so the build process will see it. Otherwise,
you should not need to do anything with this file.
6. If you added a subfolder, add this to the `build.yml` file, so the build process will see it. To update the CI
jobs, add this to the `build-ci.yml` file as well so the build process will see it during integration testing.
Otherwise, you should not need to do anything with this file.
Comment on lines +44 to +46
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!


7. Add the notebook to the documentation section. This means that you need to add a line in a file called `index.rst`
in a directory under `docs/` matching the directory for the notebook under `src`. So, for the
Expand Down
3 changes: 2 additions & 1 deletion build-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ notebook:
- source: Examples/SurrMod/Helmet
- source: Examples/SurrMod/PySMO
- source: Examples/Tools
- source: Examples/UnitModels
- source: Examples/UnitModels/Operations
- source: Examples/UnitModels/Reactors
- source: Examples/Pecos
- source: Tutorials/Advanced/ParamEst
- source: Tutorials/Basics
Expand Down
2 changes: 1 addition & 1 deletion build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ notebook:
# - source: Examples/SurrMod/RIPE
# match: "RIPE_.*"
- source: Examples/Tools
- source: Examples/UnitModels
- source: Examples/UnitModels/Operations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has this been updated in build-ci.yml as well? If not, it should.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has not. I would recommend we update the developer guide https://github.com/IDAES/examples-pse/blob/main/README-developer.md to make updating both build files more clear.

- source: Examples/UnitModels/Reactors
- source: Examples/Pecos
- source: Tutorials/Advanced/ParamEst
Expand Down
9 changes: 9 additions & 0 deletions docs/Examples/UnitModels/Operations/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Operations
===========
Descriptive examples showing how to use some common IDAES unit models.

.. toctree::
Compressor <compressor_doc>
Heater <heater_doc>
Mixer <mixer_doc>
Pump <pump_doc>
6 changes: 2 additions & 4 deletions docs/Examples/UnitModels/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,5 @@ Unit models
Descriptive examples showing how to use some common IDAES unit models.

.. toctree::
Compressor <compressor_doc>
Heater <heater_doc>
Mixer <mixer_doc>
Pump <pump_doc>
Operations/index
Reactors/index
20 changes: 12 additions & 8 deletions notebook_index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,20 +101,24 @@ contents:
title: "Unit Models"
description: Unit model examples
subfolders:
-
name: Operations
title: "Operations"
description: Detailed examples on importing and implementing IDAES unit models in flowsheets
notebooks:
- compressor: "Compressor Unit Model with Span-Wagner Property Package for supercritical CO2"
- heater: >
Heat a liquid mixture of benzene-toluene using a simple heater unit model and
an ideal property package
- mixer: Mixer unit model with ideal property package
- pump: Pump unit model with iapws property package
- heat exchanger 0D: Heat Exchanger 0D unit model heating a benzene-toluene mixture using steam
-
name: Reactors
title: "Reactors"
description: Detailed examples on importing and implementing IDAES reactor models in flowsheets
notebooks:
- cstr: CSTR unit model with ideal property package, pure liquid phase and rate-kinetics reaction
notebooks:
- compressor: "Compressor Unit Model with Span-Wagner Property Package for supercritical CO2"
- heater: >
Heat a liquid mixture of benzene-toluene using a simple heater unit model and
an ideal property package
- mixer: Mixer unit model with ideal property package
- pump: Pump unit model with iapws property package
- heat exchanger 0D: Heat Exchanger 0D unit model heating a benzene-toluene mixture using steam
-
name: Tools
title: Tools for working with IDAES
Expand Down
Binary file modified src/Examples/Advanced/CustomProperties/HI_init.json.gz
Binary file not shown.

Large diffs are not rendered by default.

175 changes: 84 additions & 91 deletions src/Examples/UnitModels/Reactors/cstr_testing.ipynb

Large diffs are not rendered by default.

17 changes: 11 additions & 6 deletions src/notebook_index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,22 @@
"### Unit Models\n",
"Unit model examples\n",
"\n",
"<a id='examples.unitmodels.operations'></a>\n",
"\n",
"#### Operations\n",
"Detailed examples on importing and implementing IDAES unit models in flowsheets\n",
" * [compressor](Examples/UnitModels/Operations/compressor.ipynb) - Compressor Unit Model with Span-Wagner Property Package for supercritical CO2\n",
" * [heater](Examples/UnitModels/Operations/heater.ipynb) - Heat a liquid mixture of benzene-toluene using a simple heater unit model and an ideal property package\n",
"\n",
" * [mixer](Examples/UnitModels/Operations/mixer.ipynb) - Mixer unit model with ideal property package\n",
" * [pump](Examples/UnitModels/Operations/pump.ipynb) - Pump unit model with iapws property package\n",
" * [heat exchanger 0D](Examples/UnitModels/Operations/heat%20exchanger%200D.ipynb) - Heat Exchanger 0D unit model heating a benzene-toluene mixture using steam\n",
"\n",
"<a id='examples.unitmodels.reactors'></a>\n",
"\n",
"#### Reactors\n",
"Detailed examples on importing and implementing IDAES reactor models in flowsheets\n",
" * [cstr](Examples/UnitModels/Reactors/cstr.ipynb) - CSTR unit model with ideal property package, pure liquid phase and rate-kinetics reaction\n",
" * [compressor](Examples/UnitModels/compressor.ipynb) - Compressor Unit Model with Span-Wagner Property Package for supercritical CO2\n",
" * [heater](Examples/UnitModels/heater.ipynb) - Heat a liquid mixture of benzene-toluene using a simple heater unit model and an ideal property package\n",
"\n",
" * [mixer](Examples/UnitModels/mixer.ipynb) - Mixer unit model with ideal property package\n",
" * [pump](Examples/UnitModels/pump.ipynb) - Pump unit model with iapws property package\n",
" * [heat exchanger 0D](Examples/UnitModels/heat%20exchanger%200D.ipynb) - Heat Exchanger 0D unit model heating a benzene-toluene mixture using steam\n",
"\n",
"<a id='examples.tools'></a>\n",
"\n",
Expand Down