Merge pull request #62 from ichrys03/epanet2.3-undercover

Epanet2.3 new updates

Author: Mariosmsk

README.md

@@ -0,0 +1,74 @@
+from epyt import epanet
+
+# Model + time settings
+
+d = epanet('ky10.inp')
+TIME_H     = 24 * 3600          # 24 hours
+HYD_STEP   = 15 * 60            # 15 min
+PAT_STEP   = 15 * 60
+RPT_STEP   = 15 * 60
+
+LINK_LEAK_AREA = 3e-7
+EMITTER_COEFF = 0.002
+
+d.setTimeSimulationDuration(TIME_H)
+d.setTimeHydraulicStep(HYD_STEP)
+d.setTimePatternStep(PAT_STEP)
+d.setTimeReportingStep(RPT_STEP)
+
+linkID  = d.getLinkNameID(10)
+pipe_ix = d.getLinkIndex(linkID)
+
+nodeID  = d.getNodeNameID(10)
+junc_ix = d.getNodeIndex(nodeID)
+
+# Apply leakage settings
+
+d.setLinkLeakArea(pipe_ix, LINK_LEAK_AREA)
+d.setLinkExpansionProperties(pipe_ix, 0.5)   # example elasticity coefficient
+
+d.setNodeEmitterCoeff(junc_ix, EMITTER_COEFF)
+
+p_unit = d.getOptionsPressureUnits()
+q_unit = d.getFlowUnits()
+
+print(f"[Units] Flow={q_unit} | Pressure={p_unit} ")
+print(f"[Params] LinkLeakArea={LINK_LEAK_AREA:g} m^2 | EmitterCoeff={EMITTER_COEFF:g}")
+
+# Run hydraulics
+
+d.openHydraulicAnalysis()
+d.initializeHydraulicAnalysis()
+
+t = 0.0
+while True:
+    d.runHydraulicAnalysis()
+
+    # Leakages
+    leak_pipe = d.getLinkLeakageRate(pipe_ix)
+    leak_node = d.getNodeLeakageFlow(junc_ix)
+    emitter   = d.getNodeEmitterFlow(junc_ix)
+
+    # Demand
+    dem_req   = d.getConsumerDemandRequested(junc_ix)
+    dem_del   = d.getConsumerDemandDelivered(junc_ix)
+
+    # Optional diagnostics
+    Pj = d.getNodePressure(junc_ix)
+
+    total_out = max(dem_del + leak_pipe + leak_node + emitter, 1e-12)
+    leak_share = 100.0 * (leak_pipe + leak_node + emitter) / total_out
+
+    print(
+        f"t={t:5.0f}s | P={Pj:7.3f} {p_unit:>3} | "
+        f"PipeLeak={leak_pipe:9.4f} | NodeLeak={leak_node:9.4f} | Emitter={emitter:8.4f} | "
+        f"DemReq={dem_req:8.3f} | DemDel={dem_del:8.3f} | LeakShare={leak_share:5.1f}%"
+    )
+
+    dt = d.nextHydraulicAnalysisStep()
+    if dt <= 0:
+        break
+    t += dt
+
+d.closeHydraulicAnalysis()
+d.unload()

epyt/epanet.py

@@ -0,0 +1,138 @@
+from epyt import epanet
+
+# inpfile = "Richmond_standard.inp"
+
+# #Warning that a link is missing and the network is not fully connected
+# inpfile = "BrokenNetwork.inp"
+# d = epanet(inpfile)
+# d.unload()
+
+inpfile = "Net1.inp"
+d = epanet(inpfile)
+
+# d.getNodeNameID('dakjsdfhjksdfhsd')
+# setcurvetype functions
+d.setCurveTypePump(1)
+d.printv(d.getCurveType(1))
+d.setCurveTypeVolume(1)
+d.printv(d.getCurveType())
+d.setCurveTypeGeneral(1)
+d.printv(d.getCurveType())
+d.setCurveTypeHeadloss(1)
+d.printv(d.getCurveType())
+d.setCurveTypeEfficiency(1)
+d.printv(d.getCurveType())
+d.setCurveTypeValveCurve(1)
+d.printv(d.getCurveType())
+
+# Setvertex
+linkID = '10'
+x = [22, 24, 28]
+y = [30, 68, 69]
+d.setLinkVertices(linkID, x, y)
+x = d.getLinkVertices()
+d.setVertex(1, 1, 1, 1)
+d.printv(d.getLinkVertices())
+
+# set and get linkvalvecurvegpv
+linkid = d.getLinkPipeNameID(1)
+condition = 1
+index = d.setLinkTypeValveGPV(linkid, condition)
+d.setLinkValveCurveGPV(index, 1)
+d.printv(d.getLinkValveCurveGPV())
+
+# set and get linkvalvecurvepcv
+linkid = d.getLinkPipeNameID(1)
+condition = 1
+index = d.setLinkTypeValvePCV(linkid, condition)
+d.setLinkValveCurvePCV(index, 1)
+d.printv(d.getLinkValveCurvePCV(index))
+
+# setTimeClockStartTime & getTimeClockStartTime
+d.printv(d.getTimeClockStartTime())
+d.setTimeClockStartTime(3600)
+d.printv(d.getTimeClockStartTime())
+
+# getOptionsDemandPattern())
+d.printv(d.getOptionsDemandPattern())
+d.setOptionsDemandPattern(0)
+d.printv(d.getOptionsDemandPattern())
+
+# getLinkType / d.setLinkTypeValvePCV / d.addLinkValvePCV
+d.getLinkType(1)  # Retrieves the type of the 1st link
+linkid = d.getLinkPipeNameID(1)  # Retrieves the ID of the 1t pipe
+index = d.setLinkTypeValvePCV(linkid)  # Changes the 1st pipe to valve PCV given it's ID
+print(d.getLinkType(index))
+
+# addLinkValvePCV
+# d.plot()
+valveID = 'newValvePCV'
+fromNode = '10'
+toNode = '21'
+valveIndex = d.addLinkValvePCV(valveID, fromNode, toNode)
+# d.plot()
+
+# getset OptionsEmiterBackFlow
+d.printv(d.getOptionsEmitterBackFlow())
+d.setOptionsEmitterBackFlowDisallowed()
+d.printv(d.getOptionsEmitterBackFlow())
+d.setOptionsEmitterBackFlowAllowed()
+d.printv(d.getOptionsEmitterBackFlow())
+
+# getNodeInControl & getLinkInControl
+d.printv(d.getLinkInControl())
+d.printv(d.getLinkInControl(10))
+d.printv(d.getNodeInControl())
+d.printv(d.getNodeInControl(11))
+
+# setLinkFlowUnitsCMS
+d.setFlowUnitsCMS()  # kpa and meters
+d.printv(d.getFlowUnits())
+
+# example with change from kpa to psi without changing metric first
+d.setOptionsPressureUnitsPSI()
+d.printv(d.getOptionsPressureUnits())
+
+# how to do it right
+d.setFlowUnitsIMGD()
+d.setOptionsPressureUnitsPSI()
+d.printv(d.getOptionsPressureUnits())
+
+# example with change from psi to KPA without changing the metric
+d.setOptionsPressureUnitsKPA()
+d.printv(d.getOptionsPressureUnits())
+
+# reseting
+d.setFlowUnitsGPM()
+d.setOptionsPressureUnitsPSI()
+
+# setNodeEmitterCoeff
+d.setNodeEmitterCoeff([2, 3], [0.5, 0.6])
+d.printv(d.getNodeEmitterCoeff())
+
+# getset Optionsstatusreport
+d.setOptionsStatusReportNo()
+d.printv(d.getOptionsStatusReport())
+d.setOptionsStatusReportNormal()
+d.printv(d.getOptionsStatusReport())
+d.setOptionsStatusReportFull()
+d.printv(d.getOptionsStatusReport())
+
+# Leakage section
+d.solveCompleteHydraulics()
+
+d.setLinkLeakArea(2, 10.5)
+d.printv(d.getLinkLeakArea())
+
+d.setLinkExpansionProperties(5, 2)
+d.printv(d.getLinkExpansionProperties())
+
+d.printv(d.getLinkLeakageRate())
+
+d.printv(d.getConsumerDemandRequested(5))
+
+d.printv(d.getConsumerDemandDelivered(5))
+
+d.printv(d.getNodeEmitterFlow())
+
+d.unload()

epyt/examples/python/EX28_Leakage.py

@@ -0,0 +1,81 @@
+from epyt import epanet
+import time
+
+"""
+        Performance Example Summary:
+
+Objective:
+
+    To compare the execution speed of two functions, getLinkFlows vs. getLinkValues.
+
+Criteria:
+
+    The main criterion for comparison was speed.
+    Both functions were tested under the same simulation conditions.
+
+Test Setup:
+
+    The simulation was designed to extract link flow values:
+        getLinkFlows: Extracts flows for all links - 1.
+        getLinkValues: Extracts the flow values for all links.
+
+Results:
+
+    getLinkFlows: Extracted fewer values (flows set to -1).
+    getLinkValues: Extracted all actual flow values for each link,
+    processing more data than getLinkFlows.
+    Despite extracting more data, getLinkValues performed faster than getLinkFlows.
+
+Conclusion: 
+
+    The function getLinkValues was more efficient in terms of speed, 
+    even though it processed and returned more values compared to getLinkFlows. 
+"""
+
+
+
+inp= "Net1.inp"
+d = epanet(inp)
+
+d.setTimeSimulationDuration(1000*3600*24)
+start_time = time.time()
+d.openHydraulicAnalysis()
+d.initializeHydraulicAnalysis()
+numbers = [i for i in range(1, 13)]
+tstep = 1
+T_H, Ft, Fb =  [], [], []
+while tstep > 0:
+    t = d.runHydraulicAnalysis()
+    #flow test
+    Fb.append(d.getLinkFlows(numbers))
+    T_H.append(t)
+    tstep = d.nextHydraulicAnalysisStep()
+
+d.closeHydraulicAnalysis()
+print(Fb)
+end_time = time.time()
+timeforold = end_time - start_time
+print(f"Time taken by old function: {timeforold} seconds")
+d.unload()
+
+d = epanet(inp)
+start_time = time.time()
+
+d.openHydraulicAnalysis()
+d.initializeHydraulicAnalysis()
+
+tstep = 1
+T_H, Ft, Fb =  [], [], []
+while tstep > 0:
+    t = d.runHydraulicAnalysis()
+    #flow test
+    Ft.append(d.getLinkValues(d.ToolkitConstants.EN_FLOW))
+    T_H.append(t)
+    tstep = d.nextHydraulicAnalysisStep()
+
+d.closeHydraulicAnalysis()
+print(Ft)
+end_time = time.time()
+timefornew = end_time - start_time
+print(f"Time taken by newfunction: {timefornew} seconds")
+print(f"The new function is faster by {timeforold-timefornew} seconds")