diff --git a/docs/explanations/model_diagnostics/degeneracy_hunter.rst b/docs/explanations/model_diagnostics/degeneracy_hunter.rst new file mode 100644 index 0000000000..5af66b7959 --- /dev/null +++ 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 index 56fba9b2b7..d3c3a14e2a 100644 --- 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 index c5ecf06d13..a0f294d376 100644 --- 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 new file mode 100644 index 0000000000..83b2101e2f --- /dev/null +++ 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 index 996eb64cf7..02e35aa5ec 100644 --- 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: