Add notebook for scaling workshop (#135)

* Adding scaler workshop * Updating notebook based on feedback * Adding tests for scaling workshop * Fixing typos * Running black * Adding headers * Apply suggestions from code review Co-authored-by: agarciadiego <[email protected]> * Fixing typos from review * Update idaes_examples/notebooks/_toc.yml * Better discussion of Jacobian * Showing how to view constraint * Fixing typo * Addressing comments --------- Co-authored-by: agarciadiego <[email protected]>
IDAES · Nov 5, 2024 · 919300c · 919300c
1 parent 074d3fd
commit 919300c
Show file tree

Hide file tree

Showing 6 changed files with 7,814 additions and 0 deletions.
diff --git a/idaes_examples/notebooks/_toc.yml b/idaes_examples/notebooks/_toc.yml
@@ -20,6 +20,9 @@ parts:
     - file: docs/diagnostics/diagnostics_toolbox_doc
     - file: docs/diagnostics/degeneracy_hunter_doc
     - file: docs/diagnostics/structural_singularity_doc
+  - file: docs/scaling/index
+    sections:
+    - file: docs/scaling/scaler_workshop_doc
   - file: docs/param_est/index
     sections:
     - file: docs/param_est/parameter_estimation_nrtl_using_state_block_doc

diff --git a/idaes_examples/notebooks/docs/scaling/index.md b/idaes_examples/notebooks/docs/scaling/index.md
@@ -0,0 +1,4 @@
+# Scaling
+
+IDAES Scaling Toolbox
+* How to write modular Scalers using the toolbox
diff --git a/idaes_examples/notebooks/docs/scaling/scaler_workshop.ipynb b/idaes_examples/notebooks/docs/scaling/scaler_workshop.ipynb
diff --git a/idaes_examples/notebooks/docs/scaling/scaler_workshop_doc.ipynb b/idaes_examples/notebooks/docs/scaling/scaler_workshop_doc.ipynb
diff --git a/idaes_examples/notebooks/docs/scaling/scaler_workshop_test.ipynb b/idaes_examples/notebooks/docs/scaling/scaler_workshop_test.ipynb
diff --git a/idaes_examples/notebooks/docs/scaling/scaler_workshop_usr.ipynb b/idaes_examples/notebooks/docs/scaling/scaler_workshop_usr.ipynb