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.

Sign up for GitHub

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

add UI return, then visualize() can return now #1466

Merged
merged 6 commits into from
Aug 28, 2024
Merged

add UI return, then visualize() can return now #1466

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9943745
add UI return, then user can use fv = m.fs.visualize(), then call the…
CopyDemon Aug 7, 2024
451a7fe
add string description for return type here, return type defined in U…
CopyDemon Aug 8, 2024
7c3ec16
Update idaes/core/base/flowsheet_model.py
CopyDemon Aug 14, 2024
510cb22
Use Sphinx way to generate a clickable reference for Sphinx doc for t…
CopyDemon Aug 14, 2024
9af67d3
Fix Sphinx interpretation issue by removing incorrect `visualize_resu…
CopyDemon Aug 22, 2024
10ead5b
Merge branch 'main' into issue-45-send-back-diagram-image-pse
lbianchi-lbl Aug 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions idaes/core/base/flowsheet_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ def stream_table(self, true_state=False, time_point=0, orient="columns"):
dict_arcs, time_point=time_point, orient=orient, true_state=true_state
)

def visualize(self, model_name, **kwargs):
def visualize(self, model_name, **kwargs) -> "VisualizeResult":
"""
Starts up a flask server that serializes the model and pops up a
webpage with the visualization
Expand All @@ -275,9 +275,10 @@ def visualize(self, model_name, **kwargs):
**kwargs: Additional keywords for :func:`idaes.core.ui.fv.visualize()`

Returns:
None
visualize_result: The :class:`idaes_ui.fv.fsvis.VisualizeResult` instance returned by :meth:`UI.visualize`
CopyDemon marked this conversation as resolved.
Show resolved Hide resolved
"""
UI().visualize(self, model_name, **kwargs)
visualize_result = UI().visualize(self, model_name, **kwargs)
return visualize_result

def _get_stream_table_contents(self, time_point=0):
"""
Expand Down
Loading