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

Move UI visualizer code out of this repo #1146

Merged
merged 26 commits into from
Aug 24, 2023

Conversation

dangunter
Copy link
Member

@dangunter dangunter commented Mar 25, 2023

Fixes #1129

Related to IDAES/idaes-ui#11

Changes proposed in this PR:

  • Remove visualizer code
  • Add tests to verify correct operation
  • Update docs accordingly

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 Mar 26, 2023

Codecov Report

Patch coverage: 70.00% and project coverage change: -0.29% ⚠️

Comparison is base (9d958b1) 76.87% compared to head (3980fc3) 76.59%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1146      +/-   ##
==========================================
- Coverage   76.87%   76.59%   -0.29%     
==========================================
  Files         390      382       -8     
  Lines       61889    60822    -1067     
  Branches    11376    11200     -176     
==========================================
- Hits        47576    46584     -992     
+ Misses      11857    11822      -35     
+ Partials     2456     2416      -40     
Files Changed Coverage Δ
idaes/core/base/flowsheet_model.py 88.78% <70.00%> (-3.35%) ⬇️

... and 6 files with indirect coverage changes

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

Copy link
Member

@andrewlee94 andrewlee94 left a comment

Choose a reason for hiding this comment

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

This looks OK to me. My only comment is that we should probably be adding some sort of pointer to documentation on how to install and set up the UI in the main IDAES docs.

@dangunter
Copy link
Member Author

@andrewlee94 w.r.t. installation instructions I agree, and it was on my to-do list. In a perfect world that would go first. But I have noticed that the current version in main has a bug in the stream table, that didn't seem to lead to any complaints (but looks bad). So in the interest of simplicity, I'd like to just move forward with this PR and then add back instructions once I've got a less borked version of the UI working in the new repo.

Copy link
Contributor

@lbianchi-lbl lbianchi-lbl left a comment

Choose a reason for hiding this comment

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

I've left a suggestion to consider whether we need the added complexity of the wrapper class for this particular case since there's only one call site to handle. Otherwise looks good.

idaes/core/base/flowsheet_model.py Outdated Show resolved Hide resolved
idaes/core/base/flowsheet_model.py Outdated Show resolved Hide resolved
@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Mar 30, 2023
@CopyDemon
Copy link
Contributor

I agree with the changes. I think it's a good idea to remove the UI from the main code and add it to its own repo. This will make the code more modular and easier to maintain.

I also agree with Andrew's comment that we should add some sort of pointer to documentation on how to install and set up the UI in the main IDAES docs. This will make it easier for users to get started with the UI. Or we can make some automation install when they install IDAES.

@lbianchi-lbl lbianchi-lbl added Priority:High High Priority Issue or PR and removed Priority:Normal Normal Priority Issue or PR labels May 25, 2023
@lbianchi-lbl
Copy link
Contributor

@lbianchi-lbl
Copy link
Contributor

Waiting on @dangunter and/or @lbianchi-lbl to fix the git conflicts.

@lbianchi-lbl lbianchi-lbl added the CI:run-integration triggers_workflow: Integration label Aug 4, 2023
@idaes-build idaes-build removed the CI:run-integration triggers_workflow: Integration label Aug 4, 2023
@lbianchi-lbl lbianchi-lbl enabled auto-merge (squash) August 24, 2023 20:41
@lbianchi-lbl lbianchi-lbl merged commit 5a9ead4 into IDAES:main Aug 24, 2023
35 of 36 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.

Move flowsheet visualizer UI code to new repositories
6 participants