Reorganize unit model notebooks, minor CSTR updates (#80)

* Reorganize unit model notebooks, minor CSTR updates * Added scaling to fix HC Processing timeout error * New initialization file * Minor fixes to index files
IDAES · Dec 23, 2021 · 0a28cdb · 0a28cdb
1 parent 219988e
commit 0a28cdb
Show file tree

Hide file tree

Showing 27 changed files with 367 additions and 271 deletions.
diff --git a/README-developer.md b/README-developer.md
@@ -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.
 
 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 

diff --git a/build-ci.yml b/build-ci.yml
@@ -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

diff --git a/build.yml b/build.yml
@@ -42,7 +42,7 @@ notebook:
 #      - source: Examples/SurrMod/RIPE
 #        match: "RIPE_.*"
       - source: Examples/Tools
-      - source: Examples/UnitModels
+      - source: Examples/UnitModels/Operations
       - source: Examples/UnitModels/Reactors
       - source: Examples/Pecos
       - source: Tutorials/Advanced/ParamEst

diff --git a/docs/Examples/UnitModels/compressor_2.svg → ...es/UnitModels/Operations/compressor_2.svg b/docs/Examples/UnitModels/compressor_2.svg → ...es/UnitModels/Operations/compressor_2.svg
diff --git a/docs/Examples/UnitModels/expander_2.svg → ...ples/UnitModels/Operations/expander_2.svg b/docs/Examples/UnitModels/expander_2.svg → ...ples/UnitModels/Operations/expander_2.svg
diff --git a/docs/Examples/UnitModels/heater_2.svg → ...amples/UnitModels/Operations/heater_2.svg b/docs/Examples/UnitModels/heater_2.svg → ...amples/UnitModels/Operations/heater_2.svg
diff --git a/docs/Examples/UnitModels/Operations/index.rst b/docs/Examples/UnitModels/Operations/index.rst
@@ -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>
diff --git a/docs/Examples/UnitModels/mixer.svg → .../Examples/UnitModels/Operations/mixer.svg b/docs/Examples/UnitModels/mixer.svg → .../Examples/UnitModels/Operations/mixer.svg
diff --git a/docs/Examples/UnitModels/pump.svg → docs/Examples/UnitModels/Operations/pump.svg b/docs/Examples/UnitModels/pump.svg → docs/Examples/UnitModels/Operations/pump.svg
diff --git a/docs/Examples/UnitModels/index.rst b/docs/Examples/UnitModels/index.rst
@@ -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
diff --git a/notebook_index.yml b/notebook_index.yml
@@ -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

diff --git a/src/Examples/Advanced/CustomProperties/HI_init.json.gz b/src/Examples/Advanced/CustomProperties/HI_init.json.gz
diff --git a/src/Examples/Advanced/CustomProperties/Hydrocarbon_Processing_example.ipynb b/src/Examples/Advanced/CustomProperties/Hydrocarbon_Processing_example.ipynb
diff --git a/src/Examples/UnitModels/compressor_2.svg → ...es/UnitModels/Operations/compressor_2.svg b/src/Examples/UnitModels/compressor_2.svg → ...es/UnitModels/Operations/compressor_2.svg
diff --git a/...mples/UnitModels/compressor_testing.ipynb → ...odels/Operations/compressor_testing.ipynb b/...mples/UnitModels/compressor_testing.ipynb → ...odels/Operations/compressor_testing.ipynb
diff --git a/src/Examples/UnitModels/expander_2.svg → ...ples/UnitModels/Operations/expander_2.svg b/src/Examples/UnitModels/expander_2.svg → ...ples/UnitModels/Operations/expander_2.svg
diff --git a/...nitModels/heat_exchanger_0D_testing.ipynb → ...perations/heat_exchanger_0D_testing.ipynb b/...nitModels/heat_exchanger_0D_testing.ipynb → ...perations/heat_exchanger_0D_testing.ipynb
diff --git a/src/Examples/UnitModels/heat_exchanger_4.svg → ...nitModels/Operations/heat_exchanger_4.svg b/src/Examples/UnitModels/heat_exchanger_4.svg → ...nitModels/Operations/heat_exchanger_4.svg
diff --git a/src/Examples/UnitModels/heater_2.svg → ...amples/UnitModels/Operations/heater_2.svg b/src/Examples/UnitModels/heater_2.svg → ...amples/UnitModels/Operations/heater_2.svg
diff --git a/src/Examples/UnitModels/heater_testing.ipynb → ...nitModels/Operations/heater_testing.ipynb b/src/Examples/UnitModels/heater_testing.ipynb → ...nitModels/Operations/heater_testing.ipynb
diff --git a/src/Examples/UnitModels/mixer.svg → src/Examples/UnitModels/Operations/mixer.svg b/src/Examples/UnitModels/mixer.svg → src/Examples/UnitModels/Operations/mixer.svg
diff --git a/src/Examples/UnitModels/mixer_testing.ipynb → ...UnitModels/Operations/mixer_testing.ipynb b/src/Examples/UnitModels/mixer_testing.ipynb → ...UnitModels/Operations/mixer_testing.ipynb
diff --git a/src/Examples/UnitModels/pump.svg → src/Examples/UnitModels/Operations/pump.svg b/src/Examples/UnitModels/pump.svg → src/Examples/UnitModels/Operations/pump.svg
diff --git a/src/Examples/UnitModels/pump_testing.ipynb → .../UnitModels/Operations/pump_testing.ipynb b/src/Examples/UnitModels/pump_testing.ipynb → .../UnitModels/Operations/pump_testing.ipynb
diff --git a/...Examples/UnitModels/turbine_testing.ipynb → ...itModels/Operations/turbine_testing.ipynb b/...Examples/UnitModels/turbine_testing.ipynb → ...itModels/Operations/turbine_testing.ipynb
diff --git a/src/Examples/UnitModels/Reactors/cstr_testing.ipynb b/src/Examples/UnitModels/Reactors/cstr_testing.ipynb
diff --git a/src/notebook_index.ipynb b/src/notebook_index.ipynb
@@ -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",