Fix held tutorials by updating IDAES imports (#40)

* revise import errors * move files to doc folder * Add ipynb artifacts for tutorials * Change tutorials position in TOC to address FileNotFound error See #50 * Set missing generated data files to be ignored * Try using a Markdown header to obtain a clearer sidebar entry * Try removing ref to logo * Add updated ipynb artifacts --------- Co-authored-by: Ludovico Bianchi <[email protected]>
IDAES · Jun 2, 2023 · 1ba1370 · 1ba1370
1 parent 5843259
commit 1ba1370
Show file tree

Hide file tree

Showing 19 changed files with 20 additions and 2,128 deletions.
diff --git a/.gitignore b/.gitignore
@@ -143,7 +143,8 @@ idaes_examples/notebooks/**/pysmo/*.pickle
 idaes_examples/notebooks/**/omlt/keras_surrogate/*.pb
 idaes_examples/notebooks/**/omlt/keras_surrogate/*.pdf
 idaes_examples/notebooks/**/omlt/*.pdf
-**/alamo/alamo_run.alm
+alamo_run.alm
+idaes_examples/notebooks/docs/tut/sin_data.csv
 *.pb
 *_info.json
 variables.*

diff --git a/idaes_examples/mod/notebook_checks.py b/idaes_examples/mod/notebook_checks.py
@@ -25,13 +25,13 @@
 idaes_import_check = True
 try:
     from idaes.core import *
-    from idaes.generic_models.unit_models import (PressureChanger,
+    from idaes.models.unit_models import (PressureChanger,
                                                   CSTR,
                                                   Flash,
                                                   Heater,
                                                   Mixer,
                                                   Separator)
-    from idaes.generic_models.unit_models.pressure_changer import ThermodynamicAssumption
+    from idaes.models.unit_models.pressure_changer import ThermodynamicAssumption
 
     from idaes.core.util.model_statistics import degrees_of_freedom
 except Exception as err:

diff --git a/idaes_examples/notebooks/_toc.yml b/idaes_examples/notebooks/_toc.yml
@@ -2,15 +2,14 @@ format: jb-book
 parts:
 - caption: Tutorials
   chapters:
+  - file: docs/tut/index
+    sections:
+    - file: docs/tut/introduction_short_doc
+    - file: docs/tut/introduction_doc
   - file: docs/tut/core/index
     sections:
     - file: docs/tut/core/flash_unit_doc
     - file: docs/tut/core/hda_flowsheet_doc
-    # Moved to 'held' until their imports can be fixed
-    # - file: docs/tut/general/index
-    #   sections:
-    #   - file: docs/tut/introduction_short_doc
-    #   - file: docs/tut/introduction_doc
   - file: docs/tut/ui/index
     sections:
     - file: docs/tut/ui/visualizer_tutorial_doc

diff --git a/idaes_examples/notebooks/docs/tut/introduction_doc.ipynb b/idaes_examples/notebooks/docs/tut/introduction_doc.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_exercise.ipynb b/idaes_examples/notebooks/docs/tut/introduction_exercise.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_short_doc.ipynb b/idaes_examples/notebooks/docs/tut/introduction_short_doc.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_short_exercise.ipynb b/idaes_examples/notebooks/docs/tut/introduction_short_exercise.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_short_solution.ipynb b/idaes_examples/notebooks/docs/tut/introduction_short_solution.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_short_src.ipynb b/idaes_examples/notebooks/docs/tut/introduction_short_src.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_short_test.ipynb b/idaes_examples/notebooks/docs/tut/introduction_short_test.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_short_usr.ipynb b/idaes_examples/notebooks/docs/tut/introduction_short_usr.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_solution.ipynb b/idaes_examples/notebooks/docs/tut/introduction_solution.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_src.ipynb b/idaes_examples/notebooks/docs/tut/introduction_src.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_test.ipynb b/idaes_examples/notebooks/docs/tut/introduction_test.ipynb
diff --git a/idaes_examples/notebooks/docs/tut/introduction_usr.ipynb b/idaes_examples/notebooks/docs/tut/introduction_usr.ipynb
diff --git a/...otebooks/held/tut/notebook_test_script.py → ...otebooks/docs/tut/notebook_test_script.py b/...otebooks/held/tut/notebook_test_script.py → ...otebooks/docs/tut/notebook_test_script.py
diff --git a/..._examples/notebooks/held/tut/sin_data.csv → ..._examples/notebooks/docs/tut/sin_data.csv b/..._examples/notebooks/held/tut/sin_data.csv → ..._examples/notebooks/docs/tut/sin_data.csv