aquakin.PlantCheck#

class aquakin.PlantCheck(unfed_ports=<factory>, dangling_outputs=<factory>, recycles=<factory>)[source]#

Bases: object

Result of Plant.check() – a pre-solve wiring report.

Variables:

  • unfed_ports (list[str]) – "unit.port" input ports with no stream wired into them. These are errors: the RHS sweep has no source for them, so the solve fails.

  • dangling_outputs (list[str]) – "unit.port" output ports consumed by no connection. Usually benign – a terminal stream that leaves the plant (final effluent, wasted sludge, disposal cake, biogas) – so they are reported for information, not flagged as errors.

  • recycles (list[str]) – "unit.port" recycle (back-edge) source ports the topological sort detected, for visibility into how the graph was cut.

Parameters:

  • unfed_ports (list)

  • dangling_outputs (list)

  • recycles (list)

__init__(unfed_ports=<factory>, dangling_outputs=<factory>, recycles=<factory>)#
Parameters:

  • unfed_ports (list)

  • dangling_outputs (list)

  • recycles (list)

Return type:

None

Methods

__init__([unfed_ports, dangling_outputs, ...])

summary()

A short human-readable report.

Attributes

ok

True when no input port is unfed (a dangling output is not an error).

unfed_ports

dangling_outputs

recycles

property ok: bool#

True when no input port is unfed (a dangling output is not an error).

summary()[source]#

A short human-readable report.

Return type:

str