Adding placeholder for degeneracy hunter docs

IDAES · Oct 3, 2023 · 2d1ae09 · 2d1ae09
1 parent 2ab12f4
commit 2d1ae09
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 8 deletions.
diff --git a/docs/explanations/model_diagnostics/degeneracy_hunter.rst b/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
diff --git a/docs/explanations/model_diagnostics/index.rst b/docs/explanations/model_diagnostics/index.rst
@@ -9,6 +9,7 @@ Model Diagnostics Workflow
     :maxdepth: 1
 
     svd_analysis
+    degeneracy_hunter
 
 Introduction
 ------------

diff --git a/docs/reference_guides/core/util/diagnostics/degeneracy_hunter.rst b/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:
 
diff --git a/docs/reference_guides/core/util/diagnostics/degeneracy_hunter_legacy.rst b/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:
+
diff --git a/docs/reference_guides/core/util/model_diagnostics.rst b/docs/reference_guides/core/util/model_diagnostics.rst
@@ -9,11 +9,12 @@ The IDAES toolset contains a number of utility functions which can be useful for
     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, SVDToolbox, svd_dense, svd_sparse
+    :exclude-members: DegeneracyHunter, DiagnosticsToolbox, SVDToolbox, DegeneracyHunter2, svd_dense, svd_sparse
     :members: