swmmtoolbox.swmmtoolbox.listdetail

swmmtoolbox.swmmtoolbox.listdetail(filename, itemtype, name='', header='default')

List nodes and metadata in output file.

Parameters:

filename (str) – Filename of SWMM output file. The SWMM model must complete successfully for “swmmtoolbox” to correctly read it.

itemtypestr

One of ‘system’, ‘node’, ‘link’, or ‘pollutant’ to identify the type of data you want to extract.

namestr

[optional, default is ‘’]

Specific name to print only that entry. This can be looked up using ‘listvariables’.

tablefmtstr

[optional, default is ‘csv’, output format]

The table format. Can be one of ‘csv’, ‘tsv’, ‘plain’, ‘simple’, ‘grid’, ‘pipe’, ‘orgtbl’, ‘rst’, ‘mediawiki’, ‘latex’, ‘latex_raw’ and ‘latex_booktabs’.

headerstr

[optional, default is ‘default’, output format]

This is if you want a different header than is the default for this output table. Pass a list with string column names for each column in the table.