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

Be more robust to issues with the flowsheets #55

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Be more robust to issues with the flowsheets #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
555f838
fix for missing attr
dangunter Oct 25, 2024
e23ad35
some debug logs
dangunter Oct 31, 2024
1bf4205
strict mode for validation, warn by default for missing components
dangunter Oct 31, 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
75 changes: 45 additions & 30 deletions idaes_ui/fv/flowsheet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class FileBaseNameExistsError(Exception):
pass


def validate_flowsheet(fs: Dict) -> Tuple[bool, str]:
def validate_flowsheet(fs: Dict, strict: bool = False) -> Tuple[bool, str]:
"""Validate a flowsheet.

Expected format is below.
Expand Down Expand Up @@ -80,6 +80,8 @@ def validate_flowsheet(fs: Dict) -> Tuple[bool, str]:

Args:
fs: Flowsheet to validate
strict: In this mode some warnings will be failures: when components
are in the model but not in the diagram (that's it for now).

Return:
Tuple of (True, "") for OK, and (False, "<message>") for failure
Expand Down Expand Up @@ -115,16 +117,15 @@ def validate_flowsheet(fs: Dict) -> Tuple[bool, str]:
return False, f"Cell id '{cell_id}' not found in unit models or arcs"
cell_ids.add(cell_id)
# Check if all model id's are in the cells
# If not, in strict mode Fail; otherwise, issue a warning and keep on truckin'
if cell_ids != component_ids:
missing = component_ids - cell_ids
sfx = "s" if len(missing) > 1 else ""
return (
False,
(
f"Component id{sfx} {missing} {'are' if sfx else 'is'} not in the"
" layout cells"
),
)
n_missing = len(missing)
message = f"{n_missing} components not shown in the diagram: {missing}"
if strict:
return False, message
else:
_log.warning(message)
return True, ""


Expand Down Expand Up @@ -256,7 +257,13 @@ def _identify_unit_models(self) -> Dict:
component, StateBlock
):
# skip physical parameter / state blocks
pass
try:
comp_name = component.getname()
except AttributeError:
comp_name = "<unknown>"
_log.debug(
f"Skipping physical parameter or state block for component '{comp_name}'"
)
else:
# Find unit models nested within indexed blocks
type_ = self.get_unit_model_type(component)
Expand Down Expand Up @@ -284,20 +291,20 @@ def _construct_stream_labels(self):
stream_states_dict,
) # deferred to avoid circ. import

# We might have this information from generating self.serialized_components
# but I (Makayla) don't know how that connects to the stream names so this
# will be left alone for now
for stream_name, stream_value in stream_states_dict(self.streams).items():
label = ""
for var, var_value in stream_value.define_display_vars().items():
var = var.capitalize()
if not hasattr(stream_value, "define_display_vars"):
self.labels[stream_name] = "None"
else:
for var, var_value in stream_value.define_display_vars().items():
var = var.capitalize()

for k, v in var_value.items():
if k is None:
label += f"{var} {round(value(v), self._sig_figs)}\n"
else:
label += f"{var} {k} {round(value(v), self._sig_figs)}\n"
self.labels[stream_name] = label[:-2]
for k, v in var_value.items():
if k is None:
label += f"{var} {round(value(v), self._sig_figs)}\n"
else:
label += f"{var} {k} {round(value(v), self._sig_figs)}\n"
self.labels[stream_name] = label[:-2]

def _map_edges(self):
# Map the arcs to the ports to construct the edges
Expand Down Expand Up @@ -382,8 +389,10 @@ def _make_valid_json(self, df):

def _add_unit_model_with_ports(self, unit, unit_type):
unit_name = unit.getname()
_log.debug(f"Attempting to add unit model '{unit_name}'")
if unit.parent_block() == self.flowsheet:
# The unit is top-level and therefore should be displayed.
_log.debug(f"Found top-level unit '{unit_name}': will be displayed")
self.unit_models[unit] = {
"name": unit_name,
"type": unit_type,
Expand All @@ -406,25 +415,29 @@ def _add_unit_model_with_ports(self, unit, unit_type):
# performance_contents is a dict like:
# {'vars': {'Heat Duty': <pyomo.core.base.var._GeneralVarData object>,
# 'Pressure Change': <pyomo.core.base.var._GeneralVarData>}}
if performance_contents:
if performance_contents and hasattr(performance_contents, "vars"):
# If performance contents is not empty or None then stick it into a
# dataframe and convert the GeneralVars to actual values
performance_df = pd.DataFrame(
performance_contents["vars"].items(), columns=["Variable", "Value"]
performance_contents["vars"].items(),
columns=["Variable", "Value"],
)
performance_df["Value"] = performance_df["Value"].map(value)
performance_df = self._make_valid_json(performance_df)
self._serialized_contents[unit_name][
"performance_contents"
] = performance_df
else:
self._serialized_contents[unit_name][
"performance_contents"
] = pd.DataFrame({}, columns=["Variable", "Value"])
self._serialized_contents[unit_name]["performance_contents"] = (
pd.DataFrame({}, columns=["Variable", "Value"])
)
elif unit in self._known_endpoints:
# Unit is a subcomponent AND it is connected to an Arc. Or maybe it's in
# an indexed block. Find the top-level parent unit and assign the
# serialized link to the parent.
_log.debug(
f"Found connected but non-top-level unit '{unit_name}': might be displayed"
)
parent_unit = unit.parent_block()
while not parent_unit == self.flowsheet:
parent_unit = parent_unit.parent_block()
Expand All @@ -443,7 +456,9 @@ def _add_unit_model_with_ports(self, unit, unit_type):
else:
# The unit is neither top-level nor connected; do not display this unit,
# since it is a subcomponent.
pass
_log.info(
f"Unit '{unit_name}' is neither top-level nor connected: will not be displayed"
)

@staticmethod
def get_unit_model_type(unit) -> str:
Expand Down Expand Up @@ -559,9 +574,9 @@ def _construct_model_json(self):
# )
.apply(
lambda col: col.apply(
lambda x: round(x, self._sig_figs)
if isinstance(x, (int, float))
else x
lambda x: (
round(x, self._sig_figs) if isinstance(x, (int, float)) else x
)
)
)
)
Expand Down
22 changes: 21 additions & 1 deletion idaes_ui/fv/model_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,8 @@ def do_GET(self):
* `/setting`: Retrieve a setting value.
* `/path/to/file`: Retrieve file stored static directory
"""

if _log.isEnabledFor(logging.DEBUG):
_log.debug(f"begin do_GET: path={self.path}")
# Query url param
u, queries = self._parse_flowsheet_url(self.path)
id_ = queries.get("id", None) if queries else None
Expand All @@ -286,6 +287,8 @@ def do_GET(self):
self.send_error(
400, message=f"Query parameter 'id' is required for '{u.path}'"
)
if _log.isEnabledFor(logging.DEBUG):
_log.debug(f" end do_GET: path={self.path} status=error missing 'id'")
return

# From path get what to do
Expand All @@ -300,6 +303,10 @@ def do_GET(self):
400,
message=f"Query parameter 'setting_key' is required for '{u.path}'",
)
if _log.isEnabledFor(logging.DEBUG):
_log.debug(
f" end do_GET: path={self.path} status=error missing 'setting_key'"
)
return
self._get_setting(setting_key_)
elif u.path == "/diagnostics":
Expand All @@ -309,13 +316,20 @@ def do_GET(self):
self.directory = _static_dir # keep here: overwritten if set earlier
super().do_GET()

if _log.isEnabledFor(logging.DEBUG):
_log.debug(f"begin do_GET: path={self.path} status=ok")

def _get_app(self, id_):
"""Read index file, process to insert flowsheet identifier, and return it."""
if _log.isEnabledFor(logging.DEBUG):
_log.debug(f"begin /app")
p = Path(_template_dir / "index.html")
with open(p, "r", encoding="utf-8") as fp:
s = fp.read()
page = s.format(flowsheet_id=id_)
self._write_html(200, page)
if _log.isEnabledFor(logging.DEBUG):
_log.debug(f"end /app")

def _get_fs(self, id_: str):
"""Get updated flowsheet.
Expand All @@ -326,18 +340,24 @@ def _get_fs(self, id_: str):
Returns:
None
"""
if _log.isEnabledFor(logging.DEBUG):
_log.debug(f"begin /fs")
try:
merged = self.server.update_flowsheet(id_)
except errors.FlowsheetUnknown as err:
# User error: user asked for a flowsheet by an unknown ID
self.send_error(404, message=str(err))
_log.error(f" end /fs: status=error bad-id")
return
except (errors.FlowsheetNotFound, errors.ProcessingError) as err:
# Internal error: flowsheet ID is found, but other things are missing
self.send_error(500, message=str(err))
_log.error(f" end /fs: status=error msg={str(err)}")
return
# Return merged flowsheet
self._write_json(200, merged)
if _log.isEnabledFor(logging.DEBUG):
_log.debug(f" end /fs: status=ok")

def _get_setting(self, setting_key_: str):
"""Get setting value.
Expand Down
Loading