Report¶
Constructor and Properties¶
- class Report(rptfile)[source]¶
Base class for a SWMM simulation report file.
The report object provides an api for the tables in the the SWMM simulation report file. Tables are access as properties of the object and returned as pandas DataFrames.
- Parameters:
- rptfile: str
model report file path
- analysis_options¶
Pandas series containing the analysis options listed in the report file including units, models, methods, dates, time steps, etc.
- Returns:
- Series
Series of options.
- runoff_quantity_continuity¶
Runoff quantity continuity error table in volume and depth units. System wide error is show in percent.
- Returns:
- pd.DataFrame
DataFrame of runoff quantity continuity error table.
- runoff_quality_continuity¶
Runoff quality continuity error table in mass units for each pollutant. System wide error is show in percent.
- Returns:
- pd.DataFrame
DataFrame of runoff quality continuity error table
- groundwater_continuity¶
Groundwater quantity continuity error table in volume and depth units. System wide error is show in percent.
- Returns:
- pd.DataFrame
DataFrame of groundwater quantity continuity error table
- flow_routing_continuity¶
Flow routing continuity error table in volume units. System wide error is show in percent.
- Returns:
- pd.DataFrame
DataFrame of flow routing continuity error table
- quality_routing_continuity¶
Quality routing continuity error table in mass units. System wide error is show in percent.
- Returns:
- pd.DataFrame
DataFrame of quality routing continuity error table
- highest_continuity_errors¶
Highest continuity error table in percent. This table shows the model elements with the highest flow routing continuity error.
- Returns:
- pd.DataFrame
DataFrame of highest continuity errors table
- time_step_critical_elements¶
Time-step critical elements table in percent. This table shows the model elements that were controlling the model time step if a variable one was used.
- Returns:
- pd.DataFrame
DataFrame of time-step critical elements table
- highest_flow_instability_indexes¶
Highest flow instability indexes. This table shows the model elements that have the highest flow instability.
- Returns:
- pd.DataFrame
DataFrame of highest flow instability indexes table
- routing_time_step_summary¶
Routing time step summary table that shows the average, minimum, and maximum time steps as well as convergance summary.
- Returns:
- pd.DataFrame
DataFrame of routing time step summary table
- runoff_summary¶
Runoff summary table for each subcatchment that details rainfall, runon, evap, infil, and runoff.
- Returns:
- pd.DataFrame
DataFrame of subcatchment runoff summary table
- groundwater_summary¶
Groundwater summary table for each subcatchment that details groundwater inflow, outflow, moisture, and water table.
- Returns:
- pd.DataFrame
DataFrame of subcatchment groundwater summary table
- washoff_summary¶
Washoff summary table that details the total pollutant load that was washed off of each subcatchment.
- Returns:
- pd.DataFrame
DataFrame of subcatchment washoff summary table
- node_depth_summary¶
Node depth summary table that details the average and maximum depth and HGL simulated for each node.
- Returns:
- pd.DataFrame
DataFrame of node depth summary table
- node_inflow_summary¶
Node inflow summary table that details the maximum inflow rates, total inflow volumes, and flow balance error percent for each node.
- Returns:
- pd.DataFrame
DataFrame of node inflow summary table
- node_surchage_summary¶
Node surcharge summary that details the maximum surcharge level and duration of surharge for each node.
- Returns:
- pd.DataFrame
DataFrame of node surcharge summary table
- node_flooding_summary¶
Node flood summary that details the maximum ponded depth, peak flooding rate, total flood volume, total flood duration for each node.
- Returns:
- pd.DataFrame
DataFrame of node flooding summary table
- storage_volume_summary¶
Storage volume summary that details the frequency of filling, average and peak volumes, losses, and outfall rate for each storage unit.
- Returns:
- pd.DataFrame
DataFrame of storage volume summary table
- outfall_loading_summary¶
Outfall loading summary that details the flow frequency, average and peak flow rates, total outflow volume, and pollutant mass loads for each outfall.
- Returns:
- pd.DataFrame
DataFrame of outfall loading summary table
- link_flow_summary¶
Link flow summary that details the peak flow, velocity, depth, and capacity for each link.
- Returns:
- pd.DataFrame
DataFrame of link flow summary table
- flow_classification_summary¶
Flow classification summary that details the amount of conduit lengthening during the simualtion and the fraction of simulation time that is dry, subcritical, supercritical, or critical flow for each conduit.
- Returns:
- pd.DataFrame
DataFrame of flow classification summary table
- conduit_surcharge_summary¶
Conduit surcharge summary that details the hours of surcharging and capacity limited conditions.
- Returns:
- pd.DataFrame
DataFrame of conduit surcharge summary table
- pumping_summary¶
Pumping summary that details the utilization, peak flow rates, total flow volume, power usage, and time off pump curve for each pump.
- Returns:
- pd.DataFrame
DataFrame of pumping summary table
- link_pollutant_load_summary¶
Link pollutant load summary that details the total pollutant mass discharged from each link.
- Returns:
- pd.DataFrame
DataFrame of link pollutant load summary table
- analysis_begun¶
Date and time when the simulation was started
- Returns:
- Timestamp
Simulation start time
- Raises:
- Exception
if analysis begun text could not be found in the report file