def as_text(self, project):
derived_sections = {}
quality_text = QualityWriter.as_text(project)
if quality_text:
derived_sections[QualityWriter.SECTION_NAME] = quality_text
coordinates = SectionAsList("[COORDINATES]")
coordinates.value = project.all_nodes()
coord_comment = ";Node \tX-Coord \tY-Coord"
if project.map.crs_name:
coord_crs_comment = ";CRS=" + project.map.crs_name
if project.map.crs_unit:
coord_crs_comment = coord_crs_comment + "|CRS_UNIT=" + project.map.crs_unit
if coord_crs_comment:
coord_comment = coord_crs_comment + "\n" + coord_comment
coordinates_writer = SectionWriterAsList("[COORDINATES]", CoordinateWriter, coord_comment)
coordinates_text = coordinates_writer.as_text(coordinates)
if coordinates_text:
derived_sections[coordinates_writer.SECTION_NAME] = coordinates_text
vertices = SectionAsList("[VERTICES]")
vertices.value = project.all_vertices(True)
vertices_writer = SectionWriterAsList("[VERTICES]", CoordinateWriter,
";Link \tX-Coord \tY-Coord")
vertices_text = vertices_writer.as_text(vertices)
if vertices_text:
derived_sections[vertices_writer.SECTION_NAME] = vertices_text
tags_text = TagsWriter.as_text(project)
if tags_text:
derived_sections[TagsWriter.SECTION_NAME] = tags_text
mixing = SectionAsList('[MIXING]')
mixing.value = project.tanks.value
mixing_text = self.write_mixing.as_text(mixing)
if mixing_text:
derived_sections[mixing.SECTION_NAME] = mixing_text
emitters = SectionAsList('[EMITTERS]')
emitters.value = project.junctions.value
emitters_text = self.write_emitters.as_text(emitters)
if emitters_text:
derived_sections[emitters.SECTION_NAME] = emitters_text
status = SectionAsList('[STATUS]')
status.value = project.all_links()
status_text = self.write_status.as_text(status)
if status_text:
derived_sections[status.SECTION_NAME] = status_text
inp = InputFileWriterBase.as_text(self, project, derived_sections)
inp += '\n' + '[END]' + '\n'
return inp
def as_text(self, project):
inp = InputFileWriterBase.as_text(self, project)
quality_text = QualityWriter.as_text(project)
if quality_text:
inp += '\n' + quality_text + '\n'
coordinates = SectionAsList("[COORDINATES]")
coordinates.value = project.all_nodes()
coordinates_writer = SectionWriterAsList("[COORDINATES]", CoordinateWriter,
";Node \tX-Coord \tY-Coord")
coordinates_text = coordinates_writer.as_text(coordinates)
if coordinates_text:
inp += '\n' + coordinates_text + '\n'
vertices = SectionAsList("[VERTICES]")
vertices.value = project.all_vertices(True)
vertices_writer = SectionWriterAsList("[VERTICES]", CoordinateWriter,
";Link \tX-Coord \tY-Coord")
vertices_text = vertices_writer.as_text(vertices)
if vertices_text:
inp += '\n' + vertices_text + '\n'
tags_text = TagsWriter.as_text(project)
if tags_text:
inp += '\n' + tags_text + '\n'
mixing = SectionAsList('[MIXING]')
mixing.value = project.tanks.value
mixing_text = self.write_mixing.as_text(mixing)
if mixing_text:
inp += '\n' + mixing_text + '\n'
emitters = SectionAsList('[EMITTERS]')
emitters.value = project.junctions.value
emitters_text = self.write_emitters.as_text(emitters)
if emitters_text:
inp += '\n' + emitters_text + '\n'
inp += '\n' + '[END]' + '\n'
return inp
def __init__(self):
"""Define the fields of a SWMM Project by creating an empty placeholder for each section"""
self.write_title = TitleWriter() # TITLE project title
self.write_options = GeneralWriter() # OPTIONS analysis options
self.write_report = ReportWriter(
) # REPORT output reporting instructions
self.write_files = SectionWriter(
) # FILES interface file options
self.write_files.SECTION_NAME = "[FILES]"
self.write_files.section_type = Files
self.write_backdrop = BackdropOptionsWriter(
) # BACKDROP bounding rectangle and file name of backdrop image
self.write_map = MapOptionsWriter(
) # MAP map's bounding rectangle and units
self.write_raingages = SectionWriterAsList(
"[RAINGAGES]", RainGageWriter,
";;Name \tFormat \tInterval\tSCF \tSource \n"
";;--------------\t---------\t--------\t--------\t----------")
self.write_hydrographs = SectionWriterAsList(
"[HYDROGRAPHS]", UnitHydrographWriter,
";;Hydrograph \tRain Gage/Month \tResponse\tR \tT \tK \tDmax \tDrecov \tDinit \n"
";;--------------\t----------------\t--------\t--------\t--------\t--------\t--------\t--------\t--------"
)
# unit hydrograph data used to construct RDII inflows
self.write_evaporation = EvaporationWriter(
) # EVAPORATION evaporation data
self.write_temperature = TemperatureWriter(
) # TEMPERATURE air temperature and snow melt data
self.write_adjustments = AdjustmentsWriter(
) # ADJUSTMENTS monthly climate adjustments
self.write_subcatchments = SectionWriterAsList(
"[SUBCATCHMENTS]", SubcatchmentWriter,
";;Name \tRain Gage \tOutlet \tArea \t%Imperv \tWidth \t%Slope \tCurbLen \tSnowPack \n"
";;--------------\t----------------\t----------------\t--------\t--------\t--------\t--------\t--------\t----------------"
)
# basic subcatchment information
self.write_subareas = SectionWriterAsList(
"[SUBAREAS]", SubareaWriter,
";;Subcatchment \tN-Imperv \tN-Perv \tS-Imperv \tS-Perv \tPctZero \tRouteTo \tPctRouted\n"
";;--------------\t----------\t------------\t--------\t----------\t----------\t----------\t---------"
)
# subcatchment impervious/pervious sub-area data
#self.write_infiltration = SectionWriterAsListOf("[INFILTRATION]", SectionWriter, None)
# write_infiltration is set in as_text based on the kind of infiltration being used in the project.
self.write_lid_controls = SectionWriterAsList(
"[LID_CONTROLS]", LIDControlWriter,
";;Name \tType/Layer\tParameters\n"
";;--------------\t----------\t----------")
# low impact development control information
self.write_lid_usage = SectionWriterAsList(
"[LID_USAGE]", LIDUsageWriter,
";;Subcatchment \tLID Process \tNumber \tArea \tWidth \tInitSat \tFromImp \tToPerv \tRptFile \tDrainTo\n"
";;--------------\t----------------\t-------\t----------\t----------\t----------\t----------\t----------\t------------------------\t----------------"
)
# assignment of LID controls to subcatchments
self.write_aquifers = SectionWriterAsList(
"[AQUIFERS]", AquiferWriter,
";;Aquifer \tPhi \tWP \tFC \tHydCon\tKslope\tTslope\tUEF \tLED \tLGLR \tBEL \tWTEL \tUZM \tUEF Pat\n"
";;--------------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t-------"
)
# groundwater aquifer parameters
self.write_groundwater = SectionWriterAsList(
"[GROUNDWATER]", GroundwaterWriter,
";;Subcatchment \tAquifer \tNode \tEsurf \tA1 \tB1 \tA2 \tB2 \tA3 \tDsw \tEgwt \tEbot \tWgr \tUmc \n"
";;--------------\t----------------\t----------------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------"
)
# subcatchment groundwater parameters
self.write_snowpacks = SectionWriterAsList(
"[SNOWPACKS]", SnowPackWriter,
";;Name \tSurface \tParameters\n"
";;--------------\t----------\t----------")
# subcatchment snow pack parameters
self.write_junctions = SectionWriterAsList(
"[JUNCTIONS]", JunctionWriter,
";;Name \tElevation \tMaxDepth \tInitDepth \tSurDepth \tAponded\n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
# junction node information
self.write_outfalls = SectionWriterAsList(
"[OUTFALLS]", OutfallWriter,
";;Name \tElevation \tType \tStage Data \tGated \tRoute To\n"
";;--------------\t----------\t----------\t----------------\t--------\t----------------"
)
# outfall node information
self.write_dividers = SectionWriterAsList(
"[DIVIDERS]", DividerWriter,
";;Name \tElevation \tDiverted Link \tType \tParameters\n"
";;--------------\t----------\t----------------\t----------\t----------"
)
# flow divider node information
self.write_storage = SectionWriterAsList(
"[STORAGE]", StorageWriter,
";;Name \tElev. \tMaxDepth \tInitDepth \tShape \tCurve Name/Params \tN/A-Pond\tFevap \tPsi \tKsat \tIMD\n"
";;--------------\t--------\t----------\t-----------\t----------\t----------------------------\t--------\t--------\t--------\t--------\t--------"
)
# storage node information
self.write_conduits = SectionWriterAsList(
"[CONDUITS]", ConduitWriter,
";;Name \tFrom Node \tTo Node \tLength \tRoughness \tInOffset \tOutOffset \tInitFlow \tMaxFlow\n"
";;--------------\t----------------\t----------------\t----------\t----------\t----------\t----------\t----------\t----------"
)
# conduit link information
self.write_pumps = SectionWriterAsList(
"[PUMPS]", PumpWriter,
";;Name \tFrom Node \tTo Node \tPump Curve \tStatus \tStartup \tShutoffn"
";;--------------\t----------------\t----------------\t----------------\t--------\t--------\t--------"
)
# pump link information
self.write_orifices = SectionWriterAsList(
"[ORIFICES]", OrificeWriter,
";;Name \tFrom Node \tTo Node \tType \tOffset \tQcoeff \tGated \tCloseTime\n"
";;--------------\t----------------\t----------------\t------------\t----------\t----------\t--------\t----------"
)
# orifice link information
self.write_weirs = SectionWriterAsList(
"[WEIRS]", WeirWriter,
";;Name \tFrom Node \tTo Node \tType \tCrestHt \tQcoeff \tGated \tEndCon \tEndCoeff \tSurcharge \tRoadWidth \tRoadSurf\n"
";;--------------\t----------------\t----------------\t------------\t----------\t----------\t--------\t--------\t----------\t----------\t----------\t----------"
)
# weir link information
self.write_outlets = SectionWriterAsList(
"[OUTLETS]", OutletWriter,
";;Name \tFrom Node \tTo Node \tOffset \tType \tQTable/Qcoeff \tQexpon \tGated\n"
";;--------------\t----------------\t----------------\t----------\t---------------\t----------------\t----------\t--------"
)
# outlet link information
self.write_xsections = SectionWriterAsList(
"[XSECTIONS]", CrossSectionWriter,
";;Link \tShape \tGeom1 \tGeom2 \tGeom3 \tGeom4 \tBarrels \tCulvert \n"
";;--------------\t------------\t----------------\t----------\t----------\t----------\t----------\t----------"
)
# conduit, orifice, and weir cross-section geometry
self.write_transects = TransectsWriter(
) # transect geometry for conduits with irregular cross-sections
self.write_losses = SectionWriterAsList(
"[LOSSES]", LossWriter,
";;Link \tKentry \tKexit \tKavg \tFlap Gate \tSeepage \n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
# conduit entrance/exit losses and flap valves
self.write_controls = SectionWriter()
# rules that control pump and regulator operation
self.write_landuses = SectionWriterAsList(
"[LANDUSES]", LanduseWriter,
";; \tSweeping \tFraction \tLast\n"
";;Name \tInterval \tAvailable \tSwept\n"
";;--------------\t----------\t----------\t----------")
# land use categories
self.write_buildup = SectionWriterAsList(
"[BUILDUP]", BuildupWriter,
";;Land Use \tPollutant \tFunction \tCoeff1 \tCoeff2 \tCoeff3 \tPer Unit\n"
";;--------------\t----------------\t----------\t----------\t----------\t----------\t----------"
)
# buildup functions for pollutants and land uses
self.write_washoff = SectionWriterAsList(
"[WASHOFF]", WashoffWriter,
";;Land Use \tPollutant \tFunction \tCoeff1 \tCoeff2 \tSweepRmvl \tBmpRmvl\n"
";;--------------\t----------------\t----------\t----------\t----------\t----------\t----------"
)
# washoff functions for pollutants and land uses
self.write_pollutants = SectionWriterAsList(
"[POLLUTANTS]", PollutantWriter,
";;Name \tUnits \tCrain \tCgw \tCrdii \tKdecay \tSnowOnly \tCo-Pollutant \tCo-Frac \tCdwf \tCinit\n"
";;--------------\t------\t----------\t----------\t----------\t----------\t----------\t----------------\t----------\t----------\t----------"
)
# pollutant information
self.write_coverages = CoveragesWriter(
) # COVERAGES # assignment of land uses to subcatchments
self.write_treatment = SectionWriterAsList(
"[TREATMENT]", TreatmentWriter,
";;Node \tPollutant \tFunction\n"
";;--------------\t----------------\t--------")
# pollutant removal functions at conveyance system nodes
self.write_inflows = SectionWriterAsList(
"[INFLOWS]", DirectInflowWriter,
";;Node \tConstituent \tTime Series \tType \tMfactor \tSfactor \tBaseline\tPattern\n"
";;--------------\t----------------\t----------------\t--------\t--------\t--------\t--------\t--------"
)
# INFLOWS # external hydrograph/pollutograph inflow at nodes
self.write_dwf = SectionWriterAsList(
"[DWF]", DryWeatherInflowWriter,
";;Node \tConstituent \tBaseline \tPatterns \n"
";;--------------\t----------------\t----------\t----------")
# baseline dry weather sanitary inflow at nodes
self.write_patterns = SectionWriterAsList(
"[PATTERNS]", PatternWriter,
";;Name \tType \tMultipliers\n"
";;--------------\t----------\t-----------")
# PATTERNS periodic variation in dry weather inflow
self.write_rdii = SectionWriterAsList(
"[RDII]", RDIInflowWriter,
";;Node \tUnit Hydrograph \tSewer Area\n"
";;--------------\t----------------\t----------")
# rainfall-dependent I/I information at nodes
self.write_loadings = InitialLoadingsWriter()
# initial pollutant loads on subcatchments
self.write_curves = SectionWriterAsList(
"[CURVES]", CurveWriter,
";;Name \tType \tX-Value \tY-Value \n"
";;--------------\t----------\t----------\t----------")
# CURVES x-y tabular data referenced in other sections
self.write_timeseries = SectionWriterAsList(
"[TIMESERIES]", TimeSeriesWriter,
";;Name \tDate \tTime \tValue\n"
";;--------------\t----------\t----------\t----------")
# time series data referenced in other sections
self.write_labels = SectionWriterAsList(
"[LABELS]", LabelWriter,
";;X-Coord \tY-Coord \tLabel")
def as_text(self, project):
# Figure out which kind of infiltration will be written for this project
infiltration = project.options.infiltration.upper()
if infiltration == "HORTON":
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", HortonInfiltrationWriter,
";;Subcatchment \tMaxRate \tMinRate \tDecay \tDryTime \tMaxInfiltration\n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
elif infiltration.startswith("GREEN"):
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", GreenAmptInfiltrationWriter,
";;Subcatchment \tSuction \tKsat \tIMD \n"
";;--------------\t----------\t----------\t----------")
elif infiltration.startswith("CURVE"):
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", CurveNumberInfiltrationWriter,
";;Subcatchment \tCurveNum \t \tDryTime \n"
";;--------------\t----------\t----------\t----------")
derived_sections = {}
subareas = SectionAsList("[SUBAREAS]")
subareas.value = project.subcatchments.value
subareas_text = self.write_subareas.as_text(subareas)
if subareas_text:
derived_sections[subareas.SECTION_NAME] = subareas_text
tags_text = TagsWriter.as_text(project)
if tags_text:
derived_sections[TagsWriter.SECTION_NAME] = tags_text
symbols = SectionAsList("[SYMBOLS]")
symbols.value = project.raingages.value
symbols_writer = SectionWriterAsList(
"[SYMBOLS]", CoordinateWriter,
";Gage \tX-Coord \tY-Coord")
symbols_text = symbols_writer.as_text(symbols)
if symbols_text:
derived_sections[symbols.SECTION_NAME] = symbols_text
coordinates = SectionAsList("[COORDINATES]")
coordinates.value = project.all_nodes()
coord_comment = ";Node \tX-Coord \tY-Coord"
if project.map.crs_name:
coord_crs_comment = ";CRS=" + project.map.crs_name
if project.map.crs_unit:
coord_crs_comment = coord_crs_comment + "|CRS_UNIT=" + project.map.crs_unit
if coord_crs_comment:
coord_comment = coord_crs_comment + "\n" + coord_comment
coordinates_writer = SectionWriterAsList("[COORDINATES]",
CoordinateWriter,
coord_comment)
coordinates_text = coordinates_writer.as_text(coordinates)
if coordinates_text:
derived_sections[coordinates.SECTION_NAME] = coordinates_text
vertices = SectionAsList("[VERTICES]")
vertices.value = project.all_vertices(True)
vertices_writer = SectionWriterAsList(
"[VERTICES]", CoordinateWriter,
";Link \tX-Coord \tY-Coord")
vertices_text = vertices_writer.as_text(vertices)
if vertices_text:
derived_sections[vertices.SECTION_NAME] = vertices_text
polygons = SectionAsList("[POLYGONS]")
polygon_list = []
for subc in project.subcatchments.value:
for vertex in subc.vertices:
vertex.name = subc.name
polygon_list.append(subc.vertices)
polygons.value = polygon_list
polygons_writer = SectionWriterAsList(
"[POLYGONS]", PolygonWriter,
";Link \tX-Coord \tY-Coord")
polygons_text = polygons_writer.as_text(polygons)
if polygons_text:
derived_sections[polygons.SECTION_NAME] = polygons_text
losses = SectionAsList("[LOSSES]") # (list of Conduit)
losses.value = project.conduits.value
losses_text = self.write_losses.as_text(losses)
if losses_text:
derived_sections[losses.SECTION_NAME] = losses_text
inp = InputFileWriterBase.as_text(self, project, derived_sections)
return inp
def as_text(self, project):
# Figure out which kind of infiltration will be written for this project
infiltration = project.options.infiltration.upper()
if infiltration == "HORTON":
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", HortonInfiltrationWriter,
";;Subcatchment \tMaxRate \tMinRate \tDecay \tDryTime \tMaxInfiltration\n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
elif infiltration.startswith("GREEN"):
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", GreenAmptInfiltrationWriter,
";;Subcatchment \tSuction \tKsat \tIMD \n"
";;--------------\t----------\t----------\t----------")
elif infiltration.startswith("CURVE"):
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", CurveNumberInfiltrationWriter,
";;Subcatchment \tCurveNum \t \tDryTime \n"
";;--------------\t----------\t----------\t----------")
inp = InputFileWriterBase.as_text(self, project)
subareas = SectionAsList("[SUBAREAS]")
subareas.value = project.subcatchments.value
subareas_text = self.write_subareas.as_text(subareas)
if subareas_text:
inp += '\n' + subareas_text + '\n'
tags_text = self.write_tags.as_text(project)
if tags_text:
inp += '\n' + tags_text + '\n'
symbols = SectionAsList("[SYMBOLS]")
symbols.value = project.raingages.value
symbols_writer = SectionWriterAsList(
"[SYMBOLS]", CoordinateWriter,
";Gage \tX-Coord \tY-Coord")
symbols_text = symbols_writer.as_text(symbols)
if symbols_text:
inp += '\n' + symbols_text + '\n'
coordinates = SectionAsList("[COORDINATES]")
coordinates.value = project.all_nodes()
coordinates_writer = SectionWriterAsList(
"[COORDINATES]", CoordinateWriter,
";Node \tX-Coord \tY-Coord")
coordinates_text = coordinates_writer.as_text(coordinates)
if coordinates_text:
inp += '\n' + coordinates_text + '\n'
vertices = SectionAsList("[VERTICES]")
vertices.value = project.all_vertices(True)
vertices_writer = SectionWriterAsList(
"[VERTICES]", CoordinateWriter,
";Link \tX-Coord \tY-Coord")
vertices_text = vertices_writer.as_text(vertices)
if vertices_text:
inp += '\n' + vertices_text + '\n'
losses = SectionAsList("[LOSSES]") # (list of Conduit)
losses.value = project.conduits.value
losses_text = self.write_losses.as_text(losses)
if losses_text:
inp += '\n' + losses_text + '\n'
return inp
class ProjectWriter(InputFileWriterBase):
"""Write a SWMM input file from in-memory data structures"""
def __init__(self):
"""Define the fields of a SWMM Project by creating an empty placeholder for each section"""
self.write_title = TitleWriter() # TITLE project title
self.write_options = GeneralWriter() # OPTIONS analysis options
self.write_report = ReportWriter(
) # REPORT output reporting instructions
self.write_files = SectionWriter(
) # FILES interface file options
self.write_files.SECTION_NAME = "[FILES]"
self.write_files.section_type = Files
self.write_backdrop = BackdropOptionsWriter(
) # BACKDROP bounding rectangle and file name of backdrop image
self.write_map = MapOptionsWriter(
) # MAP map's bounding rectangle and units
self.write_raingages = SectionWriterAsList(
"[RAINGAGES]", RainGageWriter,
";;Name \tFormat \tInterval\tSCF \tSource \n"
";;--------------\t---------\t--------\t--------\t----------")
self.write_hydrographs = SectionWriterAsList(
"[HYDROGRAPHS]", UnitHydrographWriter,
";;Hydrograph \tRain Gage/Month \tResponse\tR \tT \tK \tDmax \tDrecov \tDinit \n"
";;--------------\t----------------\t--------\t--------\t--------\t--------\t--------\t--------\t--------"
)
# unit hydrograph data used to construct RDII inflows
self.write_evaporation = EvaporationWriter(
) # EVAPORATION evaporation data
self.write_temperature = TemperatureWriter(
) # TEMPERATURE air temperature and snow melt data
self.write_adjustments = AdjustmentsWriter(
) # ADJUSTMENTS monthly climate adjustments
self.write_subcatchments = SectionWriterAsList(
"[SUBCATCHMENTS]", SubcatchmentWriter,
";;Name \tRain Gage \tOutlet \tArea \t%Imperv \tWidth \t%Slope \tCurbLen \tSnowPack \n"
";;--------------\t----------------\t----------------\t--------\t--------\t--------\t--------\t--------\t----------------"
)
# basic subcatchment information
self.write_subareas = SectionWriterAsList(
"[SUBAREAS]", SubareaWriter,
";;Subcatchment \tN-Imperv \tN-Perv \tS-Imperv \tS-Perv \tPctZero \tRouteTo \tPctRouted\n"
";;--------------\t----------\t------------\t--------\t----------\t----------\t----------\t---------"
)
# subcatchment impervious/pervious sub-area data
#self.write_infiltration = SectionWriterAsListOf("[INFILTRATION]", SectionWriter, None)
# write_infiltration is set in as_text based on the kind of infiltration being used in the project.
self.write_lid_controls = SectionWriterAsList(
"[LID_CONTROLS]", LIDControlWriter,
";;Name \tType/Layer\tParameters\n"
";;--------------\t----------\t----------")
# low impact development control information
self.write_lid_usage = SectionWriterAsList(
"[LID_USAGE]", LIDUsageWriter,
";;Subcatchment \tLID Process \tNumber \tArea \tWidth \tInitSat \tFromImp \tToPerv \tRptFile \tDrainTo\n"
";;--------------\t----------------\t-------\t----------\t----------\t----------\t----------\t----------\t------------------------\t----------------"
)
# assignment of LID controls to subcatchments
self.write_aquifers = SectionWriterAsList(
"[AQUIFERS]", AquiferWriter,
";;Aquifer \tPhi \tWP \tFC \tHydCon\tKslope\tTslope\tUEF \tLED \tLGLR \tBEL \tWTEL \tUZM \tUEF Pat\n"
";;--------------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t-------"
)
# groundwater aquifer parameters
self.write_groundwater = SectionWriterAsList(
"[GROUNDWATER]", GroundwaterWriter,
";;Subcatchment \tAquifer \tNode \tEsurf \tA1 \tB1 \tA2 \tB2 \tA3 \tDsw \tEgwt \tEbot \tWgr \tUmc \n"
";;--------------\t----------------\t----------------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------\t------"
)
# subcatchment groundwater parameters
self.write_gwf = SectionWriterAsList(
"[GWF]", GWFWriter, ";;Subcatchment \tFlow \tEquation\n"
";;-------------- \t------- \t--------")
# custom groundwater flow equations
self.write_snowpacks = SectionWriterAsList(
"[SNOWPACKS]", SnowPackWriter,
";;Name \tSurface \tParameters\n"
";;--------------\t----------\t----------")
# subcatchment snow pack parameters
self.write_junctions = SectionWriterAsList(
"[JUNCTIONS]", JunctionWriter,
";;Name \tElevation \tMaxDepth \tInitDepth \tSurDepth \tAponded\n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
# junction node information
self.write_outfalls = SectionWriterAsList(
"[OUTFALLS]", OutfallWriter,
";;Name \tElevation \tType \tStage Data \tGated \tRoute To\n"
";;--------------\t----------\t----------\t----------------\t--------\t----------------"
)
# outfall node information
self.write_dividers = SectionWriterAsList(
"[DIVIDERS]", DividerWriter,
";;Name \tElevation \tDiverted Link \tType \tParameters\n"
";;--------------\t----------\t----------------\t----------\t----------"
)
# flow divider node information
self.write_storage = SectionWriterAsList(
"[STORAGE]", StorageWriter,
";;Name \tElev. \tMaxDepth \tInitDepth \tShape \tCurve Name/Params \tN/A-Pond\tFevap \tPsi \tKsat \tIMD\n"
";;--------------\t--------\t----------\t-----------\t----------\t----------------------------\t--------\t--------\t--------\t--------\t--------"
)
# storage node information
self.write_conduits = SectionWriterAsList(
"[CONDUITS]", ConduitWriter,
";;Name \tFrom Node \tTo Node \tLength \tRoughness \tInOffset \tOutOffset \tInitFlow \tMaxFlow\n"
";;--------------\t----------------\t----------------\t----------\t----------\t----------\t----------\t----------\t----------"
)
# conduit link information
self.write_pumps = SectionWriterAsList(
"[PUMPS]", PumpWriter,
";;Name \tFrom Node \tTo Node \tPump Curve \tStatus \tStartup \tShutoff\n"
";;--------------\t----------------\t----------------\t----------------\t--------\t--------\t--------"
)
# pump link information
self.write_orifices = SectionWriterAsList(
"[ORIFICES]", OrificeWriter,
";;Name \tFrom Node \tTo Node \tType \tOffset \tQcoeff \tGated \tCloseTime\n"
";;--------------\t----------------\t----------------\t------------\t----------\t----------\t--------\t----------"
)
# orifice link information
self.write_weirs = SectionWriterAsList(
"[WEIRS]", WeirWriter,
";;Name \tFrom Node \tTo Node \tType \tCrestHt \tQcoeff \tGated \tEndCon \tEndCoeff \tSurcharge \tRoadWidth \tRoadSurf \tCoeff. Curve\n"
";;--------------\t----------------\t----------------\t------------\t----------\t----------\t--------\t--------\t----------\t----------\t----------\t----------\t----------"
)
# weir link information
self.write_outlets = SectionWriterAsList(
"[OUTLETS]", OutletWriter,
";;Name \tFrom Node \tTo Node \tOffset \tType \tQTable/Qcoeff \tQexpon \tGated\n"
";;--------------\t----------------\t----------------\t----------\t---------------\t----------------\t----------\t--------"
)
# outlet link information
self.write_xsections = SectionWriterAsList(
"[XSECTIONS]", CrossSectionWriter,
";;Link \tShape \tGeom1 \tGeom2 \tGeom3 \tGeom4 \tBarrels \tCulvert \n"
";;--------------\t------------\t----------------\t----------\t----------\t----------\t----------\t----------"
)
# conduit, orifice, and weir cross-section geometry
self.write_transects = TransectsWriter(
) # transect geometry for conduits with irregular cross-sections
self.write_losses = SectionWriterAsList(
"[LOSSES]", LossWriter,
";;Link \tKentry \tKexit \tKavg \tFlap Gate \tSeepage \n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
# conduit entrance/exit losses and flap valves
self.write_controls = ControlWriter()
# rules that control pump and regulator operation
self.write_events = SectionWriterAsList(
"[EVENTS]", EventsWriter, ";;Start Date \tEnd Date\n")
# events
self.write_landuses = SectionWriterAsList(
"[LANDUSES]", LanduseWriter,
";; \tSweeping \tFraction \tLast\n"
";;Name \tInterval \tAvailable \tSwept\n"
";;--------------\t----------\t----------\t----------")
# land use categories
self.write_buildup = SectionWriterAsList(
"[BUILDUP]", BuildupWriter,
";;Land Use \tPollutant \tFunction \tCoeff1 \tCoeff2 \tCoeff3 \tPer Unit\n"
";;--------------\t----------------\t----------\t----------\t----------\t----------\t----------"
)
# buildup functions for pollutants and land uses
self.write_washoff = SectionWriterAsList(
"[WASHOFF]", WashoffWriter,
";;Land Use \tPollutant \tFunction \tCoeff1 \tCoeff2 \tSweepRmvl \tBmpRmvl\n"
";;--------------\t----------------\t----------\t----------\t----------\t----------\t----------"
)
# washoff functions for pollutants and land uses
self.write_pollutants = SectionWriterAsList(
"[POLLUTANTS]", PollutantWriter,
";;Name \tUnits \tCrain \tCgw \tCrdii \tKdecay \tSnowOnly \tCo-Pollutant \tCo-Frac \tCdwf \tCinit\n"
";;--------------\t------\t----------\t----------\t----------\t----------\t----------\t----------------\t----------\t----------\t----------"
)
# pollutant information
self.write_coverages = CoveragesWriter(
) # COVERAGES # assignment of land uses to subcatchments
self.write_treatment = SectionWriterAsList(
"[TREATMENT]", TreatmentWriter,
";;Node \tPollutant \tFunction\n"
";;--------------\t----------------\t--------")
# pollutant removal functions at conveyance system nodes
self.write_inflows = SectionWriterAsList(
"[INFLOWS]", DirectInflowWriter,
";;Node \tConstituent \tTime Series \tType \tMfactor \tSfactor \tBaseline\tPattern\n"
";;--------------\t----------------\t----------------\t--------\t--------\t--------\t--------\t--------"
)
# INFLOWS # external hydrograph/pollutograph inflow at nodes
self.write_dwf = SectionWriterAsList(
"[DWF]", DryWeatherInflowWriter,
";;Node \tConstituent \tBaseline \tPatterns \n"
";;--------------\t----------------\t----------\t----------")
# baseline dry weather sanitary inflow at nodes
self.write_patterns = SectionWriterAsList(
"[PATTERNS]", PatternWriter,
";;Name \tType \tMultipliers\n"
";;--------------\t----------\t-----------")
# PATTERNS periodic variation in dry weather inflow
self.write_rdii = SectionWriterAsList(
"[RDII]", RDIInflowWriter,
";;Node \tUnit Hydrograph \tSewer Area\n"
";;--------------\t----------------\t----------")
# rainfall-dependent I/I information at nodes
self.write_loadings = InitialLoadingsWriter()
# initial pollutant loads on subcatchments
self.write_curves = SectionWriterAsList(
"[CURVES]", CurveWriter,
";;Name \tType \tX-Value \tY-Value \n"
";;--------------\t----------\t----------\t----------")
# CURVES x-y tabular data referenced in other sections
self.write_timeseries = SectionWriterAsList(
"[TIMESERIES]", TimeSeriesWriter,
";;Name \tDate \tTime \tValue\n"
";;--------------\t----------\t----------\t----------")
# time series data referenced in other sections
self.write_labels = SectionWriterAsList(
"[LABELS]", LabelWriter,
";;X-Coord \tY-Coord \tLabel")
# X, Y coordinates, text, and font details of labels
def as_text(self, project):
# Figure out which kind of infiltration will be written for this project
infiltration = project.options.infiltration.upper()
if infiltration == "HORTON" or infiltration == "MODIFIED_HORTON":
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", HortonInfiltrationWriter,
";;Subcatchment \tMaxRate \tMinRate \tDecay \tDryTime \tMaxInfiltration\n"
";;--------------\t----------\t----------\t----------\t----------\t----------"
)
elif infiltration.startswith("GREEN") or infiltration.startswith(
"MODIFIED_GREEN"):
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", GreenAmptInfiltrationWriter,
";;Subcatchment \tSuction \tKsat \tIMD \n"
";;--------------\t----------\t----------\t----------")
elif infiltration.startswith("CURVE"):
self.write_infiltration = SectionWriterAsList(
"[INFILTRATION]", CurveNumberInfiltrationWriter,
";;Subcatchment \tCurveNum \t \tDryTime \n"
";;--------------\t----------\t----------\t----------")
derived_sections = {}
subareas = SectionAsList("[SUBAREAS]")
subareas.value = project.subcatchments.value
subareas_text = self.write_subareas.as_text(subareas)
if subareas_text:
derived_sections[subareas.SECTION_NAME] = subareas_text
tags_text = TagsWriter.as_text(project)
if tags_text:
derived_sections[TagsWriter.SECTION_NAME] = tags_text
symbols = SectionAsList("[SYMBOLS]")
symbols.value = project.raingages.value
symbols_writer = SectionWriterAsList(
"[SYMBOLS]", CoordinateWriter,
";Gage \tX-Coord \tY-Coord")
symbols_text = symbols_writer.as_text(symbols)
if symbols_text:
derived_sections[symbols.SECTION_NAME] = symbols_text
coordinates = SectionAsList("[COORDINATES]")
coordinates.value = project.all_nodes()
coord_comment = ";Node \tX-Coord \tY-Coord"
if project.map.crs_name:
coord_crs_comment = ";CRS=" + project.map.crs_name
if project.map.crs_unit:
coord_crs_comment = coord_crs_comment + "|CRS_UNIT=" + project.map.crs_unit
if coord_crs_comment:
coord_comment = coord_crs_comment + "\n" + coord_comment
coordinates_writer = SectionWriterAsList("[COORDINATES]",
CoordinateWriter,
coord_comment)
coordinates_text = coordinates_writer.as_text(coordinates)
if coordinates_text:
derived_sections[coordinates.SECTION_NAME] = coordinates_text
vertices = SectionAsList("[VERTICES]")
vertices.value = project.all_vertices(True)
vertices_writer = SectionWriterAsList(
"[VERTICES]", CoordinateWriter,
";Link \tX-Coord \tY-Coord")
vertices_text = vertices_writer.as_text(vertices)
if vertices_text:
derived_sections[vertices.SECTION_NAME] = vertices_text
polygons = SectionAsList("[POLYGONS]")
polygon_list = []
for subc in project.subcatchments.value:
for vertex in subc.vertices:
vertex.name = subc.name
polygon_list.append(subc.vertices)
polygons.value = polygon_list
polygons_writer = SectionWriterAsList(
"[POLYGONS]", PolygonWriter,
";Link \tX-Coord \tY-Coord")
polygons_text = polygons_writer.as_text(polygons)
if polygons_text:
derived_sections[polygons.SECTION_NAME] = polygons_text
losses = SectionAsList("[LOSSES]") # (list of Conduit)
losses.value = project.conduits.value
losses_text = self.write_losses.as_text(losses)
if losses_text:
derived_sections[losses.SECTION_NAME] = losses_text
inp = InputFileWriterBase.as_text(self, project, derived_sections)
return inp
def __init__(self):
"""Initialize the sections of an EPANET input file.
Any sections not initialized here will be handled by the generic core.project_base.Section class."""
self.write_title = TitleWriter()
self.write_junctions = SectionWriterAsList("[JUNCTIONS]", JunctionWriter,
";ID \tElev \tDemand\tPattern\n"
";---------------\t------\t------\t-------")
self.write_emitters = SectionWriterAsList("[EMITTERS]", EmittersWriter,
";Junction \tCoefficient\n"
";---------------\t------------")
self.write_reservoirs = SectionWriterAsList("[RESERVOIRS]", ReservoirWriter,
";ID \tHead \tPattern\n"
";---------------\t------------\t-------")
self.write_tanks = SectionWriterAsList("[TANKS]", TankWriter,
";ID \tElevation \tInitLevel \tMinLevel \tMaxLevel \tDiameter \tMinVol \tVolCurve")
self.write_mixing = SectionWriterAsList("[MIXING]", MixingWriter,
";Tank \tModel \tMixing Volume Fraction\n"
";---------------\t------------\t----------------------")
self.write_pipes = SectionWriterAsList("[PIPES]", PipeWriter,
";ID \tNode1 \tNode2 \t"
"Length \tDiameter \tRoughness \tMinorLoss \tStatus")
self.write_pumps = SectionWriterAsList("[PUMPS]", PumpWriter,
";ID \tNode1 \tNode2 \tParameters")
self.write_valves = SectionWriterAsList("[VALVES]", ValveWriter,
";ID \tNode1 \tNode2 \tDiameter \tType\tSetting \tMinorLoss ")
self.write_patterns = SectionWriterAsList("[PATTERNS]", PatternWriter,
";ID \tMultipliers\n"
";----------------\t-----------")
self.write_curves = SectionWriterAsList("[CURVES]", CurveWriter,
";ID \tX-Value \tY-Value\n"
";----------------\t------------\t-------")
self.write_energy = EnergyOptionsWriter()
self.write_status = SectionWriterAsList("[STATUS]", StatusWriter, ";ID \tStatus/Setting")
self.write_controls = ControlWriter()
self.write_rules = RuleWriter()
self.write_demands = SectionWriterAsList("[DEMANDS]", DemandWriter,
";ID \tDemand \tPattern \tCategory\n"
";---------------\t---------\t----------\t--------")
self.write_quality = SectionWriterAsList("[QUALITY]", QualityWriter,
";Node \tInitQuality\n"
";---------------\t-----------")
self.write_reactions = ReactionsWriter()
self.write_sources = SectionWriterAsList("[SOURCES]", SourceWriter,
";Node \tType \tStrength \tPattern\n"
";---------------\t--------------\t------------\t-------")
self.write_options = OptionsWriter()
self.write_times = SectionWriter()
self.write_report = ReportOptionsWriter()
self.write_labels = SectionWriterAsList("[LABELS]", LabelWriter,
";X-Coord \tY-Coord \tLabel & Anchor Node")
self.write_backdrop = BackdropOptionsWriter()
class ProjectWriter(InputFileWriterBase):
"""Read an EPANET input file into in-memory data structures"""
def __init__(self):
"""Initialize the sections of an EPANET input file.
Any sections not initialized here will be handled by the generic core.project_base.Section class."""
self.write_title = TitleWriter()
self.write_junctions = SectionWriterAsList("[JUNCTIONS]", JunctionWriter,
";ID \tElev \tDemand\tPattern\n"
";---------------\t------\t------\t-------")
self.write_emitters = SectionWriterAsList("[EMITTERS]", EmittersWriter,
";Junction \tCoefficient\n"
";---------------\t------------")
self.write_reservoirs = SectionWriterAsList("[RESERVOIRS]", ReservoirWriter,
";ID \tHead \tPattern\n"
";---------------\t------------\t-------")
self.write_tanks = SectionWriterAsList("[TANKS]", TankWriter,
";ID \tElevation \tInitLevel \tMinLevel \tMaxLevel \tDiameter \tMinVol \tVolCurve")
self.write_mixing = SectionWriterAsList("[MIXING]", MixingWriter,
";Tank \tModel \tMixing Volume Fraction\n"
";---------------\t------------\t----------------------")
self.write_pipes = SectionWriterAsList("[PIPES]", PipeWriter,
";ID \tNode1 \tNode2 \t"
"Length \tDiameter \tRoughness \tMinorLoss \tStatus")
self.write_pumps = SectionWriterAsList("[PUMPS]", PumpWriter,
";ID \tNode1 \tNode2 \tParameters")
self.write_valves = SectionWriterAsList("[VALVES]", ValveWriter,
";ID \tNode1 \tNode2 \tDiameter \tType\tSetting \tMinorLoss ")
self.write_patterns = SectionWriterAsList("[PATTERNS]", PatternWriter,
";ID \tMultipliers\n"
";----------------\t-----------")
self.write_curves = SectionWriterAsList("[CURVES]", CurveWriter,
";ID \tX-Value \tY-Value\n"
";----------------\t------------\t-------")
self.write_energy = EnergyOptionsWriter()
self.write_status = SectionWriterAsList("[STATUS]", StatusWriter, ";ID \tStatus/Setting")
self.write_controls = ControlWriter()
self.write_rules = RuleWriter()
self.write_demands = SectionWriterAsList("[DEMANDS]", DemandWriter,
";ID \tDemand \tPattern \tCategory\n"
";---------------\t---------\t----------\t--------")
self.write_quality = SectionWriterAsList("[QUALITY]", QualityWriter,
";Node \tInitQuality\n"
";---------------\t-----------")
self.write_reactions = ReactionsWriter()
self.write_sources = SectionWriterAsList("[SOURCES]", SourceWriter,
";Node \tType \tStrength \tPattern\n"
";---------------\t--------------\t------------\t-------")
self.write_options = OptionsWriter()
self.write_times = SectionWriter()
self.write_report = ReportOptionsWriter()
self.write_labels = SectionWriterAsList("[LABELS]", LabelWriter,
";X-Coord \tY-Coord \tLabel & Anchor Node")
self.write_backdrop = BackdropOptionsWriter()
def as_text(self, project):
derived_sections = {}
quality_text = QualityWriter.as_text(project)
if quality_text:
derived_sections[QualityWriter.SECTION_NAME] = quality_text
coordinates = SectionAsList("[COORDINATES]")
coordinates.value = project.all_nodes()
coord_comment = ";Node \tX-Coord \tY-Coord"
if project.map.crs_name:
coord_crs_comment = ";CRS=" + project.map.crs_name
if project.map.crs_unit:
coord_crs_comment = coord_crs_comment + "|CRS_UNIT=" + project.map.crs_unit
if coord_crs_comment:
coord_comment = coord_crs_comment + "\n" + coord_comment
coordinates_writer = SectionWriterAsList("[COORDINATES]", CoordinateWriter, coord_comment)
coordinates_text = coordinates_writer.as_text(coordinates)
if coordinates_text:
derived_sections[coordinates_writer.SECTION_NAME] = coordinates_text
vertices = SectionAsList("[VERTICES]")
vertices.value = project.all_vertices(True)
vertices_writer = SectionWriterAsList("[VERTICES]", CoordinateWriter,
";Link \tX-Coord \tY-Coord")
vertices_text = vertices_writer.as_text(vertices)
if vertices_text:
derived_sections[vertices_writer.SECTION_NAME] = vertices_text
tags_text = TagsWriter.as_text(project)
if tags_text:
derived_sections[TagsWriter.SECTION_NAME] = tags_text
mixing = SectionAsList('[MIXING]')
mixing.value = project.tanks.value
mixing_text = self.write_mixing.as_text(mixing)
if mixing_text:
derived_sections[mixing.SECTION_NAME] = mixing_text
emitters = SectionAsList('[EMITTERS]')
emitters.value = project.junctions.value
emitters_text = self.write_emitters.as_text(emitters)
if emitters_text:
derived_sections[emitters.SECTION_NAME] = emitters_text
status = SectionAsList('[STATUS]')
status.value = project.all_links()
status_text = self.write_status.as_text(status)
if status_text:
derived_sections[status.SECTION_NAME] = status_text
inp = InputFileWriterBase.as_text(self, project, derived_sections)
inp += '\n' + '[END]' + '\n'
return inp