Skip to main content

SWMM5 calls from python

Project description

SWMM5 Python calling interface (c) Assela Pathirana Released under GNU GPL v.3

Installation:

Windows:

Use the SWMM5-x.y.z.k.win32.exe file downloaded from the respository for click and install.

Alternatively 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

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 convienience 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.0.021'
>>> st.SWMM5_VERSION            # same thing as an integer
50021
>>> 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-EXP.inp")
>>> wq.SWMM_Npolluts
1
>>> wq.Pollutants() # no pollutants in this file.
['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 + infiltration losses (in/hr or mm/hr)
   3 Runoff rate (flow units)
   4 Groundwater outflow rate (flow units)
   5 Groundwater water table elevation (ft or m)
>>> 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 + infiltration losses (in/hr or mm/hr)
   3 Runoff rate (flow units)
   4 Groundwater outflow rate (flow units)
   5 Groundwater water table elevation (ft or m)
   6 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
 0.03
 3.32
13.71
28.17
45.93
64.62
83.10
>>> 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
 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', 6)) # 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
 9.94
 9.99
10.00
10.00
10.00
13.45
14.11
14.71
15.24
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 x in f] # do they exist in the operating system.
[True, True, True]
>>> simtemp.clean()
>>> [isfile(x) for x in f] # do they exist in the operating system.
[True, False, False]

Thread Safety

Calling SWMM5Simulation with input file as only argument (SWMM5Simulation will choose the report and binary output file names) and subsequent use of the object to retreive results is threadsafe to the degree I could verify.

There is a test test_multithreading.py in the test directory, which can be run to test this to some degree. It should be run as python test_multithreading.py.

Legacy interface

Note:This is provided only for backward compatibility. Always use the new interface (above).

import swmm5 module

>>> from swmm5 import swmm5 as sw
>>>

run a sample network

>>> ret=sw.RunSwmmDll("./swmm5/examples/simple/swmm5Example.inp","swmm5Example.rpt","swmm5.dat")
>>>

should return 0 if everything is OK (according to to swmm convension)

>>> print ret
0
>>>

Now it is possible to retrive results. Open the swmm results file

>>> sw.OpenSwmmOutFile("swmm5.dat")
0
>>>

How many time steps are there?

>>> sw.cvar.SWMM_Nperiods
360
>>>

Let’s retrive rainfall in the system. Systems rainfall at fifth timestep

>>> ret,x=sw.GetSwmmResult(3,0,1,5)
>>> print '%.2f' % x
7.20
>>>

Acknowlegements

  • David Townshend
  • Tim Cera

Project details


Release history Release notifications

History Node

5.1.12

History Node

5.1.0.102

History Node

5.1.0.10

History Node

1.1.0.3

History Node

1.1.0.2

History Node

1.1.0.2dev

History Node

1.1.0.1dev

History Node

1.0.0.1

History Node

1.0.0.1dev

History Node

1.0.0.0dev

This version
History Node

0.4.1.0

History Node

0.4.1.0dev

History Node

0.4.0.0dev

History Node

0.3.3.0dev

History Node

0.3.2.0

History Node

0.3.1.0

History Node

0.3.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
SWMM5-0.4.1.0.win32-py2.7.exe (374.8 kB) Copy SHA256 hash SHA256 Windows Installer 2.7 Jan 16, 2013
SWMM5-0.4.1.0.zip (372.9 kB) Copy SHA256 hash SHA256 Source None Jan 16, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page