Skip to main content
Back to top
Ctrl
+
K
Overview
Installing
Quick Start
Reference
Examples
More
Authors
How to Cite
GitHub
PyPI
YouTube
LinkedIn
Overview
Installing
Quick Start
Reference
Examples
More
Authors
How to Cite
GitHub
PyPI
YouTube
LinkedIn
Section Navigation
Introduction
Simulation Module
Simulation
Simulation.add_after_close
Simulation.add_after_end
Simulation.add_after_start
Simulation.add_after_step
Simulation.add_before_end
Simulation.add_before_start
Simulation.add_before_step
Simulation.close
Simulation.execute
Simulation.initial_conditions
Simulation.report
Simulation.save_hotstart
Simulation.start
Simulation.step_advance
Simulation.terminate_simulation
Simulation.use_hotstart
Simulation.current_time
Simulation.end_time
Simulation.engine_version
Simulation.flow_routing_error
Simulation.flow_units
Simulation.percent_complete
Simulation.quality_error
Simulation.report_start
Simulation.runoff_error
Simulation.sim_is_open
Simulation.sim_is_started
Simulation.start_time
Simulation.system_units
SimulationPreConfig
SimulationPreConfig.add_update_by_token
SimulationPreConfig.apply_changes
SimulationPreConfig.filename_suffix
SimulationPreConfig.input_file
Nodes Module
Nodes
Node
Node.generated_inflow
Node.is_divider
Node.is_junction
Node.is_outfall
Node.is_storage
Node.cumulative_inflow
Node.depth
Node.flooding
Node.full_depth
Node.head
Node.hydraulic_retention_time
Node.inflow_quality
Node.initial_depth
Node.invert_elevation
Node.lateral_inflow
Node.losses
Node.nodeid
Node.pollut_quality
Node.ponding_area
Node.reactor_quality
Node.statistics
Node.surcharge_depth
Node.total_inflow
Node.total_outflow
Node.volume
Outfall
Outfall.generated_inflow
Outfall.is_divider
Outfall.is_junction
Outfall.is_outfall
Outfall.is_storage
Outfall.outfall_stage
Outfall.cumulative_inflow
Outfall.depth
Outfall.flooding
Outfall.full_depth
Outfall.head
Outfall.hydraulic_retention_time
Outfall.inflow_quality
Outfall.initial_depth
Outfall.invert_elevation
Outfall.lateral_inflow
Outfall.losses
Outfall.nodeid
Outfall.outfall_statistics
Outfall.pollut_quality
Outfall.ponding_area
Outfall.reactor_quality
Outfall.statistics
Outfall.surcharge_depth
Outfall.total_inflow
Outfall.total_outflow
Outfall.volume
Storage
Storage.generated_inflow
Storage.is_divider
Storage.is_junction
Storage.is_outfall
Storage.is_storage
Storage.cumulative_inflow
Storage.depth
Storage.flooding
Storage.full_depth
Storage.head
Storage.hydraulic_retention_time
Storage.inflow_quality
Storage.initial_depth
Storage.invert_elevation
Storage.lateral_inflow
Storage.losses
Storage.nodeid
Storage.pollut_quality
Storage.ponding_area
Storage.reactor_quality
Storage.statistics
Storage.storage_statistics
Storage.surcharge_depth
Storage.total_inflow
Storage.total_outflow
Storage.volume
Links Module
Links
Link
Link.is_conduit
Link.is_orifice
Link.is_outlet
Link.is_pump
Link.is_weir
Link.average_head_loss
Link.connections
Link.current_setting
Link.depth
Link.ds_xsection_area
Link.flow
Link.flow_limit
Link.froude
Link.initial_flow
Link.inlet_head_loss
Link.inlet_node
Link.inlet_offset
Link.linkid
Link.outlet_head_loss
Link.outlet_node
Link.outlet_offset
Link.pollut_quality
Link.reactor_quality
Link.seepage_rate
Link.target_setting
Link.total_loading
Link.ups_xsection_area
Link.volume
Conduit
Conduit.is_conduit
Conduit.is_orifice
Conduit.is_outlet
Conduit.is_pump
Conduit.is_weir
Conduit.average_head_loss
Conduit.conduit_statistics
Conduit.connections
Conduit.current_setting
Conduit.depth
Conduit.ds_xsection_area
Conduit.flow
Conduit.flow_limit
Conduit.froude
Conduit.initial_flow
Conduit.inlet_head_loss
Conduit.inlet_node
Conduit.inlet_offset
Conduit.linkid
Conduit.outlet_head_loss
Conduit.outlet_node
Conduit.outlet_offset
Conduit.pollut_quality
Conduit.reactor_quality
Conduit.seepage_rate
Conduit.target_setting
Conduit.total_loading
Conduit.ups_xsection_area
Conduit.volume
Pump
Pump.is_conduit
Pump.is_orifice
Pump.is_outlet
Pump.is_pump
Pump.is_weir
Pump.average_head_loss
Pump.connections
Pump.current_setting
Pump.depth
Pump.ds_xsection_area
Pump.flow
Pump.flow_limit
Pump.froude
Pump.initial_flow
Pump.inlet_head_loss
Pump.inlet_node
Pump.inlet_offset
Pump.linkid
Pump.outlet_head_loss
Pump.outlet_node
Pump.outlet_offset
Pump.pollut_quality
Pump.pump_statistics
Pump.reactor_quality
Pump.seepage_rate
Pump.target_setting
Pump.total_loading
Pump.ups_xsection_area
Pump.volume
Subcatchments Module
Subcatchments
Subcatchment
Subcatchment.area
Subcatchment.buildup
Subcatchment.conc_ponded
Subcatchment.connection
Subcatchment.curb_length
Subcatchment.evaporation_loss
Subcatchment.infiltration_loss
Subcatchment.percent_impervious
Subcatchment.pollut_quality
Subcatchment.rainfall
Subcatchment.runoff
Subcatchment.runoff_total_loading
Subcatchment.runon
Subcatchment.slope
Subcatchment.snow_depth
Subcatchment.statistics
Subcatchment.subcatchmentid
Subcatchment.width
LidGroups
LidGroup
LidGroup.flow_to_pervious
LidGroup.new_drain_flow
LidGroup.old_drain_flow
LidGroup.pervious_area
LidUnit
LidUnit.drain_node
LidUnit.drain_subcatchment
LidUnit.dry_time
LidUnit.evaporation
LidUnit.from_impervious
LidUnit.from_pervious
LidUnit.full_width
LidUnit.index
LidUnit.initial_saturation
LidUnit.lid_control
LidUnit.native_infiltration
LidUnit.new_drain_flow
LidUnit.number
LidUnit.old_drain_flow
LidUnit.subcatchment
LidUnit.to_pervious
LidUnit.unit_area
Surface
Surface.depth
Surface.evaporation
Surface.flux_rate
Surface.infiltration
Surface.inflow
Surface.outflow
Pavement
Pavement.depth
Pavement.evaporation
Pavement.flux_rate
Pavement.percolation
Storage
Storage.depth
Storage.drain
Storage.evaporation
Storage.exfiltration
Storage.flux_rate
Storage.inflow
Soil
Soil.evaporation
Soil.flux_rate
Soil.moisture
Soil.percolation
WaterBalance
WaterBalance.drain_flow
WaterBalance.evaporation
WaterBalance.final_volume
WaterBalance.infiltration
WaterBalance.inflow
WaterBalance.initial_volume
WaterBalance.surface_flow
Raingages Module
RainGages
RainGage
RainGage.rainfall
RainGage.raingageid
RainGage.snowfall
RainGage.total_precip
System Module
Low-Impact Development (LID)
LidControls
LidControl
LidControl.can_overflow
Surface
Surface.alpha
Surface.roughness
Surface.side_slope
Surface.slope
Surface.thickness
Surface.void_fraction
Soil
Soil.field_capacity
Soil.k_saturated
Soil.k_slope
Soil.porosity
Soil.suction_head
Soil.thickness
Soil.wilting_point
Storage
Storage.clog_factor
Storage.k_saturated
Storage.thickness
Storage.void_fraction
Pavement
Pavement.clog_factor
Pavement.impervious_fraction
Pavement.k_saturated
Pavement.regeneration
Pavement.regeneration_degree
Pavement.thickness
Pavement.void_fraction
Drain
Drain.close_head
Drain.coefficient
Drain.delay
Drain.exponent
Drain.offset
Drain.open_head
DrainMat
DrainMat.alpha
DrainMat.roughness
DrainMat.thickness
DrainMat.void_fraction
Output Module
Output
Output.close
Output.link_attribute
Output.link_result
Output.link_series
Output.node_attribute
Output.node_result
Output.node_series
Output.object_name
Output.open
Output.subcatch_attribute
Output.subcatch_result
Output.subcatch_series
Output.system_result
Output.system_series
Output.verify_index
Output.verify_time
Output.links
Output.nodes
Output.pollutants
Output.project_size
Output.subcatchments
Output.times
Output.units
Output.version
SubcatchSeries
SubcatchSeries.rainfall
SubcatchSeries.snow_depth
SubcatchSeries.evap_loss
SubcatchSeries.infil_loss
SubcatchSeries.runoff_rate
SubcatchSeries.gw_outflow_rate
SubcatchSeries.gw_table_elev
SubcatchSeries.soil_moisture
SubcatchSeries.pollut_conc_0
NodeSeries
NodeSeries.invert_depth
NodeSeries.hydraulic_head
NodeSeries.ponded_volume
NodeSeries.lateral_inflow
NodeSeries.total_inflow
NodeSeries.flooding_losses
NodeSeries.pollut_conc_0
LinkSeries
LinkSeries.flow_rate
LinkSeries.flow_depth
LinkSeries.flow_velocity
LinkSeries.flow_volume
LinkSeries.capacity
LinkSeries.pollut_conc_0
SystemSeries
SystemSeries.air_temp
SystemSeries.rainfall
SystemSeries.snow_depth
SystemSeries.evap_infil_loss
SystemSeries.runoff_flow
SystemSeries.dry_weather_inflow
SystemSeries.gw_inflow
SystemSeries.rdii_inflow
SystemSeries.direct_inflow
SystemSeries.total_lateral_inflow
SystemSeries.flood_losses
SystemSeries.outfall_flows
SystemSeries.volume_stored
SystemSeries.evap_rate
SystemSeries.ptnl_evap_rate
License
Reference
Raingages Module
Raingages Module
#
RainGages
Rain Gages Iterator Methods.
RainGage
Raingage Methods.
Show Source
