Structure

Constructor

Structure

A class that represents a particular system structure that may be represented by multiple model elements.

Properties

Structure.out

The Output object from which this structure is derived

Structure.link

A list of the link(s) that belong to this structure

Structure.node

A list of the node(s) that belong to this structure

Structure.flowFrame

Returns a pandas DataFrame with the flow rates of each link in the structure

Structure.floodFrame

Returns a pandas DataFrame with the flood rates of each node in the structure

Methods

Structure.flowEvents

Bin flow data into discrete events based on an inter-event period and threshold flow rate.

Structure.floodEvents

Bins flooding data into discrete events based on an inter-event period and threshold flooding rate.