SWMM5 Python calling interface
(c) Assela Pathirana
Released under GNU GPL v.3
Release History:
----------------
version 1.0.0.1 first production (non-beta) release.
version 1.1.0.1 version with new SWMM 5.1 version (instead of SWMM 5.0)
Installation:
-------------
:Windows:
As of version 1.0.0.1 SWMM5 is verified to work with Python 3 as well.
Now (as of version 1.0.0.1) the package is provided as python Wheel too. This means for windows the following command should install SWMM5
::
pip install SWMM5
Alternatively, use the SWMM5-x.y.z.k.win32.exe file downloaded from the repository for click and install.
If you have your own C compilers, then SWMM5-x.y.z.k.zip can be used to install as
::
python setup.py install
:Linux:
Download SWMM5-x.y.z.k.zip can be used to install as
::
python setup.py install
Or, just with,
::
pip install SWMM5
Usage:
------
:New Interface:
One should always use the new interface. The old interface (below) is left only for backward compatibility. The key features of new interface are
* More pythonic interface
* A number of convenience functions
Import new interface and run SWMM
::
>>> from swmm5.swmm5tools import SWMM5Simulation
>>> st=SWMM5Simulation("swmm5/examples/simple/swmm5Example.inp")
:Example 1: Retrive simulation properties.
::
>>> st.SWMM5_Version() # Version of underlying SWMM5 engine.
'5.1.000'
>>> st.SWMM5_VERSION # same thing as an integer
51000
>>> st.Flow_Units() # Flow units.
'LPS'
>>> st.SWMM_FlowUnits # returns flow units as an index. 0 = CFS, 1 = GPM, 2 = MGD, 3 = CMS, 4 = LPS, and 5 = LPD
4
>>> st.SWMM_Nperiods # number of reporting periods
360
>>> st.SWMM_Nsubcatch # number of subcatchments
6
>>> st.SWMM_Nnodes # number of drainage system nodes
12
>>> st.SWMM_Nlinks # number of drainage system links
11
>>> st.SWMM_Npolluts # number of pollutants tracked
0
>>> print ("%.2f"%st.SWMM_StartDate) # start date of simulation
40844.00
>>> st.SWMM_ReportStep
60
>>>
:Example 2: Prints available entities
::
>>> st.entityList()
['SUBCATCH', 'NODE', 'LINK', 'SYS']
>>> st.Subcatch()
['A2', 'A1', 'A3', 'A4', 'A5', 'E1']
>>> st.Node()
['J1', 'J2', 'J3', 'J4', 'J5', 'J6', 'J7', 'J8', 'J9', 'J10', 'J11', 'J12']
>>> st.Link()
['T4-1', 'T4-2', 'T4-3', 'T1-1', 'T1-2', 'T2-1', 'T2-2', 'T2-3', 'T3-1', 'T3-2', 'T5']
>>> st.Sys()
['SYS']
>>> st.Pollutants() # no pollutants in this file.
[]
>>> wq=SWMM5Simulation("swmm5/examples/waterquality/Example5-EXP5.1.inp")
>>> wq.SWMM_Npolluts
1
>>> wq.Pollutants() # TSS in this case.
['TSS']
>>> lst=st.varList("SUBCATCH")
>>> print ("\n".join( "%4i %s"% (i,v) for i,v in enumerate(lst))) # print in a column with index.
0 Rainfall (in/hr or mm/hr)
1 Snow depth (in or mm)
2 Evaporation loss (in/hr or mm/hr)
3 Infiltration loss (in/hr or mm/hr)
4 Runoff rate (flow units)
5 Groundwater outflow rate (flow units)
6 Groundwater water table elevation (ft or m)
7 Soil Moisture (volumetric fraction, less or equal tosoil porosity)
>>> lst=wq.varList("SUBCATCH") # for the network that has pollutants.
>>> print ("\n".join( "%4i %s"% (i,v) for i,v in enumerate(lst))) # print in a column with index.
0 Rainfall (in/hr or mm/hr)
1 Snow depth (in or mm)
2 Evaporation loss (in/hr or mm/hr)
3 Infiltration loss (in/hr or mm/hr)
4 Runoff rate (flow units)
5 Groundwater outflow rate (flow units)
6 Groundwater water table elevation (ft or m)
7 Soil Moisture (volumetric fraction, less or equal tosoil porosity)
8 Runoff concentration of TSS (mg/l)
>>> lst=wq.varList("NODE")
>>> print ("\n".join( "%4i %s"% (i,v) for i,v in enumerate(lst))) # print in a column with index.
0 Depth of water above invert (ft or m)
1 Hydraulic head (ft or m)
2 Volume of stored + ponded water (ft3 or m3)
3 Lateral inflow (flow units)
4 Total inflow (lateral + upstream) (flow units)
5 Flow lost to flooding (flow units)
6 Concentration of TSS (mg/l)
>>> lst=wq.varList("LINK")
>>> print ("\n".join( "%4i %s"% (i,v) for i,v in enumerate(lst))) # print in a column with index.
0 Flow rate (flow units)
1 Flow depth (ft or m)
2 Flow velocity (ft/s or m/s)
3 Froude number
4 Capacity (fraction of conduit filled)
5 Concentration of TSS (mg/l)
>>> lst=wq.varList("SYS")
>>> print ("\n".join( "%4i %s"% (i,v) for i,v in enumerate(lst))) # print in a column with index.
0 Air temperature (deg. F or deg. C)
1 Rainfall (in/hr or mm/hr)
2 Snow depth (in or mm)
3 Evaporation + infiltration loss rate (in/hr or mm/hr)
4 Runoff flow (flow units)
5 Dry weather inflow (flow units)
6 Groundwater inflow (flow units)
7 RDII inflow (flow units)
8 User supplied direct inflow (flow units)
9 Total lateral inflow (sum of variables 4 to 8) (flow units)
10 Flow lost to flooding (flow units)
11 Flow leaving through outfalls (flow units)
12 Volume of stored water (ft3 or m3)
13 Evaporation rate (in/day or mm/day)
:Example 3: Results
::
>>> r=list(st.Results('NODE','J1', 4)) # total inflow into node "J1". The Results function returns a generator. We convert it to a list.
>>> print ("\n".join( "%5.2f"% (i) for i in r[0:10])) # Lets print the first 10 items.
0.00
0.00
0.00
3.21
13.50
27.90
45.63
64.32
82.79
101.84
>>> r=st.Results('SYS','SYS', 1) #1 Rainfall (in/hr or mm/hr). This time we use the generator directly.
>>> print ("\n".join(["%5.2f"% (i) for i in r])) #doctest: +ELLIPSIS
0.00
0.00
7.20
7.20
7.20
7.60
7.60
7.60
8.00
...
0.00
:Example 4: Pollutant Concentration
::
>>> wq.Subcatch()
['S1', 'S2', 'S3', 'S4', 'S5', 'S6', 'S7']
>>> r=list(wq.Results('SUBCATCH','S3', 8)) # TSS out of catchment 'S3'. We convert it to a list.
>>> print ("\n".join( "%5.2f"% (i) for i in r[0:10])) # Lets print the first 10 items. #doctest.NORMALIZE_WHITESPACE
0.00
0.00
0.00
0.00
0.00
13.45
14.11
14.71
15.24
15.70
::
>>> wq.Node()
['J1', 'J2', 'J3', 'J4', 'J5', 'J6', 'J7', 'J8', 'J9', 'J10', 'J11', 'O1']
>>> r=list(wq.Results('NODE','J3', 6)) # TSS out of Node 'J3'. We convert it to a list.
>>> print ("\n".join( "%5.2f"% (i) for i in r[0:10])) # Lets print the first 10 items.
0.00
0.00
0.00
0.00
0.00
13.26
14.10
14.70
15.23
15.69
>>> wq.Link()
['C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', 'C10', 'C11']
>>> r=list(wq.Results('LINK','C11', 5)) # TSS out of Link 'C11'. We convert it to a list.
>>> print ("\n".join( "%5.2f"% (i) for i in r)) # Lets print the first 10 items. #doctest: +ELLIPSIS
0.00
0.00
0.00
0.00
0.00
0.00
0.00
5.42
9.96
12.76
14.77
16.43
17.91
19.27
20.56
...
44.65
:Example 5: Tracking output files
::
>>> simtemp=SWMM5Simulation("swmm5/examples/simple/swmm5Example.inp")
>>> f=simtemp.getFiles()
>>> f #doctest: +ELLIPSIS
['swmm5/examples/simple/swmm5Example.inp', '...swmm5Example....rpt', '...swmm5Example....dat']
>>> from os.path import isfile
>>> [isfile(x) for
SWMM5-5.1.15.tar.gz （91个子文件） 
SWMM5-5.1.15 
MANIFEST.in 92B PKG-INFO 13KB
README.txt 9KB SWMM5.egg-info PKG-INFO 13KB SOURCES.txt 3KB top_level.txt 13B dependency_links.txt 1B swmm5 tmp.py 106B swmm5 output.c 32KB text.h 16KB mathexpr.c 17KB infil.c 32KB inflow.c 17KB hash.h 601B funcs.h 23KB xsect.c 80KB infil.h 4KB routing.c 28KB exfil.h 1KB main.c 3KB culvert.c 15KB landuse.c 25KB swmm5.c 28KB macros.h 2KB rdii.c 48KB swmm5.h 1KB node.c 42KB massbal.c 36KB exfil.c 8KB hash.c 3KB surfqual.c 18KB forcmain.c 5KB lid.h 10KB odesolve.h 548B transect.c 19KB report.c 50KB odesolve.c 7KB mempool.c 4KB inputrpt.c 12KB stats.c 30KB gwater.c 31KB lid.c 74KB error.c 12KB xsect.dat 21KB dwflow.c 26KB shape.c 11KB datetime.h 2KB controls.c 36KB project.c 42KB table.c 25KB statsrpt.c 37KB objects.h 43KB hotstart.c 16KB subcatch.c 42KB mempool.h 624B flowrout.c 25KB rain.c 37KB enums.h 21KB toposort.c 17KB lidproc.c 58KB dynwave.c 31KB mathexpr.h 1KB error.h 6KB iface.c 20KB keywords.h 2KB runoff.c 18KB gage.c 19KB climate.c 48KB link.c 83KB consts.h 4KB findroot.c 4KB kinwave.c 9KB input.c 26KB treatmnt.c 14KB qualrout.c 16KB roadway.c 7KB keywords.c 9KB findroot.h 623B globals.h 9KB headers.h 642B snow.c 29KB datetime.c 15KB swmm5.py 13KB swmm5_interface.c 10KB __init__.py 2B examples simple swmm5Example.inp 19KB swmm5_interface.h 1KB swmm5_wrap.c 184KB swmm5tools.py 7KB setup.cfg 42B setup.py 4KB
评论0