swmmtoolbox.swmmtoolbox.catalog

swmmtoolbox.swmmtoolbox.catalog(filename, itemtype='')

List the catalog of objects in output file.

This catalog list is all of the labels that can be used in the extract routine.

Parameters:

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

• itemtype (str) – One of ‘system’, ‘node’, ‘link’, or ‘pollutant’ to identify the type of data you want to extract.

• tablefmt (str) –

  [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’.

• header (str) –

  [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.