Add doc for debug solver wrapper and cleanup #1470
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MarcusHolly
approved these changes
Jul 24, 2024
|
|
||
| (1) Stores initialization information before a failed solve | ||
|
|
||
| (2) Upon a failed attempt to solve, the user is routed to an Interactive Python notebook where the restored model state can be accessed, `IDAES' DiagnosticToolbox <https://idaes-pse.readthedocs.io/en/stable/reference_guides/core/util/diagnostics/diagnostics_toolbox.html>` is instantiated to probe the model, and the user can freely apply any other diagnostic utility functions to troubleshoot the problematic model. |
There was a problem hiding this comment.
Suggested change
| (2) Upon a failed attempt to solve, the user is routed to an Interactive Python notebook where the restored model state can be accessed, `IDAES' DiagnosticToolbox <https://idaes-pse.readthedocs.io/en/stable/reference_guides/core/util/diagnostics/diagnostics_toolbox.html>` is instantiated to probe the model, and the user can freely apply any other diagnostic utility functions to troubleshoot the problematic model. | |
| (2) Upon a failed attempt to solve, the user is routed to an Interactive Python notebook where the restored model state can be accessed, `IDAES' DiagnosticToolbox <https://idaes-pse.readthedocs.io/en/stable/reference_guides/core/util/diagnostics/diagnostics_toolbox.html>`_ is instantiated to probe the model, and the user can freely apply any other diagnostic utility functions to troubleshoot the problematic model. |
Link is not working correctly - I think you're just missing this one character
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
lbianchi-lbl
pushed a commit
to watertap-org/watertap-solvers
that referenced
this pull request
Dec 7, 2024
lbianchi-lbl
pushed a commit
to watertap-org/watertap-solvers
that referenced
this pull request
Dec 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes/Resolves:
Summary/Motivation:
This PR adds a how-to to describe our new debug mode brought in by @bknueven in PR #1287. The how-to is largely taken from his comments in that PR.
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: