oopnet.report package¶
Submodules¶
oopnet.report.report module¶
- class oopnet.report.report.SimulationReport(filename, precision, startdatetime=None, reader=<function ReportFileReader>)¶
Bases:
objectClass for storing stimulation results.
- nodes¶
Node results
- links¶
Link results
- property demand: Series | DataFrame¶
Demands from the simulation report object.
- Returns:
Pandas Series containing the demands of the Nodes
- property diameter: Series | DataFrame¶
Diameters from the simulation report object.
- Returns:
Pandas Series containing the diameters of the Links
- property elevation: Series | DataFrame¶
Elevations from the simulation report object.
- Returns:
Pandas Series containing the elevations of the Nodes
- property ffactor: Series | DataFrame¶
Ffactors from the simulation report object.
- Returns:
Pandas Series containing the ffactors of the Links
- property flow: Series | DataFrame¶
Flows from the simulation report object.
- Returns:
Pandas Series containing the flows of the Links
- get_link_info(id)¶
Gets the Link information from a simulation report object.
- Parameters:
id (
str) – Link ID- Return type:
Series- Returns:
Pandas Series containing the information of the links
- get_node_info(id)¶
Gets the Node information from a simulation report object.
- Parameters:
id (
str) – Node ID- Return type:
Series- Returns:
Pandas Series containing the information of the specified Node
- property head: Series | DataFrame¶
Heads from the simulation report object.
- Returns:
Pandas Series containing the heads of the Nodes
- property headloss: Series | DataFrame¶
Headlosses from the simulation report object.
WARNING: If one wants to work with headloss, then the length reportparameter has to be set to ‘YES’ in the Network’s Reportparameter settings.
- Returns:
Pandas Series containing the headlosses of the Links
- property headlossper1000m: Series | DataFrame¶
Headlosses from the simulation report object as it is in the report (units in headloss per 1000m)
- Returns:
Pandas Series containing the headlosses of the Links
- property length: Series | DataFrame¶
Lengths from the simulation report object.
- Returns:
Pandas Series containing the lengths of the Links
- links:
DataArray¶
- nodes:
DataArray¶
- property position: Series | DataFrame¶
Positions from the simulation report object.
- Returns:
Pandas Series containing the positions of the Links
- property pressure: Series | DataFrame¶
Pressures from the simulation report object.
- Returns:
Pandas Series containing the pressures of the Nodes
- property quality: Series | DataFrame¶
Qualities from the simulation report object.
- Returns:
Pandas Series containing the qualities of the Nodes
- property reaction: Series | DataFrame¶
Reactions from the simulation report object.
- Returns:
Pandas Series containing the reactions of the Links
- property settings¶
Settings from the simulation report object.
- Returns:
Pandas Series containing the settings of the Links
- property velocity: Series | DataFrame¶
Velocities from the simulation report object.
- Returns:
Pandas Series containing the velocities of the Links