Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrap 0D Fixed Bed TSA unit model in extra_models/fixed_bed_tsa0d for Flowsheet Processor UI #1493

Merged
merged 51 commits into from
Feb 14, 2025

Conversation

dangunter
Copy link
Member

@dangunter dangunter commented Oct 2, 2024

Fixes

Documentation: https://idaes-pse.readthedocs.io/en/latest/reference_guides/model_libraries/models_extra/temperature_swing_adsorption/fixed_bed_tsa0d.html
Example: https://idaes-examples.readthedocs.io/en/latest/docs/flowsheets/temperature_swing_adsorption/temperature_swing_adsorption_doc.html

Summary/Motivation:

Initial UI wrapper for IDAES

Changes proposed in this PR:

  • Wrap the model so it can be displayed in the Flowsheet Processor UI

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.

@dangunter
Copy link
Member Author

dangunter commented Oct 3, 2024

One issue I see immediately is that the "model options" for the TSA has a number of values and they will probably be changed at the same time / along with the model's other parameters and variables. However currently the UI sets these options in different, initial step, as shown by this screenshot for a watertap model:

image

This is, imho not ideal. We should have these sorts of model options more included in the main configuration page, even though they are not Pyomo vars.

@Daison2102 Do I have this roughly right about the FixedBedTSA0D model class?
@sspoon, @MichaelPesce thoughts on the design?

@dangunter dangunter requested a review from MichaelPesce October 3, 2024 17:29
@MichaelPesce
Copy link

@dangunter the original purpose of those options were to allow for pre-build configurations, so it had made sense to be able to view them before running the build. however, they should also be available from the main workflow (after build step), where the model can be re-built with different model configurations

@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Oct 3, 2024
@dangunter
Copy link
Member Author

@MichaelPesce ok, though I think it might be better to have them as normal parameters

@dangunter dangunter assigned CopyDemon and unassigned dangunter Oct 17, 2024
@lbianchi-lbl lbianchi-lbl changed the title Wrap 0D Fixed Bed TSA unit model in extra_models/fixed_bed_tsa0d for Flowsheet Runner UI Wrap 0D Fixed Bed TSA unit model in extra_models/fixed_bed_tsa0d for Flowsheet Processor UI Nov 4, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 6, 2025

Codecov Report

Attention: Patch coverage is 96.38554% with 3 lines in your changes missing coverage. Please review.

Project coverage is 76.85%. Comparing base (ce941ce) to head (25a485d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...temperature_swing_adsorption/fixed_bed_tsa0d_ui.py 96.34% 1 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1493      +/-   ##
==========================================
- Coverage   77.06%   76.85%   -0.22%     
==========================================
  Files         389      394       +5     
  Lines       62709    63231     +522     
  Branches    10280    10354      +74     
==========================================
+ Hits        48329    48594     +265     
- Misses      11941    12194     +253     
- Partials     2439     2443       +4     

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

@lbianchi-lbl lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@lbianchi-lbl lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@lbianchi-lbl lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@lbianchi-lbl lbianchi-lbl added CI:run-integration triggers_workflow: Integration dependencies Pull requests that update a dependency file labels Feb 12, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Feb 12, 2025
@lbianchi-lbl lbianchi-lbl self-requested a review February 13, 2025 19:44
@lbianchi-lbl lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Feb 14, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Feb 14, 2025
@lbianchi-lbl lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Feb 14, 2025
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Feb 14, 2025
@lbianchi-lbl lbianchi-lbl merged commit 997c3a5 into IDAES:main Feb 14, 2025
40 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants