Skip to content

Diagnostics Toolbox Scaling#1697

Merged
dallan-keylogic merged 6 commits intoIDAES:scaling_toolboxfrom
dallan-keylogic:diagnostics_toolbox_scaling
Nov 6, 2025
Merged

Diagnostics Toolbox Scaling#1697
dallan-keylogic merged 6 commits intoIDAES:scaling_toolboxfrom
dallan-keylogic:diagnostics_toolbox_scaling

Conversation

@dallan-keylogic
Copy link
Contributor

@dallan-keylogic dallan-keylogic commented Nov 4, 2025

Summary/Motivation:

Changes the Diagnostics Toolbox to take model scaling into account.

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@codecov
Copy link

codecov bot commented Nov 5, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 98.01980% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.41%. Comparing base (9094267) to head (bf0d7cc).
⚠️ Report is 2 commits behind head on scaling_toolbox.

Files with missing lines Patch % Lines
idaes/core/scaling/util.py 97.18% 1 Missing and 1 partial ⚠️
Additional details and impacted files 
@@                 Coverage Diff                 @@
##           scaling_toolbox    #1697      +/-   ##
===================================================
+ Coverage            77.40%   77.41%   +0.01%     
===================================================
  Files                  395      395              
  Lines                64629    64698      +69     
  Branches             10859    10877      +18     
===================================================
+ Hits                 50026    50088      +62     
- Misses               12093    12097       +4     
- Partials              2510     2513       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dallan-keylogic dallan-keylogic added the CI:run-integration triggers_workflow: Integration label Nov 5, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Nov 5, 2025
@dallan-keylogic dallan-keylogic marked this pull request as ready for review November 5, 2025 18:05
MarcusHolly
MarcusHolly reviewed Nov 5, 2025
View reviewed changes
idaes/core/scaling/util.py
Comment on lines +1132 to +1133
include_scaling_factors=True,
include_ipopt_autoscaling=False,
Copy link
Contributor

@MarcusHolly MarcusHolly Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it problematic if a user sets both of these options to True? If so, an error should be raised in these cases

Copy link
Contributor Author

@dallan-keylogic dallan-keylogic Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's not. Now that we've set the scale_model writer setting to True, the IPOPT autoscaling is an additional layer of scaling on top of the user-provided scaling factors. This option reflects that.

agarciadiego
agarciadiego approved these changes Nov 6, 2025
View reviewed changes
Copy link
Contributor

@agarciadiego agarciadiego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dallan-keylogic Do we know how this will affect the diagnostics toolbox notebook in idaes/examples?

@dallan-keylogic dallan-keylogic merged commit 21fddac into IDAES:scaling_toolbox Nov 6, 2025
74 checks passed
@dallan-keylogic dallan-keylogic deleted the diagnostics_toolbox_scaling branch November 6, 2025 15:02
dallan-keylogic added a commit that referenced this pull request Nov 6, 2025
@dallan-keylogic @MarcusHolly
Diagnostics Toolbox Scaling (#1697)
3f80d5b 
* first steps to make diagnostics toolbox work with scaling factors

* include scaling in model diagnostics

* switch get_scaling_factor to using the suffix finder

* change in functionality

* Suffix is no longer generated from get_scaling_factor

* Update idaes/core/scaling/util.py

Co-authored-by: MarcusHolly <[email protected]>

---------

Co-authored-by: MarcusHolly <[email protected]>
@dallan-keylogic dallan-keylogic mentioned this pull request Nov 10, 2025
Closed
@dallan-keylogic dallan-keylogic mentioned this pull request Nov 21, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agarciadiego agarciadiego agarciadiego approved these changes

@MarcusHolly MarcusHolly MarcusHolly approved these changes

@bpaul4 bpaul4 Awaiting requested review from bpaul4 bpaul4 is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dallan-keylogic @agarciadiego @MarcusHolly @idaes-build