SVD Toolbox for diagnostics

docs/explanations/model_diagnostics/degeneracy_hunter.rst

@@ -0,0 +1,16 @@
+Degeneracy Hunter
+=================
+
+.. contents::
+    :depth: 3
+    :local:
+
+Examples
+--------
+
+An example of using ``Degeneracy Hunter`` can be found here: https://idaes-examples.readthedocs.io/en/latest/docs/diagnostics/degeneracy_hunter_doc.html
+
+Introduction
+------------
+
+TBA

docs/explanations/model_diagnostics/index.rst

@@ -5,6 +5,12 @@ Model Diagnostics Workflow
     :depth: 3
     :local:
 
+.. toctree::
+    :maxdepth: 1
+
+    svd_analysis
+    degeneracy_hunter
+
 Introduction
 ------------
 

docs/explanations/model_diagnostics/svd_analysis.rst

@@ -0,0 +1,8 @@
+SVD Analysis
+============
+
+.. contents::
+    :depth: 3
+    :local:
+
+TBA

docs/reference_guides/core/util/diagnostics/degeneracy_hunter.rst

@@ -1,12 +1,6 @@
 Degeneracy Hunter
 =================
 
-.. note::
-
-    v2.2: The Degeneracy Hunter tool is being deprecated in favor of the newer Diagnostics Toolbox.
-
-    Over the next few releases the functionality of Degeneracy Hunter will be moved over to the new Diagnostics Toolbox which will also contain a number of other tools for diagnosing model issues.
-
-.. autoclass:: idaes.core.util.model_diagnostics.DegeneracyHunter
+.. autoclass:: idaes.core.util.model_diagnostics.DegeneracyHunter2
     :members:
 

docs/reference_guides/core/util/diagnostics/degeneracy_hunter_legacy.rst

@@ -0,0 +1,12 @@
+Degeneracy Hunter (Legacy)
+==========================
+
+.. note::
+
+    v2.2: The original Degeneracy Hunter tool is being deprecated in favor of the newer Diagnostics Toolbox.
+
+    Over the next few releases the functionality of Degeneracy Hunter will be moved over to the new Diagnostics Toolbox which will also contain a number of other tools for diagnosing model issues.
+
+.. autoclass:: idaes.core.util.model_diagnostics.DegeneracyHunter
+    :members:
+

docs/reference_guides/core/util/diagnostics/svd_toolbox.rst

@@ -0,0 +1,16 @@
+SVD Toolbox
+===========
+
+The IDAES SVD Toolbox is an advanced diagnostics tool for helping to identify scaling and degeneracy issues in models using Singular Value Decomposition and is accessible through the ``DiagnosticsToolbox``. Further discussion of how to use and interpret SVD results can be found :ref:`here<explanations/model_diagnostics/svd_analysis:SVD Analysis>`.
+
+.. autoclass:: idaes.core.util.model_diagnostics.SVDToolbox
+    :members:
+
+SVD Callbacks
+-------------
+
+The SVD Toolbox supports callbacks to select the SVD analysis tool to use. Two callbacks are provided to make use of methods available in Scipy.
+
+.. automodule:: idaes.core.util.model_diagnostics
+    :noindex:
+    :members: svd_dense, svd_sparse

docs/reference_guides/core/util/model_diagnostics.rst

@@ -7,12 +7,14 @@ The IDAES toolset contains a number of utility functions which can be useful for
     :maxdepth: 1
 
     diagnostics/diagnostics_toolbox
+    diagnostics/svd_toolbox
     diagnostics/degeneracy_hunter
+    diagnostics/degeneracy_hunter_legacy
 
 Other Methods
 ^^^^^^^^^^^^^
 
 .. automodule:: idaes.core.util.model_diagnostics
-    :exclude-members: DegeneracyHunter, DiagnosticsToolbox
+    :exclude-members: DegeneracyHunter, DiagnosticsToolbox, SVDToolbox, DegeneracyHunter2, svd_dense, svd_sparse
     :members: