swmmx Documentation

Getter Patterns

Rendered from 11_all_get_functions.ipynb.

Common getter patterns

m.get.conduit.length()                         # all conduits, NumPy output
m.get.conduit.length(ids='C1')                  # one conduit, scalar output
m.get.conduit.length(ids=['C1', 'C2'])          # selected conduits
m.get.link.flow(ids=['C1', 'C2'], format='df')  # result time series after m.run()
m.get.weir.crest_height()                       # empty array if the model has no weirs