Add GUI for RO flowsheet

[luohezhiming]

Fixes/Resolves:

Summary/Motivation:

Add GUI for the RO_with_energy_recovery.py flowsheet

Changes proposed in this PR:

• add GUI
• add figure

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.

[MarcusHolly]

Screenshots of GUI

Input Tab:

Output Tab:

[MarcusHolly]

I'll let other people comment on whether or not more things should be included in the input and output tabs, but I think every variable in the input tab should start off as "fixed". There are some that have been changed to "free", which I assume you just did to make sure the sweep was working correctly.

My new PR (#1160) is also running into pylint errors... @lbianchi-lbl is it ok if we bypass this test or should we really aim to resolve it? These are my remaining pylint warnings, and I don't think resolving any of these would be trivial (with the exception of the import warnings potentially). I'm also not convinced that these pylint errors are related to the GUI files we're modifying.

[adam-a-a]

I'll let other people comment on whether or not more things should be included in the input and output tabs, but I think every variable in the input tab should start off as "fixed". There are some that have been changed to "free", which I assume you just did to make sure the sweep was working correctly.

My new PR (#1160) is also running into pylint errors... @lbianchi-lbl is it ok if we bypass this test or should we really aim to resolve it? These are my remaining pylint warnings, and I don't think resolving any of these would be trivial (with the exception of the import warnings potentially). I'm also not convinced that these pylint errors are related to the GUI files we're modifying.

This pylint issue popped up in at least PR #1145, which @bknueven temporarily resolved by limiting the version of pylint in PR #1145. That one will be merged very soon.

[luohezhiming]

Screenshots of GUI

Input Tab:

Output Tab:

Thanks, Marcus. This is pretty good point, one of the problem is the feed flowrate and concentration are calculated by calculate_state and not directly specified. That's why it is shown as free variables in the GUI. I've already modified the inputs of feed as flowrate of water and NaCl. Right now, they are all fixed variables that we can make sweep analysis

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9f143c0) 94.91% compared to head (34ea1af) 94.92%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1159      +/-   ##
==========================================
+ Coverage   94.91%   94.92%   +0.01%     
==========================================
  Files         341      342       +1     
  Lines       34603    34652      +49     
==========================================
+ Hits        32842    32892      +50     
+ Misses       1761     1760       -1     

Files	Coverage Δ
...with_energy_recovery/RO_with_energy_recovery_ui.py	100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

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

[adam-a-a]

@luohezhiming I think this should be good to merge once you update the flowsheet image to represent the configuration (i.e., include pumps and ERD)

[luohezhiming]

@luohezhiming I think this should be good to merge once you update the flowsheet image to represent the configuration (i.e., include pumps and ERD)

@adam-a-a I updated the figure and I think it is ready for merge, we can upgrade it with different types once the UI option is available.

[adam-a-a]

@MichaelPesce @dangunter btw- just a reminder that this is one of the examples that we think would serve well for testing config options (e.g., switch between one flowsheet build and another)

[adam-a-a]

LGTM