Adding StreamScaler unit model, along with the test and rst file. #1517

tannerpolley · 2024-10-31T18:04:43Z

Fixes

Adding a python file that contains a new unit model "StreamScaler" along with a test file and a rst file.

Summary/Motivation:

Adding a useful unit model build by Douglas Allen. This pull request was a task for me to learn and practice the skills necessary to become proficient and code/software management

Changes proposed in this PR:

Changing the default timeout timer in the build.py file when building the docs. It always times out for me at the default 180 seconds

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.

…to the init file

…to build.py timing out

… stream_scaler_Polley # Conflicts: # idaes/models/unit_models/tests/test_stream_scaler.py

andrewlee94

A few comments fro ma first pass - the main thing is that the docs need to tell the user more about what this model does.

However, I think we should consider a different name for this model as including Scaler in the name will probably cause confusion with the new Scaler classes for numerical scaling.

docs/build.py

idaes/models/unit_models/__init__.py

idaes/models/unit_models/stream_scaler.py

docs/reference_guides/model_libraries/generic/unit_models/stream_scaler.rst

idaes/models/unit_models/tests/test_stream_scaler.py

codecov-commenter · 2024-11-01T19:11:01Z

Codecov Report

Attention: Patch coverage is 80.88235% with 13 lines in your changes missing coverage. Please review.

Project coverage is 77.06%. Comparing base (b032b22) to head (89e326b).
Report is 18 commits behind head on main.

Files with missing lines	Patch %	Lines
idaes/models/unit_models/stream_scaler.py	80.59%	12 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1517      +/-   ##
==========================================
- Coverage   77.06%   77.06%   -0.01%     
==========================================
  Files         386      387       +1     
  Lines       62418    62486      +68     
  Branches    10230    10236       +6     
==========================================
+ Hits        48101    48153      +52     
- Misses      11884    11900      +16     
  Partials     2433     2433

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

idaes/models/unit_models/stream_scaler.py

idaes/models/unit_models/tests/test_stream_scaler.py

idaes/models/unit_models/stream_scaler.py

… no solve or numerical tests to be done for the iapws since the unit model has no unit model level contraints. Tried to run the test_solve but got no feasible solution

dallan-keylogic

Looks good now.

…m_scaler_Polley

bpaul4

Besides my minor comments below, I think a test with a multiplier value greater than 1 would be useful to confirm the unit behavior. For example, if feed has a flow of 1 and the multiplier value is 2, does the outlet stream have a flow of 0.5 or is just the scaling factor 0.5? Also a check on a multiplier value of 0, whether values less than 1 should be allowed, or if only integer values should be allowed.

idaes/models/unit_models/tests/test_stream_scaler.py

dallan-keylogic and others added 10 commits September 23, 2024 16:36

pull from MEA development branch

43982e5

Added test file for StreamScaler unit model and added the unit model …

00576ac

…to the init file

pull from MEA development branch

1adb5b2

Added test file for StreamScaler unit model and added the unit model …

0af89d1

…to the init file

Added rst file for Stream Scaler Unit Model

f689ae1

Added stream_scaler.rst to the table of contents

288a39e

Created the rst file for the stream_scaler unit model

9c512e8

Changed the default timeout time from 180 seconds -> 360 seconds due …

0d4d244

…to build.py timing out

Merge remote-tracking branch 'tannerpolley/stream_scaler_Polley' into…

ff9a777

… stream_scaler_Polley # Conflicts: # idaes/models/unit_models/tests/test_stream_scaler.py

Reformatted with Black

603c4b5

tannerpolley requested review from dallan-keylogic and lbianchi-lbl October 31, 2024 18:04

tannerpolley self-assigned this Oct 31, 2024

tannerpolley requested review from agarciadiego, bpaul4 and dangunter as code owners October 31, 2024 18:04

tannerpolley added 2 commits October 31, 2024 12:21

Removed unused code flagged by Pylint

086e80f

Removed unused code flagged by Pylint

91a0f64

andrewlee94 suggested changes Oct 31, 2024

View reviewed changes

lbianchi-lbl added the Priority:Normal Normal Priority Issue or PR label Oct 31, 2024

tannerpolley added 2 commits November 1, 2024 12:12

Removed unused code flagged by Pylint

4bc4aea

Removed unused code flagged by Pylint

40ac61a

Merge remote-tracking branch 'origin/main' into stream_scaler_Polley

11da999

dallan-keylogic requested changes Nov 5, 2024

View reviewed changes

tannerpolley added 5 commits November 15, 2024 14:12

Added StreamScalerData class to the init file for unit models

85b1679

Added Tanner Polley as a co-author

30565ec

Adjusted the details of the additional constraints

7fa9c2a

Resolved the test_solution method for btx and removed the comment for…

15a0426

… no solve or numerical tests to be done for the iapws since the unit model has no unit model level contraints. Tried to run the test_solve but got no feasible solution

Ran Black on these files

194f476

Merge branch 'main' into stream_scaler_Polley

a96f827

dallan-keylogic approved these changes Nov 15, 2024

View reviewed changes

tannerpolley added 3 commits November 18, 2024 12:32

Fixed degrees of freedom on doc file

2df7345

Merge remote-tracking branch 'origin/stream_scaler_Polley' into strea…

c957d4a

…m_scaler_Polley

Revised the documentation for Degrees of Freedom for Stream Scaler

faced0b

bpaul4 reviewed Nov 21, 2024

View reviewed changes

idaes/models/unit_models/tests/test_stream_scaler.py Outdated Show resolved Hide resolved

idaes/models/unit_models/tests/test_stream_scaler.py Outdated Show resolved Hide resolved

idaes/models/unit_models/tests/test_stream_scaler.py Outdated Show resolved Hide resolved

tannerpolley and others added 2 commits November 21, 2024 15:48

Removed unnecessary comments

779296e

Merge branch 'main' into stream_scaler_Polley

89e326b

lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Nov 27, 2024

idaes-build removed the CI:run-integration triggers_workflow: Integration label Nov 27, 2024

lbianchi-lbl merged commit e8c9712 into IDAES:main Nov 27, 2024
41 checks passed

Adding StreamScaler unit model, along with the test and rst file. #1517

Adding StreamScaler unit model, along with the test and rst file. #1517

Uh oh!

Conversation

tannerpolley commented Oct 31, 2024

Fixes

Summary/Motivation:

Changes proposed in this PR:

Legal Acknowledgement

Uh oh!

andrewlee94 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dallan-keylogic left a comment

Choose a reason for hiding this comment

Uh oh!

bpaul4 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

codecov-commenter commented Nov 1, 2024 •

edited

Loading