Is it posssible to report the Tag value of a node or link?

[bowguy]

I have a SWMM model with the Tag field populated for several links. Is it possible to report/include that value in the data frame?
i.e.:
conduits = swmmio.elements.Links(
simulation_info,
inp_sections=['conduits','outlets'],
rpt_sections=['Link Flow Summary']
,columns=['MaxDPerc','MaxQ', 'MaxQPerc','MaxV','MaxDay','MaxHr','InletNode','OutletNode','Type','Tag', 'coords']
)
The tag field would allow me finer control of display properties of a model.

[bemcdonnell]

@aerispaha - any thoughts?

[aerispaha]

Hey @bowguy, what you're trying to do makes a lot of sense. I could see this being useful in several situations.

Currently, the swmmio.elements.Links object won't do this out of the box for us though. The main reason is the quirk in the [TAGS] section of the INP file in which the first column stores the Element Type (e.g. Link, Node). However, there is a fairly painless work around to achieve what I think you're after. We can join the [TAGS] dataframe after creating Links dataframe. I'll use the streets example model to demonstrate what I mean:

import swmmio
from swmmio.examples import streets

# get a dataframe of tags using the inp object
tags = streets.inp.tags

# to make this easy to join to a Links dataframe, set the index to the Name column
tags = tags.set_index('Name')
tags

Name	Tag
C5	Swale
C6	Swale
...	...
C11	Culvert
C_Aux3	Swale

# create a Links dataframe with the columns we're interested in. 
# keeping things simple here for demonstration purposes
links = swmmio.elements.Links(
    model=streets,
    inp_sections=['conduits', 'outlets'],
    columns=['InletNode', 'OutletNode']
)

# join the tags dataframe to the links dataframe
links.dataframe.join(tags)

Name	InletNode	OutletNode	Tag
Street1	Aux1	Aux2	Full_Street
Street2	Aux2	Aux4	Full_Street
Street3	Aux4	Aux5	Full_Street
Street4	Aux5	Aux6	Half_Street
Street5	Aux6	Aux7	Half_Street
C3	J3	J4	Culvert
C4	J4	J5	Swale
C5	J5	J6	Swale
...	...	...	...
C11	J11	O1	Culvert

Does that do the trick for you for now?

In the future, we might consider including tags in the nodes and links dataframe more easily or be default.

[bowguy]

This looks like it would work for me. Let me test it.
Thanks!

[aerispaha]

Cool! if that works for you, please mark my comment as the answer.

[bemcdonnell]

@aerispaha We're competing for up gets the most answers right, right? What is the prize? haha Free trip to Cancun?

[bowguy]

This works! Note I needed to get back to a geojson file so from my question above it becomes:

tags = swmmio.core.inp(sim_file).tags
tags = tags.set_index('Name')

conduits = swmmio.elements.Links(
simulation_info,
inp_sections=['conduits','outlets'],
rpt_sections=['Link Flow Summary']
,columns=['MaxDPerc','MaxQ', 'MaxQPerc','MaxV','MaxDay','MaxHr','InletNode','OutletNode','Type', 'coords']
)

conduits = conduits.dataframe.join(tags)

geojson = write_geojson(conduits, geomtype='linestring')