Skip to content

Scaling 201#167

Merged
dallan-keylogic merged 7 commits intoIDAES:mainfrom
dallan-keylogic:scaling_201
Apr 30, 2026
Merged

Scaling 201#167
dallan-keylogic merged 7 commits intoIDAES:mainfrom
dallan-keylogic:scaling_201

Conversation

@dallan-keylogic
Copy link
Copy Markdown
Contributor

@dallan-keylogic dallan-keylogic commented Apr 24, 2026

Supplemental tutorial notebook for scaling.

Legal Acknowledgement

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

I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
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.

📚 Documentation preview 📚: https://idaes-examples--167.org.readthedocs.build/en/167/

Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
"\n",
"## Introduction\n",
"\n",
"This notebook is intended to give the user further insight into how the scaling toolbox can be used to improve robustness. By the end of this study, the user should understand:\n",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should note that this is intended to be a follow-up of the previous scaling tutorial, and should provide a hyperlink to it

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do we have an example of an example notebook hyperlinking to another example notebook? I checked several notebooks, but they only had external links.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here is an example from WaterTAP:
image

Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
dallan-keylogic and others added 4 commits April 27, 2026 12:06
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: dallan-keylogic <88728506+dallan-keylogic@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

@dallan-keylogic dallan-keylogic left a comment

Choose a reason for hiding this comment

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

For some reason Github held these comments.

"id": "b8486746-111b-4df6-82f5-aeabe5bc2211",
"metadata": {},
"source": [
"The `get_sum_terms_nominal_values` method in `CustomScalerBase` which uses an expression walker to go through an expression to return a list of the expected magnitude (or \"nominal value\") of all additive terms in the expression based on the scaling factors for the variables involved. For example, suppose we have an expression\n",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It might be too far into the weeds, but considering how central the expression walker is to the new scaling tools, I think we need to warn the users about its limitations somehow.

Maybe the best thing would be to have the walker itself look for "dangerous" operations and then raise an Exception if the user hasn't set some "I know the risks" setting.

Comment thread idaes_examples/notebooks/docs/scaling/scaling_201.ipynb Outdated
"\n",
"## Introduction\n",
"\n",
"This notebook is intended to give the user further insight into how the scaling toolbox can be used to improve robustness. By the end of this study, the user should understand:\n",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do we have an example of an example notebook hyperlinking to another example notebook? I checked several notebooks, but they only had external links.

Copy link
Copy Markdown
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

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

Thanks for the quick turnaround on this Doug. I will approve under the assumption that you'll address the issue with the condition number tests

@dallan-keylogic dallan-keylogic marked this pull request as ready for review April 30, 2026 18:07
@ksbeattie ksbeattie added the Priority:High High Priority Issue or PR label Apr 30, 2026
@dallan-keylogic dallan-keylogic merged commit ed708c8 into IDAES:main Apr 30, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority:High High Priority Issue or PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants