epyt package

Subpackages

epyt.src package

Submodules

epyt.epanet module

EPANET-Python Toolkit (EPyT): A Python toolkit for EPANET libraries

How to run:

from epyt import epanet

d = epanet(‘Net1.inp’)

EPANET is software that models water distribution piping systems developed by the US EPA and provided under a public domain licence. This python toolkit serves as an interface between Python and EPANET, to assist researchers and the industry when solving problems related with water distribution systems.

EPANET was developed by the Water Supply and Water Resources Division of the U.S. Environmental Protection Agency’s National Risk Management Research Laboratory. EPANET is under the Public Domain.

The latest EPANET files can downloaded at: https://github.com/OpenWaterAnalytics/EPANET

Inspired by: EPANET-MATLAB Toolkit D.G. Eliades, M. Kyriakou, S. Vrachimis and M.M. Polycarpou, “EPANET-MATLAB Toolkit: An Open-Source Software for Interfacing EPANET with MATLAB”, in Proc. 14th International Conference on Computing and Control for the Water Industry (CCWI), The Netherlands, Nov 2016, p.8. (doi:10.5281/zenodo.831493)

Other python packages related to the EPANET engine: wntr Klise, K.A., Murray, R., Haxton, T. (2018). An overview of the Water Network Tool for Resilience (WNTR), In Proceedings of the 1st International WDSA/CCWI Joint Conference, Kingston, Ontario, Canada, July 23-25, 075, 8p.

epanet-python https://github.com/OpenWaterAnalytics/epanet-python

EPANET-Python Toolkit Licence:

Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent libepanets of the EUPL (the “Licence”) You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at:

https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12

Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an “AS IS” basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.

class epyt.epanet.error_handler[source]

Bases: object

last_error = None

class epyt.epanet.EpytValues[source]

Bases: object

__init__()[source]

disp()[source]

Displays the values on the command window

Parameters:: self (EpytValues class) – Values to be printed on the command window
Returns:: None

to_dict()[source]

Transform EpytValues class values to dict format

Parameters:: self (EpytValues class) – Values to add in the dictionary
Returns:: dictionary with the values
Return type:: dict

to_excel(filename=None, attributes=None, allValues=False, node_id_list=None, link_id_list=None, both=False, header=True)[source]

Save to an Excel file the values of EpytValues class.

Parameters:

filename (str, optional) – Excel filename, defaults to None
attributes (str or list of str, optional) – Attributes to add to the file, defaults to None
allValues (bool, optional) – If True, writes all the values into a separate “All values” sheet, defaults to False
node_id_list (list or np.ndarray, optional) – Array of IDs for node-related attributes
link_id_list (list or np.ndarray, optional) – Array of IDs for link-related attributes
both (bool, optional) – If True, and ID array available, print both ‘Index’ and ‘Id’. If no ID array, just Index. If False and ID array available, print only ‘Id’; if no ID array, print only ‘Index’.
header (bool, optional) – If False, remove the first row from all sheets and do not write column headers

Returns:

None

to_json(filename=None)[source]

Transforms val class values to json object and saves them to a json file if filename is provided

Parameters:

self (val class) – Values to add in the json file
filename (str, optional) – json filename, defaults to None

Returns:

the json object with the values

Return type:

json object

epyt.epanet.isList(var)[source]

class epyt.epanet.epanet(*argv, version=2.3, ph=False, loadfile=False, customlib=None, display_msg=True, display_warnings=True, createinp=False)[source]

Bases: object

EPyt main functions class

Example with custom library: epanetlib=os.path.join(os.getcwd(), ‘epyt’,’libraries’,’win’,’epanet2.dll’) d = epanet(inpname, msx=True,customlib=epanetlib)

__init__(*argv, version=2.3, ph=False, loadfile=False, customlib=None, display_msg=True, display_warnings=True, createinp=False)[source]

addControls(control, *argv)[source]

Adds a new simple control.

Parameters:: control (float or list) – New Control
Returns:: Control index
Return type:: int

The examples are based on d = epanet(‘Net1.inp’)

Example 1: Close Link 12 if the level in Tank 2 exceeds 20 ft.

>>> index = d.addControls('LINK 12 CLOSED IF NODE 2 ABOVE 20')
>>> d.getControls(index).disp()

Example 2: Open Link 12 if the pressure at Node 11 is under 30 psi.

>>> index = d.addControls('LINK 12 OPEN IF NODE 11 BELOW 30')
>>> d.getControls(index).disp()

Example 3: Pump 9 speed is set to 1.5 at 16 hours or 57600 seconds into the simulation.

>>> index = d.addControls('LINK 9 1.5 AT TIME 16:00')
>>> d.getControls(index).disp()
>>> index = d.addControls('LINK 9 1.5 AT TIME 57600') #in seconds
>>> d.getControls(index).disp()

Example 4: Link 12 is closed at 10 am and opened at 8 pm throughout the simulation.

>>> index_3 = d.addControls('LINK 12 CLOSED AT CLOCKTIME 10:00')
>>> d.getControls(index_3).disp()
>>> index_4 = d.addControls('LINK 12 OPEN AT CLOCKTIME 20:00')
>>> d.getControls(index_4).disp()

Example 5: Adds multiple controls given as cell.

>>> d = epanet("Net1.inp")
>>> control_1 = 'LINK 9 OPEN IF NODE 2 BELOW 110'
>>> control_2 = 'LINK 9 CLOSED IF NODE 2 ABOVE 200'
>>> controls = [control_1, control_2]
>>> index = d.addControls(controls)
>>> d.getControls(index)[0].Control
>>> d.getControls(index)[1].Control

Example 6:

Notes:

index: return index of the new control.
Type: the type of control to add (see EN_ControlType).
linkIndex: the index of a link to control (starting from 1).
setting: control setting applied to the link.
nodeIndex: index of the node used to control the link

(0 for EN_TIMER and EN_TIMEOFDAY controls). * level: action level (tank level, junction pressure, or time in seconds) that triggers the control.

Control type codes consist of the following:

EN_LOWLEVEL 0 Control applied when tank level or node

pressure drops below specified level * EN_HILEVEL 1 Control applied when tank level or node pressure rises above specified level * EN_TIMER 2 Control applied at specific time into simulation * EN_TIMEOFDAY 3 Control applied at specific time of day

Code example: index = d.addControls(type, linkIndex, setting, nodeIndex, level)

>>> index = d.addControls(0, 13, 0, 11, 100)
# retrieve controls of index in dict format
>>> d.getControls(index).to_dict()

See also deleteControls, getControls, setControls, getControlCount.

addCurve(*argv)[source]

Adds a new curve appended to the end of the existing curves. Returns the new curve’s index.

Parameters:

*argv –

value index or value

Raises:

No curve ID or curve values exist

Returns:

new curve valueIndex

Return type:

int

Example: ID selected without a space in between the letters

>>> new_curve_ID = 'NewCurve'
>>> x_y_1 = [0, 730]
>>> x_y_2 = [1000, 500]
>>> x_y_3 = [1350, 260]
# X and Y values selected
>>> values = [x_y_1, x_y_2, x_y_3]
# New curve added
>>> curve_index = d.addCurve(new_curve_ID, values)
# Retrieves all the info of curves
>>> d.getCurvesInfo().disp()

See also getCurvesInfo, getCurveType, setCurve,setCurveValue, setCurveNameID, setCurveComment.

addLinkPipe(pipeID, fromNode, toNode, *argv)[source]

Adds a new pipe. Returns the index of the new pipe.

Properties that can be set(optional):

Length
Diameter
Roughness Coefficient
Minor Loss Coefficient

If no properties are given, the default values are:

length = 330 feet (~100.5 m)
diameter = 10 inches (25.4 cm)
roughness coefficient = 130 (Hazen-Williams formula) or
0.15 mm (Darcy-Weisbach formula) or 0.01 (Chezy-Manning formula)
minor Loss Coefficient = 0

The examples are based on d = epanet(“Net1.inp”)

Example 1: Adds a new pipe given no properties.

>>> pipeID = 'newPipe_1'
>>> fromNode = '10'
>>> toNode = '21'
# Retrieves the number of links
>>> d.getLinkPipeCount()
>>> pipeIndex = d.addLinkPipe(pipeID, fromNode, toNode)
>>> d.getLinkPipeCount()
>>> d.plot()

Example 2: Adds a new pipe given it’s length.

>>> pipeID = 'newPipe_2'
>>> fromNode = '11'
>>> toNode = '22'
>>> length = 600
>>> d.getLinkPipeCount()
>>> pipeIndex = d.addLinkPipe(pipeID, fromNode, toNode, length)
>>> d.getLinkPipeCount()
# Retrieves the new link's length
>>> d.getLinkLength(pipeIndex)
>>> d.plot()

Example 3: Adds a new pipe given it’s length, diameter, roughness coefficient and minor loss coefficient.

>>> pipeID = 'newPipe_3'
>>> fromNode = '31'
>>> toNode = '22'
>>> length = 500
>>> diameter = 15
>>> roughness = 120
>>> minorLossCoeff = 0.2
>>> d.getLinkPipeCount()
>>> pipeIndex = d.addLinkPipe(pipeID, fromNode, toNode, length,
>>>                           diameter, roughness, minorLossCoeff)
>>> d.getLinkPipeCount()
>>> d.getLinkLength(pipeIndex)
# Retrieves the new link's diameter
>>> d.getLinkDiameter(pipeIndex)
# Retrieves the new link's roughness coefficient
>>> d.getLinkRoughnessCoeff(pipeIndex)
# Retrieves the new link's minor loss coefficient
>>> d.getLinkMinorLossCoeff(pipeIndex)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipeCV, addNodeJunction, deleteLink, setLinkDiameter.

addLinkPipeCV(cvpipeID, fromNode, toNode, *argv)[source]

Adds a new control valve pipe. Returns the index of the new control valve pipe.

Properties that can be set(optional):

Length
Diameter
Roughness Coefficient
Minor Loss Coefficient

If no properties are given, the default values are:

length = 330 feet (~100.5 m)
diameter = 10 inches (25.4 cm)
roughness coefficient = 130 (Hazen-Williams formula) or
0.15 mm (Darcy-Weisbach formula) or 0.01 (Chezy-Manning formula)
minor Loss Coefficient = 0

The examples are based on d = epanet(‘Net1.inp’)

Example 1: Adds a new control valve pipe given no properties.

>>> cvPipeID = 'newCVPipe_1'
>>> fromNode = '10'
>>> toNode = '21'
# Retrieves the number of pipes
>>> d.getLinkPipeCount()
>>> cvPipeIndex = d.addLinkPipeCV(cvPipeID, fromNode, toNode)
>>> d.getLinkPipeCount()
# Plots the network in a new figure
>>> d.plot()

Example 2: Adds a new control valve pipe given it’s length.

>>> cvPipeID = 'newCVPipe_2'
>>> fromNode = '11'
>>> toNode = '22'
>>> length = 600
>>> d.getLinkPipeCount()
>>> cvPipeIndex = d.addLinkPipeCV(cvPipeID, fromNode, toNode, length)
>>> d.getLinkPipeCount()
# Retrieves the new link's length
>>> d.getLinkLength(cvPipeIndex)
>>> d.plot()

Example 3: Adds a new control valve pipe given it’s length, diameter, roughness coefficient and minor loss coefficient.

>>> cvPipeID = 'newCVPipe_3'
>>> fromNode = '31'
>>> toNode = '22'
>>> length = 500
>>> diameter = 15
>>> roughness = 120
>>> minorLossCoeff = 0.2
>>> d.getLinkPipeCount()
>>> cvPipeIndex = d.addLinkPipeCV(cvPipeID, fromNode, toNode, length,
>>>                               diameter, roughness, minorLossCoeff)
>>> d.getLinkPipeCount()
>>> d.getLinkLength(cvPipeIndex)
# Retrieves the new link's diameter
>>> d.getLinkDiameter(cvPipeIndex)
# Retrieves the new link's roughness coefficient
>>> d.getLinkRoughnessCoeff(cvPipeIndex)
# Retrieves the new link's minor loss coefficient
>>> d.getLinkMinorLossCoeff(cvPipeIndex)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe, addNodeJunction, deleteLink, setLinkDiameter.

addLinkPump(pumpID, fromNode, toNode, *argv)[source]

Adds a new pump. Returns the index of the new pump.

Parameters

pumpIDstring: Pump ID.
fromNodenumeric: Starting node.
toNodenumeric: End node.

Returns

indexnumeric

new Pumps index

Properties that can be set(optional):

Initial Status
Initial Speed setting
Power
Pattern index

If no properties are given, the default values are:

initial status = 1 (OPEN)
initial speed setting = 1
power = 0
pattern index = 0

Examples

The examples are based on d = epanet(‘Net1.inp’)

Example 1: Adds a new pump given no properties.

>>> pumpID = 'newPump_1'
>>> fromNode = '10'
>>> toNode = '21'
# Retrieves the number of pumps
>>> d.getLinkPumpCount()
>>> pumpIndex = d.addLinkPump(pumpID, fromNode, toNode)
>>> d.getLinkPumpCount()
# Plots the network in a new figure
>>> d.plot()

Example 2: Adds a new pump given it’s initial status.:

>>> pumpID = 'newPump_2'
>>> fromNode = '31'
>>> toNode = '22'
>>> initialStatus = 0    # (CLOSED)
>>> d.getLinkPumpCount()
>>> pumpIndex = d.addLinkPump(pumpID, fromNode, toNode, initialStatus)
>>> d.getLinkPumpCount()

# Retrieves the new pump’s initial status >>> d.getLinkInitialStatus(pumpIndex) >>> d.plot()

Example 3: Adds a new pump given it’s initial status, initial speed setting, power and pattern index.

>>> pumpID = 'newPump_3'
>>> fromNode = '11'
>>> toNode = '22'
>>> initialStatus = 1    # (OPEN)
>>> initialSetting = 1.2
>>> power = 10
>>> patternIndex = 1
>>> d.getLinkPumpCount()
>>> pumpIndex = d.addLinkPump(pumpID, fromNode, toNode, initialStatus,
>>>                           initialSetting, power, patternIndex)
>>> d.getLinkPumpCount()
>>> d.getLinkInitialStatus(pumpIndex)
# Retrieves the new pump's initial setting
>>> d.getLinkInitialSetting(pumpIndex)
# Retrieves the new pump's power
>>> d.getLinkPumpPower(pumpIndex)
# Retrieves the new pump's pattern index
>>> d.getLinkPumpPatternIndex(pumpIndex)
>>> d.plot()

See also: plot, setLinkNodesIndex, addLinkPipe, addNodeJunction, deleteLink, setLinkInitialStatus.

addLinkValveFCV(vID, fromNode, toNode)[source]

Adds a new FCV valve. Returns the index of the new FCV valve.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValveFCV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValveFCV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,: addLinkValvePRV, deleteLink, setLinkTypeValveTCV.

addLinkValveGPV(vID, fromNode, toNode)[source]

Adds a new GPV valve. Returns the index of the new GPV valve.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValveGPV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValveGPV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,: addLinkValvePRV, deleteLink, setLinkTypeValveFCV.

addLinkValvePCV(vID, fromNode, toNode)[source]

Adds a new PCV valve. Returns the index of the new PCV valve.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValvePCV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValvePCV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,: addLinkValvePCV, deleteLink, setLinkTypeValvePCV.

addLinkValvePBV(vID, fromNode, toNode)[source]

Adds a new PBV valve. Returns the index of the new PBV valve.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValvePBV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValvePBV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,
addLinkValvePRV, deleteLink, setLinkTypeValvePRV.

addLinkValvePRV(vID, fromNode, toNode)[source]

Adds a new PRV valve. Returns the index of the new PRV valve.

# The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValvePRV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValvePRV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,: addLinkValvePSV, deleteLink, setLinkTypeValveFCV.

addLinkValvePSV(vID, fromNode, toNode)[source]

Adds a new PSV valve. Returns the index of the new PSV valve.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValvePSV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValvePSV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,: addLinkValvePRV, deleteLink, setLinkTypeValveGPV.

addLinkValveTCV(vID, fromNode, toNode)[source]

Adds a new TCV valve. Returns the index of the new TCV valve.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> valveID = 'newValveTCV'
>>> fromNode = '10'
>>> toNode = '21'
>>> valveIndex = d.addLinkValveTCV(valveID, fromNode, toNode)
>>> d.plot()

See also plot, setLinkNodesIndex, addLinkPipe,: addLinkValvePRV, deleteLink, setLinkTypeValveFCV.

addNodeJunction(juncID, *argv)[source]

Adds new junction

Returns the index of the new junction.

The following data can be set(optional):

Coordinates
Elevation
Primary base demand
ID name of the demand’s time pattern

Example 1: Adds a new junction with the default coordinates (i.e. [0, 0]).

>>> junctionID = 'newJunction_1'
>>> junctionIndex = d.addNodeJunction(junctionID)
>>> d.plot()

Example 2: Adds a new junction with coordinates [X, Y] = [20, 10].

>>> junctionID = 'newJunction_2'
>>> junctionCoords = [20, 10]
>>> junctionIndex = d.addNodeJunction(junctionID, junctionCoords)
>>> d.plot(highlightnode=junctionIndex)

Example 3: Adds a new junction with coordinates [X, Y] = [20, 20] and elevation = 500.

>>> junctionID = 'newJunction_3'
>>> junctionCoords = [20, 20]
>>> junctionElevation = 500
>>> junctionIndex = d.addNodeJunction(junctionID, junctionCoords,
>>>                                   junctionElevation)
>>> d.getNodeElevations(junctionIndex)
>>> d.plot()

Example 4: Adds a new junction with coordinates [X, Y] = [10, 40], elevation = 500 and demand = 50.

>>> junctionID = 'newJunction_4'
>>> junctionCoords = [10, 40]
>>> junctionElevation = 500
>>> demand = 50
>>> junctionIndex = d.addNodeJunction(junctionID, junctionCoords,
>>>                                   junctionElevation, demand)
>>> d.getNodeBaseDemands(junctionIndex)
>>> d.plot()

Example 5: Adds a new junction with coordinates [X, Y] = [10, 20], elevation = 500, demand = 50 and pattern ID = the 1st time pattern ID(if exists).

>>> junctionID = 'newJunction_5'
>>> junctionCoords = [10, 20]
>>> junctionElevation = 500
>>> demand = 50
>>> demandPatternID = d.getPatternNameID(1)
>>> junctionIndex = d.addNodeJunction(junctionID, junctionCoords,
>>>                                   junctionElevation, demand,
>>>                                   demandPatternID)
>>> d.getNodeDemandPatternNameID()[1][junctionIndex-1]
>>> d.plot()

See also plot, setLinkNodesIndex, addNodeReservoir, setNodeComment, deleteNode, setNodeBaseDemands.

addNodeJunctionDemand(*argv)[source]

Adds a new demand to a junction given the junction index, base demand, demand time pattern and demand category name. Returns the values of the new demand category index. A blank string can be used for demand time pattern and demand name category to indicate that no time pattern or category name is associated with the demand.

Example 1: New demand added with the name ‘new demand’ to the 1st node, with 100 base demand, using the 1st time pattern.

>>> d.addNodeJunctionDemand(1, 100, '1', 'new demand')
# Retrieves the indices of all demands for all nodes.
>>> d.getNodeJunctionDemandIndex()
# Retrieves the demand category names of the 2nd demand index.
>>> d.getNodeJunctionDemandName()[2]

Example 2: New demands added with the name ‘new demand’ to the 1st and 2nd node, with 100 base demand, using the 1st time pattern.

>>> d.addNodeJunctionDemand([1, 2], 100, '1', 'new demand')
# Retrieves the indices of all demands for all nodes.
>>> d.getNodeJunctionDemandIndex()
# Retrieves the demand category names of the 2nd demand index.
>>> d.getNodeJunctionDemandName()[2]

Example 3: New demands added with the name ‘new demand’ to the 1st and 2nd node, with 100 and 110 base demand respectively, using the 1st time pattern.

>>> d.addNodeJunctionDemand([1, 2], [100, 110], '1', 'new demand')
# Retrieves the indices of all demands for all nodes.
>>> d.getNodeJunctionDemandIndex()
# Retrieves the demand category names of the 2nd demand index
>>> d.getNodeJunctionDemandName()[2]     .

Example 4: New demands added with the name ‘new demand’ to the 1st and 2nd node, with 100 and 110 base demand respectively, using the 1st

time pattern.

>>> d.addNodeJunctionDemand([1, 2], [100, 110], ['1', '1'],
>>>                         'new demand')
# Retrieves the indices of all demands for all nodes.
>>> d.getNodeJunctionDemandIndex()
# Retrieves the demand category names of the 2nd demand index.
>>> d.getNodeJunctionDemandName()[2]

Example 5: New demands added with the names ‘new demand1’ and ‘new demand2’ to the 1st and 2nd node, with 100 and 110 base demand respectively, using the 1st and 2nd(if exists) time pattern respectively.

>>> d.addNodeJunctionDemand([1, 2], [100, 110], ['1', '2'],
>>>                         ['new demand1', 'new demand2'])
# Retrieves the indices of all demands for all nodes.
>>> d.getNodeJunctionDemandIndex()
# Retrieves the demand category names of the 2nd demand index.
>>> d.getNodeJunctionDemandName()[2]
See also deleteNodeJunctionDemand, getNodeJunctionDemandIndex,
getNodeJunctionDemandName, setNodeJunctionDemandName,
getNodeBaseDemands.

addNodeReservoir(resID, *argv)[source]

Adds a new reservoir. Returns the index of the new reservoir.

Example 1: Adds a new reservoir with the default coordinates (i.e. [0, 0])

>>> reservoirID = 'newReservoir_1'
>>> reservoirIndex = d.addNodeReservoir(reservoirID)
>>> d.plot()

Example 2: Adds a new reservoir with coordinates [X, Y] = [20, 30].

>>> reservoirID = 'newReservoir_2'
>>> reservoirCoords = [20, 30]
>>> reservoirIndex = d.addNodeReservoir(reservoirID, reservoirCoords)
>>> d.plot()

See also plot, setLinkNodesIndex, addNodeJunction, self.addLinkPipe, deleteNode, setNodeBaseDemands.

addNodeTank(tankID, *argv)[source]

Adds a new tank. Returns the index of the new tank.

Example 1: Adds a new tank with the default coordinates (i.e. [0, 0])

>>> tankID = 'newTank_1'
>>> tankIndex = d.addNodeTank(tankID)
>>> d.plot()

Example 2: Adds a new tank with coordinates [X, Y] = [10, 10]. >>> tankID = ‘newTank_2’ >>> tankCoords = [10, 10] >>> tankIndex = d.addNodeTank(tankID, tankCoords) >>> d.plot()

Example 3: Adds a new tank with coordinates [X, Y] = [20, 20] and elevation = 100.

>>> tankID = 'newTank_3'
>>> tankCoords = [20, 20]
>>> elevation = 100
>>> tankIndex = d.addNodeTank(tankID, tankCoords, elevation)
>>> d.plot()

Example 4: Adds a new tank with coordinates [X, Y] = [20, 30], elevation = 100, initial level = 130, minimum water level = 110, maximum water level = 160, diameter = 60, minimum water volume = 200000, volume curve ID = ‘’.

>>> tankID = 'newTank_4'
>>> tankCoords = [20, 30]
>>> elevation = 100
>>> initialLevel = 130
>>> minimumWaterLevel = 110
>>> maximumWaterLevel = 160
>>> diameter = 60
>>> minimumWaterVolume = 200000
>>> volumeCurveID = ''   # Empty for no curve
>>> tankIndex = d.addNodeTank(tankID, tankCoords, elevation,
>>>                           initialLevel, minimumWaterLevel,
>>>                           maximumWaterLevel, diameter,
>>>                           minimumWaterVolume, volumeCurveID)
>>> t_data = d.getNodeTankData(tankIndex)
>>> d.plot()

See also plot, setLinkNodesIndex, addNodeJunction, addLinkPipe, deleteNode, setNodeBaseDemands.

addPattern(*argv)[source]

Adds a new time pattern to the network.

Example 1:

# Retrieves the ID labels of time patterns >>> d.getPatternNameID() >>> patternID = ‘new_pattern’ # Adds a new time pattern given it’s ID >>> patternIndex = d.addPattern(patternID) >>> patternIndex = d.addPattern(patternID+’2’, 1) >>> d.getPatternNameID()

Example 2:

>>> patternID = 'new_pattern'
>>> patternMult = [1.56, 1.36, 1.17, 1.13, 1.08,
... 1.04, 1.2, 0.64, 1.08, 0.53, 0.29, 0.9, 1.11,
... 1.06, 1.00, 1.65, 0.55, 0.74, 0.64, 0.46,
... 0.58, 0.64, 0.71, 0.66]
# Adds a new time pattern given ID and the multiplier
>>> patternIndex = d.addPattern(patternID, patternMult)
>>> d.getPatternNameID()
>>> d.getPattern()

See also getPattern, setPattern, setPatternNameID, setPatternValue, setPatternComment.

addRules(rule)[source]

Adds a new rule-based control to a project.

Note

Rule format: Following the format used in an EPANET input
file.

‘RULE ruleid

IF object objectid attribute relation: attributevalue
THEN object objectid: STATUS/SETTING IS value

PRIORITY value’

See more: ‘https://nepis.epa.gov/Adobe/PDF/P1007WWU.pdf’ (Page 164)

The example is based on d = epanet(‘Net1.inp’)

Example: >>> d.getRuleCount() >>> d.addRules(‘RULE RULE-1

IF TANK 2 LEVEL >= 140 THEN PUMP 9

>>>             STATUS IS CLOSED 

PRIORITY 1’)

>>> d.getRuleCount()
>>> d.getRules()[1]['Rule']

See also deleteRules, setRules, getRules, getRuleInfo, setRuleThenAction, setRuleElseAction, setRulePriority.

appRotateNetwork(theta, indexRot=0)[source]

Rotates the network by theta degrees counter-clockwise, using as pivot the indexRot theta: angle in degrees to rotate the network counter-clockwise indexRot: index of the node/point to be rotated. If it’s not provided then the first index node is used as pivot.

Example 1: Rotate the network by 60 degrees counter-clockwise around the index 1 node. >>> d = epanet(‘Net1.inp’) >>> d.plot() >>> d.appRotateNetwork(60) >>> d.plot()

Example 2: Rotate the network by 150 degrees counter-clockwise around the reservoir with index 921. >>> d = epanet(‘ky10.inp’) >>> d.plot() >>> d.appRotateNetwork(150,921) >>> d.plot()

appShiftNetwork(xDisp, yDisp)[source]

Shifts the network by xDisp in the x-direction and by yDisp in the y-direction

Example 1: Shift the network by 1000 feet in the x-axis and -1000 feet in the y-axis

>>> d = epanet('Net1.inp')
>>> d.getNodeCoordinates(1) # old x coordinates
>>> d.getNodeCoordinates(2) # old y coordinates
>>> d.appShiftNetwork(1000,-1000)
>>> d.getNodeCoordinates(1) # new x coordinates
>>> d.getNodeCoordinates(2) # new y coordinates

Example 2: Shift the network,along with the vertices by 1000 feet in the x-axis and -1000 feet in the y-axis

>>> d = epanet('ky10.inp')
>>> d.appShiftNetwork(1000,-1000)
>>> d.plot()

arange(begin, end, step=1)[source]: Create float number sequence

clearReport()[source]

Clears the contents of a project’s report file.

Example:

>>> d.clearReport()

See also writeReport, writeLineInReportFile, copyReport.

closeHydraulicAnalysis()[source]

Closes the hydraulic analysis system, freeing all allocated memory.

Example:

>>> d.closeHydraulicAnalysis()

For more, you can type help getNodePressure and check examples 3 & 4.

See also openHydraulicAnalysis, saveHydraulicFile, closeQualityAnalysis.

closeNetwork()[source]

Closes down the Toolkit system.

Example:

>>> d.closeNetwork()

See also loadEPANETFile, closeHydraulicAnalysis, closeQualityAnalysis.

closeQualityAnalysis()[source]

Closes the water quality analysis system, freeing all allocated memory.

Example:

>>> d.closeQualityAnalysis()

For more, you can type help (d.epanet.getNodePressure) and check examples 3 & 4.

See also openQualityAnalysis, initializeQualityAnalysis, closeHydraulicAnalysis.

copyReport(fileName)[source]

Copies the current contents of a project’s report file to another file.

Example:

>>> fileName = 'Report_copy'
>>> d.copyReport(fileName)

See also writeReport, writeLineInReportFile, clearReport.

createProject()[source]: Creates a new epanet project

deleteAllTemps()[source]: Delete all temporary files (.inp, .bin) created in networks folder

deleteControls(*argv)[source]

Deletes an existing simple control.

Example 1:

# Retrieves the parameters of all controls >>> d.getControls() # Deletes the existing simple controls >>> d.deleteControls() >>> d.getControls()

Example 2:

# Adds a new simple control(index = 3) >>> index = d.addControls(‘LINK 9 43.2392 AT TIME 4:00:00’) >>> d.getControls(index) # Deletes the 3rd simple control >>> d.deleteControls(index) >>> d.getControls()

Example 3:

# Adds a new simple control(index = 3) >>> index_3 = d.addControls(‘LINK 9 43.2392 AT TIME 4:00:00’) # Adds a new simple control(index = 4) >>> index_4 = d.addControls(‘LINK 10 43.2392 AT TIME 4:00:00’) >>> d.getControls(index_3) >>> d.getControls(index_4) # Deletes the 3rd and 4th simple controls >>> d.deleteControls([index_3, index_4]) >>> d.getControls()

See also addControls, setControls, getControls, getControlCount.

deleteCurve(idCurve)[source]

Deletes a data curve from a project.

Example 1:

>>> d = epanet('BWSN_Network_1.inp')
# Retrieves the ID of the 1st curve
>>> idCurve = d.getCurveNameID(1)
#  Deletes a curve given it's ID
>>> d.deleteCurve(idCurve)
>>> d.getCurveNameID()

Example 2:

>>> index = 1
>>> d.deleteCurve(index)             # Deletes a curve given it's index
>>> d.getCurveNameID()

See also addCurve, setCurve, setCurveNameID, setCurveValue, setCurveComment.

deleteLink(idLink, *argv)[source]

Deletes a link.

condition = 0 | if is EN_UNCONDITIONAL: Deletes all controls and rules related to the object condition = 1 | if is EN_CONDITIONAL: Cancel object deletion if contained in controls and rules Default condition is 0.

Example 1:

# Retrieves the ID label of all links >>> d.getLinkNameID() # Retrieves the ID label of the 1st link >>> idLink = d.getLinkNameID(1) # Deletes the 1st link given it’s ID >>> d.deleteLink(idLink) >>> d.getLinkNameID()

Example 2:

>>> idLink = d.getLinkPumpNameID(1)
>>> condition = 1
# Attempts to delete a link contained in controls (error occurs)
>>> d.deleteLink(idLink, condition)

Example 3:

>>> indexLink = 1
# Deletes the 1st link given it's index
>>> d.deleteLink(indexLink)
>>> d.getLinkNameID()

See also addLinkPipe, deleteNode, deleteRules, setNodeCoordinates, setLinkPipeData.

deleteNode(idNode, *argv)[source]

Deletes nodes.

condition = 0 | if is EN_UNCONDITIONAL: Deletes all controls, rules and links related to the object condition = 1 | if is EN_CONDITIONAL: Cancel object deletion if contained in controls, rules and links Default condition is 0.

Example 1:

# Retrieves the total number of all nodes >>> d.getNodeCount() # Retrieves the ID label of the 1st node >>> idNode = d.getNodeNameID(1) # Deletes the 1st node given it’s ID >>> d.deleteNode(idNode) >>> d.getNodeCount()

Example 2:

>>> idNode = d.getNodeNameID(1)
>>> condition = 1
# Attempts to delete a node connected to links (error occurs)
>>> d.deleteNode(idNode, condition)

Example 3:

>>> index = 1
# Deletes the 1st node given it's index
>>> d.deleteNode(index)
>>> d.getNodeNameID()

Example 4:

>>> idNodes = d.getNodeNameID([1,2])
>>> d.getNodeCount()
# Deletes 2 nodes given their IDs
>>> d.deleteNode(idNodes)
>>> d.getNodeCount()

See also addNodeJunction, deleteLink, deleteRules, setNodeCoordinates, setNodeJunctionData.

deleteNodeJunctionDemand(*argv)[source]

Deletes a demand from a junction given the junction index and demand index. Returns the remaining(if exist) node demand indices.

Example 1:

>>> nodeIndex = 1
>>> baseDemand = 100
>>> patternId = '1'
>>> categoryIndex = 1
# Retrieves the indices of all demands for the 1st node
>>> d.getNodeJunctionDemandIndex(nodeIndex)
# Retrieves the names of all nodes demand category
>>> d.getNodeJunctionDemandName()
# Retrieves the name of the 1st demand category of the 1st node
>>> d.getNodeJunctionDemandName()[categoryIndex][nodeIndex-1]
# Adds a new demand to the 1st node and returns the new
# demand index
>>> categoryIndex = d.addNodeJunctionDemand(nodeIndex, baseDemand,
>>>                                         patternId, 'new demand')
# Retrieves the indices of all demands for the 1st node
>>> d.getNodeJunctionDemandIndex(nodeIndex)
# Retrieves the names of all nodes demand category
>>> d.getNodeJunctionDemandName()
# Retrieves the name of the 2nd demand category of the 1st node
>>> d.getNodeJunctionDemandName()[categoryIndex][nodeIndex-1]
# Deletes the 2nd demand of the 1st node
>>> d.deleteNodeJunctionDemand(1, 2)
>>> d.getNodeJunctionDemandIndex(nodeIndex)

Example 2:

>>> nodeIndex = 1
>>> baseDemand = 100
>>> patternId = '1'
# Adds a new demand to the first node and returns the new demand index
>>> categoryIndex_2 = d.addNodeJunctionDemand(nodeIndex,
...                                           baseDemand,
...                                           patternId,
...                                           'new demand_2')
# Adds a new demand to the first node and returns the new demand index
>>> categoryIndex_3 = d.addNodeJunctionDemand(nodeIndex,
...                                           baseDemand,
...                                           patternId,
...                                           'new demand_3')
# Retrieves the name of the 2nd demand category of the 1st node
>>> d.getNodeJunctionDemandName()[categoryIndex_2][nodeIndex-1]
# Deletes all the demands of the 1st node
>>> d.deleteNodeJunctionDemand(1)
# Retrieves the indices of all demands for the 1st node
>>> d.getNodeJunctionDemandIndex(nodeIndex)

Example 3:

>>> nodeIndex = [1, 2, 3]
>>> baseDemand = [100, 110, 150]
>>> patternId = ['1', '1', '']
# Adds 3 new demands to the first 3 nodes
>>> categoryIndex = d.addNodeJunctionDemand(nodeIndex, baseDemand,
...                                         patternId, ['new demand_1',
...                                         'new demand_2',
...                                         'new demand_3'])
# Deletes all the demands of the first 3 nodes
>>> d.getNodeJunctionDemandName()[2]
>>> d.getNodeJunctionDemandIndex(nodeIndex)
>>> d.deleteNodeJunctionDemand([1,2,3])
>>> d.getNodeJunctionDemandIndex(nodeIndex)

See also addNodeJunctionDemand, getNodeJunctionDemandIndex, getNodeJunctionDemandName, setNodeJunctionDemandName, getNodeBaseDemands.

deletePattern(idPat)[source]

Deletes a time pattern from a project.

Example 1:

# Retrieves the ID of the 1st pattern >>> idPat = d.getPatternNameID(1) # Deletes the 1st pattern given it’s ID >>> d.deletePattern(idPat) >>> d.getPatternNameID()

Example 2:

>>> index = 1
# Deletes the 1st pattern given it's index
>>> d.deletePattern(index)
>>> d.getPatternNameID()

See also deletePatternsAll, addPattern, setPattern, setPatternNameID, setPatternValue, setPatternComment.

deletePatternsAll()[source]

Deletes all time patterns from a project.

Example 1:

>>> d.getPatternNameID()        # Retrieves the IDs of all the patterns
>>> d.deletePatternsAll()       # Deletes all the patterns
>>> d.getPatternNameID()

See also deletePattern, addPattern, setPattern, setPatternNameID, setPatternValue, setPadtternComment.

deleteProject()[source]: Deletes the epanet project

deleteRules(*argv)[source]

Deletes an existing rule-based control given it’s index. Returns error code.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getRuleCount()        # Retrieves the number of rules
>>> d.deleteRules()         # Deletes all the rule-based control
>>> d.getRuleCount()

Example 2:

>>> d.deleteRules(1)        # Deletes the 1st rule-based control
>>> d.getRuleCount()

Example 3:

>>> d.deleteRules([1,2,3])  # Deletes the 1st to 3rd rule-based control
>>> d.getRuleCount()

See also addRules, getRules, setRules, getRuleCount().

getENfunctionsImpemented()[source]

Retrieves the epanet functions that have been developed.

Example:

>>> d.getENfunctionsImpemented()

See also setCurveValue, getCurvesInfo.

setCurveComment(value, *argv)[source]

Sets the comment string of a curve.

Example 1:

>>> d.getCurveComment()                      # Retrieves the comments of all the curves
>>> curveIndex = 1
>>> comment = 'This is a curve'
>>> d.setCurveComment(curveIndex, comment)   # Sets a comment to the 1st curve
>>> d.getCurveComment(curveIndex)

Example 2:

>>> d = epanet('BWSN_Network_1.inp')
>>> d.getCurveComment()
>>> curveIndex = [1,2]
>>> comment = ['This is the 1st curve', 'This is the 2nd curve']
>>> d.setCurveComment(curveIndex, comment)   # Sets comments to the first 2 curves
>>> d.getCurveComment(curveIndex)

See also getCurveComment, getCurveIndex, getCurvesInfo.

setCurveNameID(index, Id)[source]

Sets the name ID of a curve given it’s index and the new ID.

Example 1:

>>> d.getCurveNameID()                               # Retrieves the name IDs of all the curves
>>> d.setCurveNameID(1, 'Curve1')                    # Sets to the 1st curve the new name ID 'Curve1'
>>> d.getCurveNameID()

Example 2: Sets to the 1st and 2nd curve the new name IDs ‘Curve1’ and ‘Curve2’ respectively.

>>> d.setCurveNameID([1, 2], ['Curve1', 'Curve2'])
>>> d.getCurveNameID()

See also getCurveNameID, getCurveIndex, getCurveLengths, setCurve, setCurveComment, getCurveComment.

setCurveValue(index, curvePnt, value)[source]

Sets x, y point for a specific point number and curve.

The example is based on d = epanet(‘BWSN_Network_1.inp’)

Example:

>>> curveIndex = 1
>>> d.getCurvesInfo().CurveXvalue[curveIndex-1]            # Retrieves the X values of the 1st curve
>>> d.getCurvesInfo().CurveYvalue[curveIndex-1]            # Retrieves the Y values of the 1st curve
>>> curvePoint = 1                                         # Point of the curve selected
>>> x_y_values = [10, 400]                                 # X and Y values selected
>>> d.setCurveValue(curveIndex, curvePoint, x_y_values)    # Sets the X and Y values of the 1st point on the 1st curve
>>> d.getCurvesInfo().CurveXvalue[curveIndex-1]
>>> d.getCurvesInfo().CurveYvalue[curveIndex-1]

See also getCurveValue, setCurve, getCurvesInfo.

setDemandModel(code, pmin, preq, pexp)[source]

Sets the type of demand model to use and its parameters.

Parameters:

code (str) – Type of demand model * ‘DDA’ = Demand driven analysis (in which case the remaining three parameter values are ignored) * ‘PDA’ = Pressure driven analysis
pmin (float) – Pressure below which there is no demand
preq (float) – Pressure required to deliver full demand
pexp (float) – Pressure exponent in demand function

Returns:

None

Example:

>>> d.getDemandModel().disp()                  # Print the demand model
>>> type = 'PDA'
>>> pmin = 0
>>> preq = 0.1
>>> pexp = 0.5
>>> d.setDemandModel(type, pmin, preq, pexp)   # Sets the demand model
>>> d.getDemandModel().to_dict()

See also getDemandModel, setNodeBaseDemands, setNodeJunctionDemandName, addNodeJunctionDemand, deleteNodeJunctionDemand.

setFlowUnitsAFD(*argv)[source]

Sets flow units to AFD(Acre-Feet per Day).

Example:

>>> d.setFlowUnitsAFD()   # d.setFlowUnitsAFD('NET1_AFD.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsCFS(*argv)[source]

Sets flow units to CFS(Cubic Feet per Second).

Example:

>>> d.setFlowUnitsCFS()   # d.setFlowUnitsCFS('NET1_CFS.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsCMD(*argv)[source]

Sets flow units to CMD(Cubic Meters per Day).

Example:

>>> d.setFlowUnitsCMD()  #  d.setFlowUnitsCMD('NET1_CMD.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsCMH(*argv)[source]

Sets flow units to CMH(Cubic Meters per Hour).

Example:

>>> d.setFlowUnitsCMH()   # d.setFlowUnitsCMH('NET1_CMH.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsCMS(*argv)[source]

Sets flow units to CMS(Cubic Meters per Second).

Example:

>>> d.setFlowUnitsCMS()
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsGPM(*argv)[source]

Sets flow units to GPM(Gallons Per Minute).

Example:

>>> d.setFlowUnitsGPM()   # d.setFlowUnitsGPM('NET1_GPM.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsIMGD(*argv)[source]

Sets flow units to IMGD(Imperial Million Gallons per Day).

Example:

>>> d.setFlowUnitsIMGD()   # d.setFlowUnitsIMGD('NET1_IMGD.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsLPM(*argv)[source]

Sets flow units to LPM(Liters Per Minute).

Example:

>>> d.setFlowUnitsLPM()   #  d.setFlowUnitsLPM('NET1_LPM.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsLPS(*argv)[source]

Sets flow units to LPS(Liters Per Second).

Example:

>>> d.setFlowUnitsLPS()   #  d.setFlowUnitsLPS('NET1_LPS.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsMGD(*argv)[source]

Sets flow units to MGD(Million Gallons per Day).

Example:

>>> d.setFlowUnitsMGD()   #  d.setFlowUnitsMGD('NET1_MGD.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setFlowUnitsMLD(*argv)[source]

Sets flow units to MLD(Million Liters per Day).

Example:

>>> d.setFlowUnitsMLD()   #  d.setFlowUnitsMLD('NET1_MLD.inp')
>>> d.getFlowUnits()

See also: # Functions for PSI (sorted by higher to lower capacity): setFlowUnitsAFD() ### Acre-feet per day (higher capacity than GPM) setFlowUnitsIMGD() ### Imperial million gallons per day (higher capacity than AFD) setFlowUnitsCFS() ### Cubic feet per second (higher capacity than IMGD) setFlowUnitsMGD() ### Million gallons per day (similar capacity to IMGD) setFlowUnitsGPM() ### Gallons per minute (lower capacity than AFD, IMGD, CFS, and MGD)

Functions for KPA and meters (sorted by higher to lower capacity): setFlowUnitsCMH() ### Cubic meters per hour (higher capacity than CMS) setFlowUnitsCMS() ### Cubic meters per second (higher capacity than LPS) setFlowUnitsMLD() ### Million liters per day (higher capacity than CMD and LPM) setFlowUnitsCMD() ### Cubic meters per day (lower capacity than MLD) setFlowUnitsLPS() ### Liters per second (lower capacity than CMH and CMS) setFlowUnitsLPM() ### Liters per minute (lower capacity than LPS)

setLinkBulkReactionCoeff(value, *argv)[source]

Sets the value of bulk chemical reaction coefficient.

Example 1:

>>> index_pipe = 1
>>> d.getLinkBulkReactionCoeff(index_pipe)              # Retrieves the bulk chemical reaction coefficient of the 1st link
>>> coeff = 0
>>> d.setLinkBulkReactionCoeff(index_pipe, coeff)       # Sets the bulk chemical reaction coefficient of the 1st link
>>> d.getLinkBulkReactionCoeff(index_pipe)

Example 2:

>>> coeffs = d.getLinkBulkReactionCoeff()               # Retrieves the bulk chemical reaction coefficients of all links
>>> coeffs_new = [0 for i in coeffs]
>>> d.setLinkBulkReactionCoeff(coeffs_new)              # Sets the bulk chemical reaction coefficient of all links
>>> d.getLinkBulkReactionCoeff()

See also getLinkBulkReactionCoeff, setLinkRoughnessCoeff, setLinkPipeData, addLink, deleteLink.

setLinkComment(value, *argv)[source]

Sets the comment string assigned to the link object.

Example 1:

>>> linkIndex = 1
>>> d.getLinkComment(linkIndex)
>>> comment = 'This is a link'
>>> d.setLinkComment(linkIndex, comment)   # Sets a comment to the 1st link
>>> d.getLinkComment(linkIndex)

Example 2:

>>> linkIndex = [1, 2]
>>> d.getLinkComment(linkIndex)
>>> comment = ['This is link 1', 'This is link 2']
>>> d.setLinkComment(linkIndex, comment)   # Sets comments to the first 2 links
>>> d.getLinkComment(linkIndex)

See also getLinkComment, setLinkNameID, setLinkPipeData.

setLinkDiameter(value, *argv)[source]

Sets the values of diameters.

Example 1:

>>> d.getLinkDiameter()                           # Retrieves the diameters of all links
>>> index_pipe = 1
>>> diameter = 20
>>> d.setLinkDiameter(index_pipe, diameter)       # Sets the diameter of the 1st pipe
>>> d.getLinkDiameter(index_pipe)

Example 2:

>>> index_pipes = [1, 2]
>>> diameters = [20, 25]
>>> d.setLinkDiameter(index_pipes, diameters)     # Sets the diameters of the first 2 pipes
>>> d.getLinkDiameter(index_pipes)

Example 3:

>>> diameters = d.getLinkDiameter()
>>> diameters = diameters * 1.5
>>> d.setLinkDiameter(diameters)                  # Sets the diameters of all the links
>>> d.getLinkDiameter()

See also setLinkPipeData, setLinkLength, setLinkBulkReactionCoeff, setLinkTypePipe.

setLinkInitialSetting(value, *argv)[source]

Sets the values of initial settings, roughness for pipes or initial speed for pumps or initial setting for valves.

Example 1:

>>> index_pipe = 1
>>> d.getLinkInitialSetting(index_pipe)                 # Retrieves the initial setting of the 1st link
>>> setting = 80
>>> d.setLinkInitialSetting(index_pipe, setting)        # Sets the initial setting of the 1st link
>>> d.getLinkInitialSetting(index_pipe)

Example 2:

>>> settings = d.getLinkInitialSetting()                # Retrieves the initial setting of all links
>>> settings_new = settings + 140
>>> d.setLinkInitialSetting(settings_new)               # Sets the initial setting of all links
>>> d.getLinkInitialSetting()

See also getLinkInitialSetting, setLinkInitialStatus, setLinkRoughnessCoeff, setLinkPipeData, addLink, deleteLink.

setLinkInitialStatus(value, *argv)[source]

Sets the values of initial status.

Note: Cannot set status for a check valve

Example 1:

>>> index_pipe = 1
>>> d.getLinkInitialStatus(index_pipe)                # Retrieves the initial status of the 1st link
>>> status = 0
>>> d.setLinkInitialStatus(index_pipe, status)        # Sets the initial status of the 1st link
>>> d.getLinkInitialStatus(index_pipe)

Example 2:

>>> statuses = d.getLinkInitialStatus()                 # Retrieves the initial status of all links
>>> statuses_new = np.zeros(len(statuses))
>>> d.setLinkInitialStatus(statuses_new)                # Sets the initial status of all links
>>> d.getLinkInitialStatus()

See also getLinkInitialStatus, setLinkInitialSetting, setLinkDiameter, setLinkPipeData, addLink, deleteLink.

setLinkLength(value, *argv)[source]

Sets the values of lengths.

Example 1:

>>> index_pipe = 1
>>> d.getLinkLength(index_pipe)                   # Retrieves the length of the 1st link
>>> length_pipe = 100
>>> d.setLinkLength(index_pipe, length_pipe)      # Sets the length of the 1st link
>>> d.getLinkLength(index_pipe)

Example 2:

>>> lengths = d.getLinkLength()                   # Retrieves the lengths of all the links
>>> lengths_new = [i * 1.5 for i in lengths]
>>> d.setLinkLength(lengths_new)                  # Sets the new lengths of all links
>>> d.getLinkLength()

See also getLinkLength, setLinkDiameter, setLinkMinorLossCoeff, setLinkPipeData, addLink, deleteLink.

setLinkMinorLossCoeff(value, *argv)[source]

Sets the values of minor loss coefficient.

Example 1:

>>> index_pipe = 1
>>> d.getLinkMinorLossCoeff(index_pipe)               # Retrieves the minor loss coefficient of the 1st link
>>> coeff = 105
>>> d.setLinkMinorLossCoeff(index_pipe, coeff)        # Sets the minor loss coefficient of the 1st link
>>> d.getLinkMinorLossCoeff(index_pipe)

Example 2:

>>> coeffs = d.getLinkMinorLossCoeff()                # Retrieves the minor loss coefficients of all the links
>>> coeffs_new = coeffs + 0.2
>>> d.setLinkMinorLossCoeff(coeffs_new)               # Sets the minor loss coefficient of all links
>>> d.getLinkMinorLossCoeff()

See also getLinkMinorLossCoeff, setLinkDiameter, setLinkRoughnessCoeff, setLinkPipeData, addLink, deleteLink.

setLinkNameID(value, *argv)[source]

Sets the ID name for links.

Example 1:

>>> index_pipe = 1
>>> d.getLinkNameID(index_pipe)         # Retrieves the ID of the 1st link
>>> linkID = 'New_ID'                   # ID selected without a space in between the letters
>>> d.setLinkNameID(index_pipe, linkID) # Sets the ID name of the 1st link
>>> d.getLinkNameID(index_pipe)

Example 2: (the size of the cell must equal to the number of links)

>>> IDs = ['1', '2', '3', '4']          # Select the IDS of the first four links
>>> d.setLinkNameID(IDs)                # Sets the ID names of the first four links
>>> d.getLinkNameID()

See also getLinkNameID, setLinkComment, setLinkDiameter, setLinkPipeData, addLink, deleteLink.

setLinkNodesIndex(linkIndex, startNode, endNode)[source]

Sets the indexes of a link’s start- and end-nodes.

Example 1: Sets to the 1st link the start-node index = 2 and end-node index = 3

>>> d.getLinkNodesIndex()   # Retrieves the indexes of the from/to nodes of all links
>>> linkIndex = 1
>>> startNode = 2
>>> endNode   = 3
>>> d.setLinkNodesIndex(linkIndex, startNode, endNode)
>>> d.getLinkNodesIndex()

Example 2: Sets to the 1st link the start-node index = 2 and end-node index = 3 and to 2nd link the start-node index = 4 and end-node index = 5.

>>> linkIndex = [1, 2]
>>> startNode = [2, 4]
>>> endNode   = [3, 5]
>>> d.setLinkNodesIndex(linkIndex, startNode, endNode)
>>> d.getLinkNodesIndex()

See also getLinkNodesIndex, setLinkDiameter, setLinkLength, setLinkNameID, setLinkComment.

setLinkPipeData(Index, Length, Diameter, RoughnessCoeff, MinorLossCoeff)[source]

Sets a group of properties for a pipe.

Parameters:

Index (int) – Pipe Index
Length (float) – Pipe length
Diameter (float) – Pipe diameter
RoughnessCoeff (float) – Pipe roughness coefficient
MinorLossCoeff (float) – Pipe minor loss coefficient

Returns:

None

Example: Sets to the 1st pipe the following properties.

>>> pipeIndex = 1
>>> length = 1000
>>> diameter = 20
>>> RoughnessCoeff = 110
>>> MinorLossCoeff = 0.2
>>> d.getLinksInfo()    # Retrieves all link info
>>> d.setLinkPipeData(pipeIndex, length, diameter, RoughnessCoeff, MinorLossCoeff)
>>> d.getLinksInfo()

Example 2: Sets to the 1st and 2nd pipe the following properties.

>>> pipeIndex = [1, 2]
>>> length = [1000, 1500]
>>> diameter = [20, 23]
>>> RoughnessCoeff = [110, 115]
>>> MinorLossCoeff = [0.2, 0.3]
>>> d.getLinksInfo().disp()    # Retrieves all link info
>>> d.setLinkPipeData(pipeIndex, length, diameter, RoughnessCoeff, MinorLossCoeff)
>>> d.getLinksInfo().to_dict()

See also getLinksInfo, setLinkComment, setLinkDiameter, setLinkLength, setLinkStatus, setNodeTankData.

setLinkPumpECost(value, *argv)[source]

Sets the pump average energy price.

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1:

>>> d.getLinkPumpECost()                           # Retrieves the pump average energy price of all pumps
>>> d.setLinkPumpECost(0.10)                       # Sets the pump average energy price = 0.10 to every pump
>>> d.getLinkPumpECost()

Example 2: (The input array must have a length equal to the number of pumps).

>>> d.setLinkPumpECost([0.10, 0.12])               # Sets the pump average energy price = 0.10 and 0.12 to the 2 pumps
>>> d.getLinkPumpECost()

Example 3:

>>> d.setLinkPumpECost(1, 0.10)                    # Sets the pump average energy price = 0.10 to the 1st pump
>>> d.getLinkPumpECost()

Example 4:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpECost(pumpIndex, 0.10)            # Sets the pump average energy price = 0.10 to the pumps with index 118 and 119
>>> d.getLinkPumpECost()

Example 5:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpECost(pumpIndex, [0.10, 0.12])    # Sets the pump average energy price = 0.10 and 0.12 to the pumps with index 118 and 119 respectively
>>> d.getLinkPumpECost()

See also getLinkPumpECost, setLinkPumpPower, setLinkPumpHCurve, setLinkPumpECurve, setLinkPumpEPat.

setLinkPumpECurve(value, *argv)[source]

Sets the pump efficiency v. flow curve index.

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1:

>>> d.getLinkPumpECurve()                    # Retrieves the pump efficiency v. flow curve index of all pumps
>>> d.setLinkPumpECurve(1)                   # Sets the pump efficiency v. flow curve index = 1 to every pump
>>> d.getLinkPumpECurve()

Example 2: The input array must have a length equal to the number of pumps.

>>> d.setLinkPumpECurve([1, 2])              # Sets the pump efficiency v. flow curve index = 1 and 2 to the 2 pumps
>>> d.getLinkPumpECurve()

Example 3:

>>> d.setLinkPumpECurve(1, 2)                # Sets the pump efficiency v. flow curve index = 2 to the 1st pump
>>> d.getLinkPumpECurve()

Example 4:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpECurve(pumpIndex, 1)        # Sets the pump efficiency v. flow curve index = 1 to the pumps with index 118 and 119
>>> d.getLinkPumpECurve()

Example 5:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpECurve(pumpIndex,[1, 2])    # Sets the pump efficiency v. flow curve index = 1 and 2 to the pumps with index 118 and 119 respectively
>>> d.getLinkPumpECurve()

See also getLinkPumpECurve, setLinkPumpPower, setLinkPumpHCurve, setLinkPumpECost, setLinkPumpEPat.

setLinkPumpEPat(value, *argv)[source]

Sets the pump energy price time pattern index.

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1:

>>> d.getLinkPumpEPat()                    # Retrieves the pump energy price time pattern index of all pumps
>>> d.setLinkPumpEPat(1)                   # Sets the pump energy price time pattern index = 1 to every pump
>>> d.getLinkPumpEPat()

Example 2: (The input array must have a length equal to the number of pumps).

>>> d.setLinkPumpEPat([1, 2])              # Sets the pump energy price time pattern index = 1 and 2 to the 2 pumps
>>> d.getLinkPumpEPat()

Example 3:

>>> d.setLinkPumpEPat(1, 2)                # Sets the pump energy price time pattern index = 2 to the 1st pump
>>> d.getLinkPumpEPat()

Example 4:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpEPat(pumpIndex, 1)        # Sets the pump energy price time pattern index = 1 to the pumps with index 118 and 119
>>> d.getLinkPumpEPat()

Example 5:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpEPat(pumpIndex,[1, 2])    # Sets the pump energy price time pattern index = 1 and 2 to the pumps with index 118 and 119 respectively
>>> d.getLinkPumpEPat()

See also getLinkPumpEPat, setLinkPumpPower, setLinkPumpHCurve, setLinkPumpECurve, setLinkPumpECost.

setLinkPumpHCurve(value, *argv)[source]

Sets the pump head v. flow curve index.

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1:

>>> d.getLinkPumpHCurve()                    # Retrieves the pump head v. flow curve index of all pumps
>>> d.setLinkPumpHCurve(1)                   # Sets the pump head v. flow curve index = 1 to every pump
>>> d.getLinkPumpHCurve()

Example 2: (The input array must have a length equal to the number of pumps

>>> d.setLinkPumpHCurve([1, 2])              # Sets the pump head v. flow curve index = 1 and 2 to the 2 pumps
>>> d.getLinkPumpHCurve()

Example 3:

>>> d.setLinkPumpHCurve(1, 2)                # Sets the pump head v. flow curve index = 2 to the 1st pump
>>> d.getLinkPumpHCurve()

Example 4:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpHCurve(pumpIndex, 1)        # Sets the pump head v. flow curve index = 1 to the pumps with index 118 and 119
>>> d.getLinkPumpHCurve()

Example 5:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpHCurve(pumpIndex, [1, 2])   # Sets the pump head v. flow curve index = 1 and 2 to the pumps with index 118 and 119 respectively
>>> d.getLinkPumpHCurve()

See also getLinkPumpHCurve, setLinkPumpPower, setLinkPumpECurve, setLinkPumpECost, setLinkPumpEPat.

setLinkPumpHeadCurveIndex(value, *argv)[source]

Sets the curves index for pumps index

>>> d.getLinkPumpHeadCurveIndex()
>>> pumpIndex = d.getLinkPumpIndex(1)
>>> curveIndex = d.getLinkCurveIndex(2)
>>> d.setLinkPumpHeadCurveIndex(pumpIndex, curveIndex)
>>> d.getLinkPumpHeadCurveIndex()

See also setLinkPumpPatternIndex, getLinkPumpPower, setLinkPumpHCurve, setLinkPumpECurve, setLinkPumpECost.

setLinkPumpPatternIndex(value, *argv)[source]

Sets the pump speed time pattern index.

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1:

>>> d.getLinkPumpPatternIndex()                    # Retrieves the pump speed time pattern index of all pumps
>>> d.setLinkPumpPatternIndex(1)                   # Sets the speed time pattern index = 1 to every pump
>>> d.getLinkPumpPatternIndex()

Example 2: The input array must have a length equal to the number of pumps.

>>> d.setLinkPumpPatternIndex([1, 2])              # Sets the pump speed time pattern index = 1 and 2 to the 2 pumps
>>> d.getLinkPumpPatternIndex()

Example 3:

>>> d.setLinkPumpPatternIndex(1, 2)                # Sets the pump speed time pattern index = 2 to the 1st pump
>>> d.getLinkPumpPatternIndex()

Example 4:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpPatternIndex(pumpIndex, 1)        # Sets the pump speed time pattern index = 1 to the pumps with index 118 and 119
>>> d.getLinkPumpPatternIndex()

Example 5:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpPatternIndex(pumpIndex, [1, 2])    # Sets the pump speed time pattern index = 1 and 2 to the pumps with index 118 and 119 respectively
>>> d.getLinkPumpPatternIndex()

Example 6: To remove the pattern index from the pumps you can use input 0.

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpPatternIndex(pumpIndex, 0)

See also getLinkPumpPatternIndex, setLinkPumpPower, setLinkPumpHCurve, setLinkPumpECurve, setLinkPumpECost.

setLinkPumpPower(value, *argv)[source]

Sets the power for pumps.

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1:

>>> d.getLinkPumpPower()                      # Retrieves the power of all pumps
>>> d.setLinkPumpPower(10)                    # Sets the pump power = 10 to every pump
>>> d.getLinkPumpPower()

Example 2: (The input array must have a length equal to the number of pumps).

>>> d.setLinkPumpPower([10, 15])              # Sets the pump power = 10 and 15 to the 2 pumps
>>> d.getLinkPumpPower()

Example 3:

>>> d.setLinkPumpPower(1, 10)                 # Sets the pump power = 10 to the 1st pump
>>> d.getLinkPumpPower()

Example 4:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpPower(pumpIndex, 10)         # Sets the pump power = 10 to the pumps with index 118 and 119
>>> d.getLinkPumpPower()

Example 5:

>>> pumpIndex = d.getLinkPumpIndex()
>>> d.setLinkPumpPower(pumpIndex, [10, 15])   # Sets the pump power = 10 and 15 to the pumps with index 118 and 119 respectively
>>> d.getLinkPumpPower()

See also getLinkPumpPower, setLinkPumpHCurve, setLinkPumpECurve, setLinkPumpECost, setLinkPumpEPat.

setLinkRoughnessCoeff(value, *argv)[source]

Sets the values of roughness coefficient.

Example 1:

>>> index_pipe = 1
>>> d.getLinkRoughnessCoeff(index_pipe)               # Retrieves the roughness coefficient of the 1st link
>>> coeff = 105
>>> d.setLinkRoughnessCoeff(index_pipe, coeff)        # Sets the roughness coefficient of the 1st link
>>> d.getLinkRoughnessCoeff(index_pipe)

Example 2:

>>> coeffs = d.getLinkRoughnessCoeff()                  # Retrieves the roughness coefficients of all the links
>>> coeffs_new = coeffs + 10
>>> d.setLinkRoughnessCoeff(coeffs_new)               # Sets the roughness coefficient of all links
>>> d.getLinkRoughnessCoeff()

See also getLinkRoughnessCoeff, setLinkDiameter, setLinkMinorLossCoeff, setLinkPipeData, addLink, deleteLink.

setLinkSettings(value, *argv)[source]

Sets the values of current settings, roughness for pipes or initial speed for pumps or initial setting for valves.

Example 1:

>>> index_pipe = 1
>>> d.getLinkSettings(index_pipe)                 # Retrieves the current setting of the 1st link
>>> setting = 80
>>> d.setLinkSettings(index_pipe, setting)        # Sets the current setting of the 1st link
>>> d.getLinkSettings(index_pipe)

Example 2:

>>> settings = d.getLinkSettings()                # Retrieves the current setting of all links
>>> settings_new = [i + 40 for i in settings]
>>> d.setLinkSettings(settings_new)               # Sets the current setting of all links
>>> d.getLinkSettings()

See also getLinkSettings, setLinkStatus, setLinkRoughnessCoeff,: setLinkPipeData, addLink, deleteLink.

setLinkStatus(value, *argv)[source]

Sets the values of current status for links.

Note: Cannot set status for a check valve

Example 1:

>>> index_pipe = 1
>>> d.getLinkStatus(index_pipe)                  # Retrieves the current status of the 1st link
>>> status = 1
>>> d.setLinkStatus(index_pipe, status)          # Sets the current status of the 1st link
>>> d.getLinkStatus(index_pipe)

Example 2:

>>> statuses = d.getLinkStatus()                 # Retrieves the current status of all links
>>> statuses_new = [0 for i in statuses]
>>> d.setLinkStatus(statuses_new)                # Sets the current status of all links
>>> d.getLinkStatus()

See also getLinkStatus, setLinkInitialStatus, setLinkDiameter, setLinkPipeData, addLink, deleteLink.

setLinkTypePipe(Id, *argv)[source]

Sets the link type pipe for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType()
>>> linkid = d.getLinkPumpNameID(1)
>>> index = d.setLinkTypePipe(linkid)            # Changes the 1st pump to pipe given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPumpNameID(1)
>>> condition = 1
>>> index = d.setLinkTypePipe(linkid, condition) # Changes the 1st pump to pipe given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPumpNameID, setLinkTypePipeCV, setLinkTypePump, setLinkTypeValveFCV.

setLinkTypePipeCV(Id, *argv)[source]

Sets the link type cvpipe(pipe with check valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                              # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)               # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypePipeCV(linkid)           # Changes the 1st pipe to cvpipe given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypePipeCV(linkid, condition)  # Changes the 1st pipe to cvpipe given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValveFCV.

setLinkTypePump(Id, *argv)[source]

Sets the link type pump for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                            # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)             # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypePump(linkid)           # Changes the 1st pipe to pump given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypePump(linkid, condition)   # Changes the 1st pipe to pump given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePipeCV, setLinkTypeValveFCV.

setLinkTypeValveFCV(Id, *argv)[source]

Sets the link type valve FCV(flow control valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                                    # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)                     # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypeValveFCV(linkid)               # Changes the 1st pipe to valve FCV given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValveFCV(linkid, condition)    # Changes the 1st pipe to valve FCV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValveGPV.

setLinkTypeValveGPV(Id, *argv)[source]

Sets the link type valve GPV(general purpose valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                                    # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)                     # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypeValveGPV(linkid)               # Changes the 1st pipe to valve GPV given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValveGPV(linkid, condition)    # Changes the 1st pipe to valve GPV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValveFCV.

setLinkTypeValvePCV(Id, *argv)[source]

Sets the link type valve PCV(Position control valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> 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
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValvePCV(linkid, condition)    # Changes the 1st pipe to valve PCV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValveFCV.

setLinkTypeValvePBV(Id, *argv)[source]

Sets the link type valve PBV(pressure breaker valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                                    # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)                     # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypeValvePBV(linkid)               # Changes the 1st pipe to valve PBV given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValvePBV(linkid, condition)    # Changes the 1st pipe to valve PBV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValvePRV.

setLinkTypeValvePRV(Id, *argv)[source]

Sets the link type valve PRV(pressure reducing valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                                    # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)                     # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypeValvePRV(linkid)               # Changes the 1st pipe to valve PRV given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValvePRV(linkid, condition)    # Changes the 1st pipe to valve PRV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValvePSV.

setLinkTypeValvePSV(Id, *argv)[source]

Sets the link type valve PSV(pressure sustaining valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                                    # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)                     # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypeValvePSV(linkid)               # Changes the 1st pipe to valve PSV given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValvePSV(linkid, condition)    # Changes the 1st pipe to valve PSV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValvePBV.

setLinkTypeValveTCV(Id, *argv)[source]

Sets the link type valve TCV(throttle control valve) for a specified link.

Note:

condition = 0 | if is EN_UNCONDITIONAL: Delete all controls that contain object
condition = 1 | if is EN_CONDITIONAL: Cancel object type change if contained in controls

Default condition is 0.

Example 1:

>>> d.getLinkType(1)                                    # Retrieves the type of the 1st link
>>> linkid = d.getLinkPipeNameID(1)                     # Retrieves the ID of the 1t pipe
>>> index = d.setLinkTypeValveTCV(linkid)               # Changes the 1st pipe to valve TCV given it's ID
>>> d.getLinkType(index)

Example 2:

>>> linkid = d.getLinkPipeNameID(1)
>>> condition = 1
>>> index = d.setLinkTypeValveTCV(linkid, condition)    # Changes the 1st pipe to valve TCV given it's ID and a condition (if possible)
>>> d.getLinkType(index)

See also getLinkType, getLinkPipeNameID, setLinkTypePipe, setLinkTypePump, setLinkTypeValveGPV.

setLinkVertices(linkID, x, y, *argv)[source]

Assigns a set of internal vertex points to a link.

The example is based on d = epanet(‘Net1.inp’)

Example:

>>> d = epanet('Net1.inp')
>>> linkID = '10'
>>> x = [22, 24, 28]
>>> y = [69, 68, 69]
>>> d.setLinkVertices(linkID, x, y)

See also getLinkVertices, getLinkVerticesCount.

setLinkWallReactionCoeff(value, *argv)[source]

Sets the value of wall chemical reaction coefficient.

Example 1:

>>> index_pipe = 1
>>> d.getLinkWallReactionCoeff(index_pipe)               # Retrieves the wall chemical reaction coefficient of the 1st link
>>> coeff = 0
>>> d.setLinkWallReactionCoeff(index_pipe, coeff)        # Sets the wall chemical reaction coefficient of the 1st link
>>> d.getLinkWallReactionCoeff(index_pipe)

Example 2:

>>> coeffs = d.getLinkWallReactionCoeff()                # Retrieves the wall chemical reaction coefficients of all links
>>> coeffs_new = [0] * len(coeffs)
>>> d.setLinkWallReactionCoeff(coeffs_new)               # Sets the wall chemical reaction coefficient of all links
>>> d.getLinkWallReactionCoeff()

See also getLinkWallReactionCoeff, setLinkBulkReactionCoeff, setLinkPipeData, addLink, deleteLink.

setNodeBaseDemands(value, *argv)[source]

Sets the values of demand for nodes. The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> index_node = 1
>>> d.getNodeBaseDemands()[1][index_node]                      # Retrieves the demand of the 1st node
>>> demand = 5
>>> d.setNodeBaseDemands(index_node, demand)                   # Sets the demand of the 1st node
>>> d.getNodeBaseDemands()[1][index_node-1]

Example 2:

>>> nodeIndex = list(range(1,6))
>>> BaseDems = d.getNodeBaseDemands()[1]
>>> baseDems = list(np.array(BaseDems)[0:5])                   # Retrieves the demands of first 5 nodes
>>> demands = [10, 5, 15, 20, 5]
>>> d.setNodeBaseDemands(nodeIndex, demands)                   # Sets the demands of first 5 nodes
>>> newBaseDems = d.getNodeBaseDemands()[1][0:5]
>>> newbaseDems = newBaseDems

Example 3:

>>> demands = d.getNodeBaseDemands()[1]                        # Retrieves the demands of all nodes
>>> demands_new = [i+15 for i in demands]
>>> d.setNodeBaseDemands(demands_new)                          # Sets the demands of all nodes
>>> d.getNodeBaseDemands()[1]

If a category is not given, the default is categoryIndex = 1.

Example 4:

>>> d = epanet('BWSN_Network_1.inp')
>>> nodeIndex = 121
>>> categoryIndex = 2
>>> d.getNodeBaseDemands()[categoryIndex][nodeIndex-1]           # Retrieves the demand of the 2nd category of the 121th node
>>> demand = 25
>>> d.setNodeBaseDemands(nodeIndex, categoryIndex, demand)       # Sets the demand of the 2nd category of the 121th node
>>> d.getNodeBaseDemands()[categoryIndex][nodeIndex-1]

Example 5:

>>> d = epanet('BWSN_Network_1.inp')
>>> nodeIndex = list(range(1,6))
>>> categoryIndex = 1
>>> baseDems = d.getNodeBaseDemands()[categoryIndex]
>>> baseDems = baseDems[0:5]                       # Retrieves the demands of the 1st category of the first 5 nodes
>>> demands = [10, 5, 15, 20, 5]
>>> d.setNodeBaseDemands(nodeIndex, categoryIndex, demands)      # Sets the demands of the 1st category of the first 5 nodes
>>> newbaseDems = d.getNodeBaseDemands()[categoryIndex]
>>> newbaseDems = newbaseDems[0:5]

See also getNodeBaseDemands, setNodeJunctionDemandName, setNodeDemandPatternIndex, addNodeJunction, deleteNode.

setNodeComment(value, *argv)[source]

Sets the comment string assigned to the node object.

Example 1:

>>> d.setNodeComment(1, 'This is a node')                     # Sets a comment to the 1st node
>>> d.getNodeComment(1)

Example 2:

>>> d.setNodeComment([1,2], ['This is a node', 'Test comm'])  # Sets a comment to the 1st and 2nd node
>>> d.getNodeComment([1,2])

See also getNodeComment, getNodesInfo, setNodeNameID, setNodeCoordinates.

setNodeCoordinates(value, *argv)[source]

Sets node coordinates.

Example 1:

>>> nodeIndex = 1
>>> d.getNodeCoordinates(nodeIndex)              # Retrieves the X and Y coordinates of the 1st node
>>> coords = [0,0]
>>> d.setNodeCoordinates(nodeIndex, coords)      # Sets the coordinates of the 1st node
>>> d.getNodeCoordinates(nodeIndex)

Example 2:

>>> x_values = d.getNodeCoordinates('x')
>>> y_values = d.getNodeCoordinates('y')
>>> x_new = [x_values[i]+10 for i in x_values]
>>> y_new = [y_values[i]+10 for i in y_values]
>>> new_coords = [x_new, y_new]                     # Creates a cell array with the new coordinates
>>> d.setNodeCoordinates(new_coords)                # Sets the coordinates of all nodes
>>> x_values_new = d.getNodeCoordinates('x')
>>> y_values_new = d.getNodeCoordinates('y')

See also getNodeCoordinates, setNodeElevations, plot, addNodeJunction, addNodeTank, deleteNode.

setNodeDemandPatternIndex(value, *argv)[source]

Sets the values of demand time pattern indices.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> nodeIndex = 1
>>> d.getNodeDemandPatternIndex()[1][nodeIndex-1]                            # Retrieves the index of the 1st category's time pattern of the 1st node
>>> patternIndex = 2
>>> d.setNodeDemandPatternIndex(nodeIndex, patternIndex)                     # Sets the demand time pattern index to the 1st node
>>> d.getNodeDemandPatternIndex()[1][nodeIndex-1]

Example 2:

>>> nodeIndex = np.array(range(1,6))
>>> d.getNodeDemandPatternIndex()[1][0:5]
>>> patternIndices = [1, 3, 2, 4, 2]
>>> d.setNodeDemandPatternIndex(nodeIndex, patternIndices)                   # Sets the demand time pattern index to the first 5 nodes
>>> d.getNodeDemandPatternIndex()[1][0:5]

Example 3:

>>> patternIndices = d.getNodeDemandPatternIndex()[1]
>>> patternIndices_new = [i+1 for i in patternIndices]
>>> d.setNodeDemandPatternIndex(patternIndices_new)                          # Sets all primary demand time pattern indices
>>> d.getNodeDemandPatternIndex()[1]

If a category is not given, the default is categoryIndex = 1.

Example 4:

>>> nodeIndex = 121
>>> categoryIndex = 2
>>> d.getNodeDemandPatternIndex()[categoryIndex][nodeIndex-1]                 # Retrieves the index of the 2nd category's time pattern of the 121th node
>>> patternIndex = 4
>>> d.setNodeDemandPatternIndex(nodeIndex, categoryIndex, patternIndex)       # Sets the demand time pattern index of the 2nd category of the 121th node
>>> d.getNodeDemandPatternIndex()[categoryIndex][nodeIndex-1]

Example 5:

>>> nodeIndex = np.array(range(1,6))
>>> categoryIndex = 1
>>> patDems = d.getNodeDemandPatternIndex()[categoryIndex]
>>> patDems = list(np.array(patDems)[0:5])
>>> patternIndices = [1, 3, 2, 4, 2]
>>> d.setNodeDemandPatternIndex(nodeIndex, categoryIndex, patternIndices)     # Sets the demand time pattern index of the 1st category of the first 5 nodes
>>> patDems_new = d.getNodeDemandPatternIndex()[categoryIndex][0:5]

See also getNodeDemandPatternIndex, getNodeDemandCategoriesNumber, setNodeBaseDemands, addPattern, deletePattern.

setNodeReservoirHeadPatternIndex(value, *argv)[source]

Sets the pattern index for a reservoir node head This is a duplicate function—identical in behavior to setNodeDemandPatternIndex

Example 1:: d = epanet(‘net2-cl2.inp’) res_index = d.addNodeReservoir(“res-1”) pidx = d.addPattern(“pat-1”) d.setNodeReservoirHeadPatternIndex(res_index, pidx) d.setPattern(pidx, 1)

setNodeElevations(value, *argv)[source]

Sets the values of elevation for nodes.

Example 1:

>>> index_node = 1
>>> d.getNodeElevations(index_node)            # Retrieves the elevation of the 1st node
>>> elev = 500
>>> d.setNodeElevations(index_node, elev)      # Sets the elevation of the 1st node
>>> d.getNodeElevations(index_node)

Example 2:

>>> elevs = d.getNodeElevations()               # Retrieves the elevations of all the nodes
>>> elevs_new = elevs + 100
>>> d.setNodeElevations(elevs_new)              # Sets the elevations of all nodes
>>> d.getNodeElevations()

See also getNodeElevations, setNodeCoordinates, setNodeBaseDemands, setNodeJunctionData, addNodeJunction, deleteNode.

setNodeEmitterCoeff(value, *argv)[source]

Sets the values of emitter coefficient for nodes.

Example 1:

>>> nodeset = d.getNodeEmitterCoeff()                # Retrieves the value of all nodes emmitter coefficients
>>> nodeset[0] = 0.1                                 # First node emitter coefficient = 0.1
>>> d.setNodeEmitterCoeff(nodeset)                   # Sets the value of all nodes emitter coefficient
>>> d.getNodeEmitterCoeff()

Example 2:

>>> nodeIndex = 1
>>> d.getNodeEmitterCoeff(nodeIndex)
>>> emitterCoeff = 0
>>> d.setNodeEmitterCoeff(nodeIndex, emitterCoeff)   # Sets the value of the 1st node emitter coefficient = 0
>>> d.getNodeEmitterCoeff(nodeIndex)

See also getNodeEmitterCoeff, setNodeBaseDemands, setNodeJunctionData.

setNodeInitialQuality(value, *argv)[source]

Sets the values of initial quality for nodes.

Example 1:

>>> nodeset = d.getNodeInitialQuality()                  # Retrieves the value of all nodes initial qualities
>>> nodeset[0] = 0.5                                     # First node initial quality = 0.5
>>> d.setNodeInitialQuality(nodeset)                     # Sets the values of all nodes initial quality
>>> d.getNodeInitialQuality()

Example 2:

>>> nodeIndex = 1
>>> d.getNodeInitialQuality(nodeIndex)
>>> initialQuality = 1
>>> d.setNodeInitialQuality(nodeIndex, initialQuality)    # Sets the value of the 1st node initial quality
>>> d.getNodeInitialQuality(nodeIndex)

See also getNodeInitialQuality, getNodeActualQuality, setNodeJunctionData.

setNodeJunctionData(index, elev, dmnd, dmndpat)[source]

Sets a group of properties for a junction node.

Parameters:

index (int) – a junction node’s index (starting from 1).
elev (float) – the value of the junction’s elevation.
dmnd (float) – the value of the junction’s primary base demand.
dmndpat (str) – the ID name of the demand’s time pattern (”” for no pattern)

Returns:

None

Example:

>>> junctionIndex = 1
>>> elev = 35
>>> dmnd = 100
>>> dmndpat = 'NEW_PATTERN'
>>> d.addPattern(dmndpat)                                         # Adds a new pattern
>>> d.setNodeJunctionData(junctionIndex, elev, dmnd, dmndpat)     # Sets the elevation, primary base demand and time pattern of the 1st junction
>>> d.getNodeElevations(junctionIndex)                            # Retrieves the elevation of the 1st junction
>>> d.getNodeBaseDemands(junctionIndex)                           # Retrieves the primary base demand of the 1st junction
>>> d.getNodeDemandPatternNameID()[junctionIndex]                 # Retrieves the demand pattern ID (primary base demand is the first category)

See also setNodeTankData, getNodeElevations, getNodeBaseDemands, getNodeDemandPatternNameID, addPattern, setNodeJunctionDemandName.

setNodeJunctionDemandName(nodeIndex, demandIndex, demandName)[source]

Assigns a name to a node’s demand category.

Example:

>>> nodeIndex = 1
>>> demandIndex = 1
>>> d.getNodeJunctionDemandName()[demandIndex][nodeIndex-1]              # Retrieves the name of the 1st node, 1st demand category
>>> demandName = 'NEW NAME'
>>> d.setNodeJunctionDemandName(nodeIndex, demandIndex, demandName)      # Sets a new name of the 1st node, 1st demand category
>>> d.getNodeJunctionDemandName()[demandIndex][nodeIndex-1]

See also getNodeJunctionDemandName, setNodeBaseDemands, setDemandModel, addNodeJunctionDemand, deleteNodeJunctionDemand.

setNodeNameID(value, *argv)[source]

Sets the ID name for nodes.

Example 1:

>>> nodeIndex = 1
>>> d.getNodeNameID(nodeIndex)          # Retrieves the ID of the 1st node
>>> nameID = 'newID'
>>> d.setNodeNameID(nodeIndex, nameID)  # Sets the ID of the 1st node.
>>> d.getNodeNameID(nodeIndex)

Example 2:

>>> nameID = d.getNodeNameID()          # Retrieves the IDs of all nodes
>>> nameID[0] = 'newID_1'
>>> nameID[4] = 'newID_5'
>>> d.setNodeNameID(nameID)             # Sets the IDs of all nodes
>>> d.getNodeNameID()

See also getNodeNameID, setNodeComment, setNodeJunctionData.

setNodesConnectingLinksID(linkIndex, startNodeID, endNodeID)[source]

Sets the IDs of a link’s start- and end-nodes.

Example 1:

>>> d.getNodesConnectingLinksID()  # Retrieves the ids of the from/to nodes of all links
>>> linkIndex = 2
>>> startNodeID = '11'
>>> endNodeID = '22'
>>> d.setNodesConnectingLinksID(linkIndex, startNodeID, endNodeID)
>>> d.getNodesConnectingLinksID()

Example 2:

>>> linkIndex   = [2, 3]
>>> startNodeID = ['12', '13']
>>> endNodeID   = ['21', '22']
>>> d.setNodesConnectingLinksID(linkIndex, startNodeID, endNodeID)
>>> d.getNodesConnectingLinksID()
>>> d.plot()

See also getLinkNodesIndex, getNodesConnectingLinksID, setLinkLength, setLinkNameID, setLinkComment.

setNodeSourcePatternIndex(value, *argv)[source]

Sets the values of quality source pattern index.

Example 1:

>>> nodeIndex = 1
>>> d.getNodeSourcePatternIndex(nodeIndex)                        # Retrieves the quality source pattern index of the 1st node
>>> sourcePatternIndex = 1
>>> d.setNodeSourcePatternIndex(nodeIndex, sourcePatternIndex)    # Sets the quality source pattern index = 1 to the 1st node
>>> d.getNodeSourcePatternIndex(nodeIndex)

Example 2:

>>> nodeIndex = [1,2,3]
>>> d.getNodeSourcePatternIndex(nodeIndex)                        # Retrieves the quality source pattern index of the first 3 nodes
>>> sourcePatternIndex = [1, 1, 1]
>>> d.setNodeSourcePatternIndex(nodeIndex, sourcePatternIndex)    # Sets the quality source pattern index = 1 to the first 3 nodes
>>> d.getNodeSourcePatternIndex(nodeIndex)

See also getNodeSourcePatternIndex, setNodeSourceQuality, setNodeSourceType.

setNodeSourceQuality(value, *argv)[source]

Sets the values of quality source strength.

Example 1:

>>> nodeIndex = 1
>>> d.getNodeSourceQuality(nodeIndex)                    # Retrieves the quality source strength of the 1st node
>>> sourceStrength = 10
>>> d.setNodeSourceQuality(nodeIndex, sourceStrength)    # Sets the quality source strength = 10 to the 1st node
>>> d.getNodeSourceQuality(nodeIndex)

Example 2:

>>> nodeIndex = [1,2,3]
>>> d.getNodeSourceQuality(nodeIndex)                    # Retrieves the quality source strength of the first 3 nodes
>>> sourceStrength = [10, 12, 8]
>>> d.setNodeSourceQuality(nodeIndex, sourceStrength)    # Sets the quality source strength = 10, 12 and 8 to the first 3 nodes
>>> d.getNodeSourceQuality(nodeIndex)

See also getNodeSourceQuality, setNodeSourcePatternIndex, setNodeSourceType.

setNodeSourceType(index, value)[source]

Sets the values of quality source type.

Types of external water quality sources that can be set:

CONCEN Sets the concentration of external inflow entering a node
MASS Injects a given mass/minute into a node
SETPOINT Sets the concentration leaving a node to a given value
FLOWPACED Adds a given value to the concentration leaving a node

Example:

>>> nodeIndex = 1
>>> d.getNodeSourceType(nodeIndex)                 # Retrieves the quality source type of the 1st node
>>> sourceType = 'MASS'
>>> d.setNodeSourceType(nodeIndex, sourceType)     # Sets the quality source type = 'MASS' to the 1st node
>>> d.getNodeSourceType(nodeIndex)

See also getNodeSourceType, setNodeSourceQuality, setNodeSourcePatternIndex.

setNodeTankBulkReactionCoeff(value, *argv)[source]

Sets the tank bulk reaction coefficient.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankBulkReactionCoeff()                          # Retrieves the  bulk reaction coefficient of all tanks
>>> d.setNodeTankBulkReactionCoeff(-0.5)                      # Sets the bulk reaction coefficient = -0.5 to every tank
>>> d.getNodeTankBulkReactionCoeff()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankBulkReactionCoeff([0, -0.5])                 # Sets the bulk reaction coefficient = 0 and -0.5 to the 2 tanks
>>> d.getNodeTankBulkReactionCoeff()

Example 3:

>>> d.setNodeTankBulkReactionCoeff(1, -0.8)                   # Sets the bulk reaction coefficient = -0.5 to the 1st tank
>>> d.getNodeTankBulkReactionCoeff()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankBulkReactionCoeff(tankIndex, 0)              # Sets the bulk reaction coefficient = 0 to the tanks with index 128 and 129
>>> d.getNodeTankBulkReactionCoeff()

Example 5:

>>> tankIndex = d.getNodeTankIndex([1,2])
>>> d.setNodeTankBulkReactionCoeff(tankIndex, [-0.5, 0])      # Sets the bulk reaction coefficient = -0.5 and 0 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankBulkReactionCoeff()

See also getNodeTankBulkReactionCoeff, setNodeTankInitialLevel, setNodeTankMixingModelType, setNodeTankCanOverFlow, setNodeTankDiameter, setNodeTankData.

setNodeTankCanOverFlow(value, *argv)[source]

Sets the tank can-overflow (= 1) or not (= 0).

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankCanOverFlow()               # Retrieves the can-overflow of all tanks
>>> d.setNodeTankCanOverFlow(1)              # Sets the can-overflow = 1 to every tank
>>> d.getNodeTankCanOverFlow()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankCanOverFlow([1, 0])         # Sets the can-overflow = 1 and 0 to the 2 tanks
>>> d.getNodeTankCanOverFlow()

Example 3:

>>> d.setNodeTankCanOverFlow(1, 0)           # Sets the can-overflow = 0 to the 1st tank
>>> d.getNodeTankCanOverFlow()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankCanOverFlow(tankIndex, 1)   # Sets the can-overflow = 1 to the tanks with index 128 and 129
>>> d.getNodeTankCanOverFlow()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankCanOverFlow(tankIndex, [0, 1])   # Sets the can-overflow = 0 and 1 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankCanOverFlow()

See also getNodeTankCanOverFlow, setNodeTankBulkReactionCoeff, setNodeTankMinimumWaterLevel, setNodeTankMinimumWaterVolume, setNodeTankDiameter, setNodeTankData.

setNodeTankData(index, elev, intlvl, minlvl, maxlvl, diam, minvol, volcurve)[source]

Sets a group of properties for a tank.

Parameters:

index (int) – Tank index
elev (float) – Tank Elevation
intlvl (float) – Tank Initial water Level
minlvl (float) – Tank Minimum Water Level
maxlvl (float) – Tank Maximum Water Level
diam (float) – Tank Diameter (0 if a volume curve is supplied)
minvol (float) – Tank Minimum Water Volume
volcurve (str) – Tank Volume Curve Index (”” for no curve)

Returns:

None

The examples are based on d = epanet(‘Net3_trace.inp’)

Example 1: (Sets to the 1st tank the following properties).

>>> tankIndex = 1    # You can also use tankIndex = 95 (i.e. the index of the tank).
>>> elev = 100
>>> intlvl = 13
>>> minlvl =  0.2
>>> maxlvl = 33
>>> diam = 80
>>> minvol = 50000
>>> volcurve = ''    # For no curve
>>> d.setNodeTankData(tankIndex, elev, intlvl, minlvl, maxlvl, diam, minvol, volcurve)
>>> d.getNodeTankData().disp()

Example 2: (Sets to the 1st and 2nd tank the following properties).

>>> tankIndex = [1, 2]    # You can also use tankIndex = [95, 96] (i.e. the indices of the tanks).
>>> elev = [100, 105]
>>> intlvl = [13, 13.5]
>>> minlvl =  [0.2, 0.25]
>>> maxlvl = [30, 35]
>>> diam = [80, 85]
>>> minvol = [50000, 60000]
>>> volcurve = ['', '']    # For no curves
>>> d.setNodeTankData(tankIndex, elev, intlvl, minlvl, maxlvl, diam, minvol, volcurve)
>>> d.getNodeTankData(tankIndex).disp()

See also getNodeTankData, setNodeTankInitialLevel, setNodeTankMinimumWaterLevel, setNodeTankDiameter.

setNodeTankDiameter(value, *argv)[source]

Sets the diameter value for tanks.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankDiameter()                         #  Retrieves the diameter of all tanks
>>> d.setNodeTankDiameter(120)                      #  Sets the diameter = 120 to every tank
>>> d.getNodeTankDiameter()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankDiameter([110, 130])               # Sets the diameter = 110 and 130 to the 2 tanks
>>> d.getNodeTankDiameter()

Example 3:

>>> d.setNodeTankDiameter(1, 120)                   # Sets the diameter = 120 to the 1st tank
>>> d.getNodeTankDiameter()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankDiameter(tankIndex, 150)           # Sets the diameter = 150 to the tanks with index 128 and 129
>>> d.getNodeTankDiameter()

Example 5:

>>> tankIndex = d.getNodeTankIndex([1,2])
>>> d.setNodeTankDiameter(tankIndex, [100, 120])    # Sets the diameter = 100 and 120 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankDiameter()

See also getNodeTankDiameter, setNodeTankInitialLevel, setNodeTankMinimumWaterLevel, setNodeTankBulkReactionCoeff, setNodeTankCanOverFlow, setNodeTankData.

setNodeTankInitialLevel(value, *argv)[source]

Sets the values of initial level for tanks.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankInitialLevel()                       # Retrieves the initial level of all tanks
>>> d.setNodeTankInitialLevel(10)                     # Sets the initial level = 10 to every tank
>>> d.getNodeTankInitialLevel()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankInitialLevel([10, 15])               # Sets the initial level = 10 and 15 to the 2 tanks
>>> d.getNodeTankInitialLevel()

Example 3:

>>> d.setNodeTankInitialLevel(1, 10)                  # Sets the initial level = 10 to the 1st tank
>>> d.getNodeTankInitialLevel()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankInitialLevel(tankIndex, 10)          # Sets the initial level = 10 to the tanks with index 128 and 129
>>> d.getNodeTankInitialLevel()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankInitialLevel(tankIndex, [10, 15])    # Sets the initial level = 10 and 15 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankInitialLevel()

See also getNodeTankInitialLevel, setNodeTankMinimumWaterLevel, setNodeTankMaximumWaterLevel, setNodeTankMinimumWaterVolume, setNodeTankMixingFraction, setNodeTankData.

setNodeTankMaximumWaterLevel(value, *argv)[source]

Sets the maximum water level value for tanks.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankMaximumWaterLevel()                       # Retrieves the maximum water level of all tanks
>>> d.setNodeTankMaximumWaterLevel(35)                     # Sets the maximum water level = 35 to every tank
>>> d.getNodeTankMaximumWaterLevel()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankMaximumWaterLevel([30, 40])               # Sets the maximum water level = 30 and 40 to the 2 tanks
>>> d.getNodeTankMaximumWaterLevel()

Example 3:

>>> d.setNodeTankMaximumWaterLevel(1, 35)                  # Sets the maximum water level = 35 to the 1st tank
>>> d.getNodeTankMaximumWaterLevel()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMaximumWaterLevel(tankIndex, 30)          # Sets the maximum water level = 30 to the tanks with index 128 and 129
>>> d.getNodeTankMaximumWaterLevel()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMaximumWaterLevel(tankIndex, [35, 45])    # Sets the maximum water level = 35 and 45 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankMaximumWaterLevel()

See also getNodeTankMaximumWaterLevel, setNodeTankInitialLevel, setNodeTankMinimumWaterLevel, setNodeTankMinimumWaterVolume, setNodeTankMixingFraction, setNodeTankData.

setNodeTankMinimumWaterLevel(value, *argv)[source]

Sets the minimum water level value for tanks.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankMinimumWaterLevel()                         # Retrieves the minimum water level of all tanks
>>> d.setNodeTankMinimumWaterLevel(5)                        # Sets the minimum water level = 5 to every tank
>>> d.getNodeTankMinimumWaterLevel()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankMinimumWaterLevel([10, 15])                 # Sets the minimum water level = 10 and 15 to the 2 tanks
>>> d.getNodeTankMinimumWaterLevel()

Example 3:

>>> d.setNodeTankMinimumWaterLevel(1, 5)                     # Sets the minimum water level = 5 to the 1st tank
>>> d.getNodeTankMinimumWaterLevel()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMinimumWaterLevel(tankIndex, 10)            # Sets the minimum water level = 10 to the tanks with index 128 and 129
>>> d.getNodeTankMinimumWaterLevel()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMinimumWaterLevel(tankIndex, [5, 15])       # Sets the minimum water level = 5 and 15 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankMinimumWaterLevel()

See also getNodeTankMinimumWaterLevel, setNodeTankInitialLevel, setNodeTankMaximumWaterLevel, setNodeTankMinimumWaterVolume, setNodeTankMixingFraction, setNodeTankData.

setNodeTankMinimumWaterVolume(value, *argv)[source]

Sets the minimum water volume value for tanks.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankMinimumWaterVolume()                           # Retrieves the minimum water volume of all tanks
>>> d.setNodeTankMinimumWaterVolume(1000)                       # Sets the minimum water volume = 1000 to every tank
>>> d.getNodeTankMinimumWaterVolume()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankMinimumWaterVolume([1500, 2000])               # Sets the minimum water volume = 1500 and 2000 to the 2 tanks
>>> d.getNodeTankMinimumWaterVolume()

Example 3:

>>> d.setNodeTankMinimumWaterVolume(1, 1000)                    # Sets the minimum water volume = 1000 to the 1st tank
>>> d.getNodeTankMinimumWaterVolume()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMinimumWaterVolume(tankIndex, 1500)            # Sets the minimum water volume = 1500 to the tanks with index 128 and 129
>>> d.getNodeTankMinimumWaterVolume()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMinimumWaterVolume(tankIndex, [1000, 2000])     # Sets the minimum water volume = 1000 and 2000 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankMinimumWaterVolume()

See also getNodeTankMinimumWaterVolume, setNodeTankInitialLevel, setNodeTankMinimumWaterLevel, setNodeTankMaximumWaterLevel, setNodeTankMixingFraction, setNodeTankData.

setNodeTankMixingFraction(value, *argv)[source]

Sets the tank mixing fraction of total volume occupied by the inlet/outlet zone in a 2-compartment tank.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankMixingFraction()                     # Retrieves the mixing fraction of all tanks
>>> d.setNodeTankMixingFraction(0)                    # Sets the mixing fraction = 0 to every tank
>>> d.getNodeTankMixingFraction()

Example 2: (The input array must have a length equal to the number of tanks).

>>> d.setNodeTankMixingFraction([1, 0])               # Sets the mixing fraction = 1 and 0 to the 2 tanks
>>> d.getNodeTankMixingFraction()

Example 3:

>>> d.setNodeTankMixingFraction(1, 0)                 # Sets the mixing fraction = 0 to the 1st tank
>>> d.getNodeTankMixingFraction()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMixingFraction(tankIndex, 1)         # Sets the mixing fraction = 1 to the tanks with index 128 and 129
>>> d.getNodeTankMixingFraction()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMixingFraction(tankIndex, [1, 0])     # Sets the mixing fraction = 1 and 0 to the tanks with index 128 and 129 respectively
>>> d.getNodeTankMixingFraction()

See also getNodeTankMixingFraction, setNodeTankMixingModelType, setNodeTankMinimumWaterLevel, setNodeTankMinimumWaterVolume, setNodeTankDiameter, setNodeTankData.

setNodeTankMixingModelType(value, *argv)[source]

Sets the mixing model type value for tanks.

The examples are based on d = epanet(‘BWSN_Network_1.inp’)

Example 1:

>>> d.getNodeTankMixingModelType()                                 # Retrieves the  mixing model type of all tanks
>>> d.setNodeTankMixingModelType('MIX2')                           # Sets the  mixing model type = 'MIX2' to every tank
>>> d.getNodeTankMixingModelType()

Example 2: (The input array must have a length equal to the number of tanks)

>>> d.setNodeTankMixingModelType(['MIX1', 'LIFO'])                 # Sets the  mixing model type = 'MIX1' and 'LIFO' to the 2 tanks
>>> d.getNodeTankMixingModelType()

Example 3:

>>> d.setNodeTankMixingModelType(1, 'FIFO')                        # Sets the  mixing model type = 'FIFO' to the 1st tank
>>> d.getNodeTankMixingModelType()

Example 4:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMixingModelType(tankIndex, 'MIX1')                # Sets the  mixing model type = 'MIX1' to the tanks with index 128 and 129
>>> d.getNodeTankMixingModelType()

Example 5:

>>> tankIndex = d.getNodeTankIndex()
>>> d.setNodeTankMixingModelType(tankIndex, ['MIX2', 'LIFO'])      # Sets the  mixing model type = 'MIX2' and 'LIFO' to the tanks with index 128 and 129 respectively
>>> d.getNodeTankMixingModelType()

See also getNodeTankMixingModelType, setNodeTankBulkReactionCoeff, setNodeTankMixingFraction, setNodeTankMinimumWaterVolume, setNodeTankMinimumWaterLevel, setNodeTankData.

setNodeTypeJunction(Id)[source]

Transforms a node to JUNCTION The new node keeps the id,coordinates and elevation of the deleted one

Example 1:

>>> d = epanet('Net1.inp')
>>> index = d.setNodeTypeJunction('2')
>>> d.getNodeType(index)
>>> d.plot()

setNodeTypeReservoir(Id)[source]

Transforms a node to RESERVOIR The new node keeps the id,coordinates and elevation of the deleted one

Example 1:

>>> d = epanet('Net1.inp')
>>> index = d.setNodeTypeReservoir('13')
>>> d.getNodeType(index)
>>> d.plot()

setNodeTypeTank(Id)[source]

Transforms a node to TANK The new node keeps the id,coordinates and elevation of the deleted one

Example 1:

>>> d = epanet('Net1.inp')
>>> index = d.setNodeTypeTank('13')
>>> d.getNodeType(index)
>>> d.plot()

setOptionsAccuracyValue(value)[source]

Sets the total normalized flow change for hydraulic convergence.

Example:

>>> d.setOptionsAccuracyValue(0.001)
>>> d.getOptionsAccuracyValue()

See also getOptionsAccuracyValue, setOptionsExtraTrials, setOptionsMaxTrials.

setOptionsCheckFrequency(value)[source]

Sets the frequency of hydraulic status checks.

Example:

>>> d.setOptionsCheckFrequency(2)
>>> d.getOptionsCheckFrequency()

See also getOptionsCheckFrequency, setOptionsMaxTrials, setOptionsMaximumCheck.

setOptionsDampLimit(value)[source]

Sets the accuracy level where solution damping begins.

Example:

>>> d.setOptionsDampLimit(0)
>>> d.getOptionsDampLimit()

See also getOptionsDampLimit, setOptionsMaxTrials, setOptionsCheckFrequency.

setOptionsDemandCharge(value)[source]

Sets the energy charge per maximum KW usage.

Example:

>>> d.setOptionsDemandCharge(0)
>>> d.getOptionsDemandCharge()

See also getOptionsDemandCharge, setOptionsGlobalPrice, setOptionsGlobalPattern.

setOptionsEmitterExponent(value)[source]

Sets the power exponent for the emmitters.

Example:

>>> d.setOptionsEmitterExponent(0.5)
>>> d.getOptionsEmitterExponent()

See also getOptionsEmitterExponent, setOptionsPatternDemandMultiplier, setOptionsAccuracyValue.

setOptionsExtraTrials(value)[source]

Sets the extra trials allowed if hydraulics don’t converge.

Example:

>>> d.setOptionsExtraTrials(10)
>>> d.getOptionsExtraTrials()
>>> # Set UNBALANCED to STOP
>>> d.setOptionsExtraTrials(-1)

See also getOptionsExtraTrials, setOptionsMaxTrials, setOptionsMaximumCheck.

setOptionsFlowChange(value)[source]

Sets the maximum flow change for hydraulic convergence.

Example:

>>> d.setOptionsFlowChange(0)
>>> d.getOptionsFlowChange()

See also getOptionsFlowChange, setOptionsHeadError, setOptionsHeadLossFormula.

setOptionsGlobalEffic(value)[source]

Sets the global efficiency for pumps(percent).

Example:

>>> d.setOptionsGlobalEffic(75)
>>> d.getOptionsGlobalEffic()

See also getOptionsGlobalEffic, setOptionsGlobalPrice, setOptionsGlobalPattern.

setOptionsGlobalPrice(value)[source]

Sets the global average energy price per kW-Hour.

Example:

>>> d.setOptionsGlobalPrice(0)
>>> d.getOptionsGlobalPrice()

See also getOptionsGlobalPrice, setOptionsGlobalEffic, setOptionsGlobalPattern.

setOptionsGlobalPattern(value)[source]

Sets the global energy price pattern.

Example:

>>> d.setOptionsGlobalPattern(1)
>>> d.getOptionsGlobalPattern()

See also getOptionsGlobalPattern, setOptionsGlobalEffic, setOptionsGlobalPrice.

setOptionsHeadError(value)[source]

Sets the maximum head loss error for hydraulic convergence.

Example:

>>> d.setOptionsHeadError(0)
>>> d.getOptionsHeadError()

See also getOptionsHeadError, setOptionsEmitterExponent, setOptionsAccuracyValue.

setOptionsHeadLossFormula(value)[source]

Sets the headloss formula. ‘HW’ = 0, ‘DW’ = 1, ‘CM’ = 2

Example:

>>> d.setOptionsHeadLossFormula('HW')    # Sets the 'HW' headloss formula
>>> d.getOptionsHeadLossFormula()

See also getOptionsHeadLossFormula, setOptionsHeadError, setOptionsFlowChange.

setOptionsLimitingConcentration(value)[source]

Sets the limiting concentration for growth reactions.

Example:

>>> d.setOptionsLimitingConcentration(0)
>>> d.getOptionsLimitingConcentration()

See also getOptionsLimitingConcentration, setOptionsPipeBulkReactionOrder, setOptionsPipeWal

setOptionsMaximumCheck(value)[source]

Sets the maximum trials for status checking.

Example:

>>> d.setOptionsMaximumCheck(10)
>>> d.getOptionsMaximumCheck()

See also getOptionsMaximumCheck, setOptionsMaxTrials, setOptionsCheckFrequency.

setOptionsMaxTrials(value)[source]

Sets the maximum hydraulic trials allowed for hydraulic convergence.

Example:

>>> d.setOptionsMaxTrials(40)
>>> d.getOptionsMaxTrials()

See also getOptionsMaxTrials, setOptionsExtraTrials, setOptionsAccuracyValue.

setOptionsPatternDemandMultiplier(value)[source]

Sets the global pattern demand multiplier.

Example:

>>> d.setOptionsPatternDemandMultiplier(1)
>>> d.getOptionsPatternDemandMultiplier()

See also getOptionsPatternDemandMultiplier, setOptionsEmitterExponent, setOptionsAccuracyValue.

setOptionsPipeBulkReactionOrder(value)[source]

Sets the bulk water reaction order for pipes.

Example:

>>> d.setOptionsPipeBulkReactionOrder(1)
>>> d.getOptionsPipeBulkReactionOrder()

See also getOptionsPipeBulkReactionOrder, setOptionsPipeWallReactionOrder, setOptionsTankBulkReactionOrder.

setOptionsPipeWallReactionOrder(value)[source]

Sets the wall reaction order for pipes (either 0 or 1).

Example:

>>> d.setOptionsPipeWallReactionOrder(1)
>>> d.getOptionsPipeWallReactionOrder()

See also getOptionsPipeWallReactionOrder, setOptionsPipeBulkReactionOrder, setOptionsTankBulkReactionOrder.

setOptionsQualityTolerance(value)[source]

Sets the water quality analysis tolerance.

Example:

>>> d.setOptionsQualityTolerance(0.01)
>>> d.getOptionsQualityTolerance()

See also getOptionsQualityTolerance, setOptionsSpecificDiffusivity, setOptionsLimitingConcentration.

setOptionsSpecificDiffusivity(value)[source]

Sets the specific diffusivity (relative to chlorine at 20 deg C).

Example:

>>> d.setOptionsSpecificDiffusivity(1)
>>> d.getOptionsSpecificDiffusivity()

See also getOptionsSpecificDiffusivity, setOptionsSpecificViscosity, setOptionsSpecificGravity.

setOptionsSpecificGravity(value)[source]

Sets the specific gravity.

Example:

>>> d.setOptionsSpecificGravity(1)
>>> d.getOptionsSpecificGravity()

See also getOptionsSpecificGravity, setOptionsSpecificViscosity, setOptionsHeadLossFormula.

setOptionsSpecificViscosity(value)[source]

Sets the specific viscosity.

Example:

>>> d.setOptionsSpecificViscosity(1)
>>> d.getOptionsSpecificViscosity()

See also getOptionsSpecificViscosity, setOptionsSpecificGravity, setOptionsHeadLossFormula.

setOptionsTankBulkReactionOrder(value)[source]

Sets the bulk water reaction order for tanks.

Example:

>>> d.setOptionsTankBulkReactionOrder(1)
>>> d.getOptionsTankBulkReactionOrder()

See also getOptionsTankBulkReactionOrder, setOptionsPipeBulkReactionOrder, setOptionsPipeWallReactionOrder.

setOptionsPressureUnits(value)[source]: Sets the pressure unit used in Epanet Example:

inpfile = “Net3.inp” d = epanet(inpfile) d.setPressureUnit(1)

setOptionsPressureUnitsMeters()[source]

Function to set pressure units to meters and check if the change is possible.

If not possible, suggests functions to the user to enable the change.

Example:: inpfile = “Net3.inp” d = epanet(inpfile) d.setOptionsPressureUnitsMeters() x = d.getOptionsPressureUnits()

setOptionsPressureUnitsPSI()[source]

Function to set pressure units to PSI and check if the change is possible.

If not possible, suggests functions to the user to enable the change.

Example:: inpfile = “Net3.inp” d = epanet(inpfile) d.setOptionsPressureUnitsPSI() x = d.getOptionsPressureUnits()

setOptionsPressureUnitsKPA()[source]

Function to set pressure units to meters and check if the change is possible.

If not possible, suggests functions to the user to enable the change.

Example:: inpfile = “Net3.inp” d = epanet(inpfile) d.setOptionsPressureUnitsKPA() x = d.getOptionsPressureUnits()

setOptionsStatusReport(value)[source]: Sets the status report for epanet (EN_NO_REPORT, EN_NORMAL_REPORT or EN_FULL_REPORT).

setOptionsStatusReportNo()[source]

Function to set the status report option to ‘No Report’.

Returns: The result of the API call to set the status report option. In this case “NO REPORT”

Example :: inpfile = “Net3.inp” d = epanet(inpfile) d.setOptionsStatusReportNo() x = d.getOptionsStatusReport() print(x)

See Also: setOptionsStatusReportFull , setOptionsStatusReportNormal

setOptionsStatusReportFull()[source]

Function to set the status report option to ‘No Report’.

Returns: The result of the API call to set the status report option. In this case “FULL REPORT”

Example :: inpfile = “Net3.inp” d = epanet(inpfile) d.setOptionsStatusReportFull() x = d.getOptionsStatusReport() print(x)

See Also: setOptionsStatusReportNo , setOptionsStatusReportNormal

setOptionsStatusReportNormal()[source]

Function to set the status report option to ‘No Report’.

Returns: The result of the API call to set the status report option. In this case “NORMAL REPORT”

Example :: inpfile = “Net3.inp” d = epanet(inpfile) d.setOptionsStatusReportNormal() x = d.getOptionsStatusReport() print(x)

See Also: setOptionsStatusReportNo , setOptionsStatusReportFull

setQualityType(*argv)[source]

Sets the type of water quality analysis called for.

Example 1:

>>> d.setQualityType('none')                         # Sets no quality analysis.
>>> qualInfo = d.getQualityInfo()                      # Retrieves quality analysis information

Example 2:

>>> d.setQualityType('age')                          # Sets water age analysis
>>> qualInfo = d.getQualityInfo()

Example 3:

>>> d.setQualityType('chem', 'Chlorine')             # Sets chemical analysis given the name of the chemical being analyzed
>>> qualInfo = d.getQualityInfo()
>>> d.setQualityType('chem', 'Chlorine', 'mg/Kg')    # Sets chemical analysis given the name of the chemical being analyzed and units that the chemical is measured in
>>> qualInfo = d.getQualityInfo()

Example 4:

>>> nodeID = d.getNodeNameID(1)
>>> d.setQualityType('trace', nodeID)                # Sets source tracing analysis given the ID label of node traced in a source tracing analysis
>>> qualInfo = d.getQualityInfo()

See also getQualityInfo, getQualityType, getQualityCode, getQualityTraceNodeIndex.

setPattern(index, patternVector)[source]

Sets all of the multiplier factors for a specific time pattern.

Example:

>>> patternID = 'new_pattern'
>>> patternIndex = d.addPattern(patternID)     # Adds a new time pattern
>>> patternMult = [1.56, 1.36, 1.17, 1.13, 1.08,
...    1.04, 1.2, 0.64, 1.08, 0.53, 0.29, 0.9, 1.11,
...    1.06, 1.00, 1.65, 0.55, 0.74, 0.64, 0.46,
...    0.58, 0.64, 0.71, 0.66]
>>> d.setPattern(patternIndex, patternMult)    # Sets the multiplier factors for the new time pattern
>>> d.getPattern()                             # Retrieves the multiplier factor for all patterns and all times

See also getPattern, setPatternValue, setPatternMatrix, setPatternNameID, addPattern, deletePattern.

setPatternComment(value, *argv)[source]

Sets the comment string assigned to the pattern object.

Example 1:

>>> patternIndex = 1
>>> patternComment = 'This is a PATTERN'
>>> d.setPatternComment(patternIndex, patternComment)   # Sets the comment of the 1st pattern
>>> d.getPatternComment(patternIndex)                   # Retrieves the comment of the 1st pattern

Example 2:

>>> patternIndex = [1,2]
>>> patternComment = ['1st PATTERN', '2nd PATTERN']
>>> d.setPatternComment(patternIndex, patternComment)   # Sets the comments of the first 2 patterns (if exist)
>>> d.getPatternComment(patternIndex)

Example 3:

>>> d = epanet('BWSN_Network_1.inp')
>>> patternComment = ['1st PAT', '2nd PAT', '3rd PAT', "4rth PAT"]
>>> d.setPatternComment(patternComment)                 # Sets the comments of all the patterns (the length of the list
                                                          must be equal to the number of patterns)
>>> d.getPatternComment()

See also getPatternComment, setPatternNameID, setPattern.

setPatternMatrix(patternMatrix)[source]

Sets all of the multiplier factors for all time patterns.

Example:

>>> patternID_1 = 'new_pattern_1'
>>> patternIndex_1 = d.addPattern(patternID_1)    # Adds a new time pattern
>>> patternID_2 = 'new_pattern_2'
>>> patternIndex_2 = d.addPattern(patternID_2)    # Adds a new time pattern
>>> patternMult = d.getPattern()
>>> patternMult[patternIndex_1-1, 1] = 5            # The 2nd multiplier = 5 of the 1st time pattern
>>> patternMult[patternIndex_2-1, 2] = 7            # The 3rd multiplier = 7 of the 2nd time pattern
>>> d.setPatternMatrix(patternMult)               # Sets all of the multiplier factors for all the time patterns given a matrix
>>> d.getPattern()                                # Retrieves the multiplier factor for all patterns and all times

See also getPattern, setPattern, setPatternValue, setPatternNameID, addPattern, deletePattern.

setPatternNameID(index, Id)[source]

Sets the name ID of a time pattern given it’s index and the new ID.

Example 1:

>>> d.getPatternNameID()                                   # Retrieves the name IDs of all the time patterns
>>> d.setPatternNameID(1, 'Pattern1')                      # Sets to the 1st time pattern the new name ID 'Pattern1'
>>> d.getPatternNameID()

Example 2:

>>> d.setPatternNameID([1, 2], ['Pattern1', 'Pattern2'])   # Sets to the 1st and 2nd time pattern the new name IDs 'Pattern1' and 'Pattern2' respectively
>>> d.getPatternNameID()

See also getPatternNameID, getPatternIndex, getPatternLengths, setPatternComment, setPattern.

setPatternValue(index, patternTimeStep, patternFactor)[source]

Sets the multiplier factor for a specific period within a time pattern.

Example:

>>> patternID = 'new_pattern'
>>> patternIndex = d.addPattern(patternID)                          # Adds a new time pattern
>>> patternTimeStep = 2
>>> patternFactor = 5
>>> d.setPatternValue(patternIndex, patternTimeStep, patternFactor) # Sets the multiplier factor = 5 to the 2nd time period of the new time pattern
>>> d.getPattern()                                                    # Retrieves the multiplier factor for all patterns and all times

See also getPattern, setPattern, setPatternMatrix, setPatternNameID, addPattern, deletePattern.

setReport(value)[source]

Issues a report formatting command. Formatting commands are the same as used in the [REPORT] section of the EPANET Input file. More: https://github.com/OpenWaterAnalytics/EPANET/wiki/%5BREPORT%5D

Example 1:

>>> d.setReport('FILE TestReport.txt')

Example 2:

>>> d.setReport('STATUS YES')

See also setReportFormatReset, setReport.

setReportFormatReset()[source]

Resets a project’s report options to their default values.

Example:

>>> d.setReportFormatReset()

Parameters

*idsint or iterable of int, optional: Indices (1-based) of the constants to retrieve. • If no ids are given, all constants are returned. • If the first and only positional argument is an iterable

(list/tuple/set), its contents are used as the index list.

Returns

list[str]: Constant names in the order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXConstantsNameID()         # all constants
>>> d.getMSXConstantsNameID(1)        # first constant
>>> d.getMSXConstantsNameID(1, 2)     # constants 1, 2
>>> d.getMSXConstantsNameID([1, 2])   # constants 1, 2

See also getMSXConstantsCount, getMSXConstantsValue,: getMSXConstantsNameID.

getMSXParametersNameID(*ids)[source]

Return one or more MSX parameter names (IDs) by index.

Parameters

*idsint or iterable of int, optional: 1-based indices of the parameters to retrieve. • No arguments -> all parameters are returned. • One iterable -> its contents are treated as the index list. • Several ints -> those specific indices are returned.

Returns

list[str]: Parameter names in the order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXParametersNameID()          # all parameters
>>> d.getMSXParametersNameID(1)         # first parameter
>>> d.getMSXParametersNameID(1, 3)      # parameters 1 and 3
>>> d.getMSXParametersNameID([2, 4, 5]) # parameters 2, 4, 5

See also getMSXParametersCount, getMSXParametersIndex,: getMSXParametersTanksValue, getMSXParametersPipesValue.

getMSXPatternsNameID(*ids)[source]

Return one or more MSX pattern names (IDs) by index.

Parameters

*idsint or iterable of int, optional: 1-based indices of the patterns to retrieve. • Call with no arguments → all patterns are returned. • Pass a single iterable → its contents are treated as the index list. • Pass several ints → those specific indices are returned.

Returns

list[str]: Pattern names in the order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’) d.addMSXPattern(‘P1’, [1.0, 0.0, 1.0]) d.addMSXPattern(‘P2’, [0.0, 0.0, 2.0]) d.addMSXPattern(‘P3’, [0.0, 1.0, 2.0]) d.addMSXPattern(‘P4’, [1.0, 1.0, 2.0])

Examples

>>> d.getMSXPatternsNameID()            # all patterns
>>> d.getMSXPatternsNameID(1)           # first pattern
>>> d.getMSXPatternsNameID(1, 3)        # patterns 1 and 3
>>> d.getMSXPatternsNameID([2, 4, 5])   # patterns 2, 4, 5

See also getMSXPattern, getMSXPatternsIndex, getMSXPatternsLengths,: setMSXPattern, setMSXPatternMatrix, setMSXPatternValue.

getMSXSpeciesNameID(*argv)[source]

Retrieves the species’ ID.

Example:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’) d.getMSXSpeciesNameID() Retrieves the IDs of all the species. d.getMSXSpeciesNameID(1) Retrieves the IDs of the first specie.
See also getMSXSpeciesIndex, getMSXSpeciesCount, getMSXSpeciesConcentration,: getMSXSpeciesType, getMSXSpeciesUnits, getMSXSpeciesATOL, getMSXSpeciesRTOL.

getMSXParametersIndex(*names)[source]

Return the MSX index of one or more parameters, looked up by name.

Parameters

*namesstr or iterable of str, optional: Parameter IDs (names) to look up. • Call with no arguments → all parameters are returned. • A single iterable → its contents are used as the name list. • Several strings → those exact names are looked up.

Returns

list[int]: Parameter indices, in the same order the names were requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXParametersIndex()                       # all parameters
>>> d.getMSXParametersIndex('k1')                   # index of 'k1'
>>> d.getMSXParametersIndex('k1', 'k3', 'kDOC1')    # specific set
>>> d.getMSXParametersIndex(['k1', 'k3'])           # list/iterable

See also getMSXParametersCount, getMSXParametersIndex,: getMSXParametersTanksValue, getMSXParametersPipesValue.

getMSXSpeciesIndex(*names)[source]

Return the MSX index (1-based) of one or more species.

Parameters

*namesstr | iterable[str], optional

Species IDs (names) to look up.

No arguments – return indices for all species.
One iterable – its elements are treated as the list of names.
Several strings – those specific species names.

Returns

list[int]: Indices in the same order the names were requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXSpeciesIndex()                     # all species
>>> d.getMSXSpeciesIndex('NH3')                 # index of Na
>>> d.getMSXSpeciesIndex('NH2CL', 'NH3', 'H')    # CL2, Nb, Na
>>> d.getMSXSpeciesIndex(['NH3', 'TOC'])        # iterable form

See also getMSXSpeciesUnits, getMSXSpeciesCount, getMSXSpeciesConcentration,: getMSXSpeciesType, getMSXSpeciesNameID, getMSXSpeciesRTOL, getMSXSpeciesATOL.

getMSXPatternsIndex(*names)[source]

Return the MSX index (1-based) of one or more patterns.

Parameters

*namesstr | iterable[str], optional: Pattern names (IDs) to look up. • No arguments – indices of all patterns are returned. • One iterable – its elements are treated as the name list. • Several strings – those exact pattern names.

Returns

list[int]: Pattern indices in the same order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’) d.addMSXPattern(‘P1’, [1.0, 0.0, 1.0]) d.addMSXPattern(‘P2’, [0.0, 0.0, 2.0]) d.addMSXPattern(‘P3’, [0.0, 1.0, 2.0]) d.addMSXPattern(‘P4’, [1.0, 1.0, 2.0])

Examples:

>>> d.getMSXPatternsIndex()                     # all patterns
>>> d.getMSXPatternsIndex('P1')                 # index of 'P1'
>>> d.getMSXPatternsIndex('P1', 'P2', 'P3')     # specific set
>>> d.getMSXPatternsIndex(['P1', 'P3'])         # iterable form

See also getMSXPattern, getMSXPatternsNameID, getMSXPatternsLengths,: setMSXPattern, setMSXPatternMatrix, setMSXPatternValue.

getMSXConstantsIndex(*names)[source]

Return the MSX indices (1-based) of one or more constants.

Parameters

*namesstr | iterable[str], optional: Constant IDs to look up. • No arguments – return indices for all constants. • One iterable – its elements form the lookup list. • Several strings – those exact constant names.

Returns

list[int]: Indices in the same order the names were requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXConstantsIndex()             # all constants
>>> d.getMSXConstantsIndex('S1')         # index of 'S1'
>>> d.getMSXConstantsIndex('S1', 'S2')   # specific set
>>> d.getMSXConstantsIndex(['S2', 'S1']) # iterable form

See also getMSXConstantsCount, getMSXConstantsValue,
getMSXConstantsNameID.

getMSXConstantsValue(*indices)[source]

Return the value of one or more MSX constants, addressed by index.

Parameters

*indicesint | iterable[int], optional: 1-based constant indices. • No arguments → values for all constants. • One iterable → its items are the index list. • Several ints → those exact indices.

Returns

list[float]: Constant values, in the same order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXConstantsValue()            # all constants
>>> d.getMSXConstantsValue(1)           # constant 1
>>> d.getMSXConstantsValue(1, 2)        # constants 1 and 2
>>> d.getMSXConstantsValue([2, 1])   # iterable form

See also setMSXConstantsValue, getMSXConstantsCount,: getMSXConstantsIndex, getMSXConstantsNameID

getMSXParametersPipesValue()[source]

Retrieves the parameters pipes value.

Example:: d = epanet(‘net2-cl2.inp’) d.loadMSXFile(‘net2-cl2.msx’) d.getMSXParametersPipesValue()
See also setMSXParametersPipesValue, getMSXParametersTanksValue,: getMSXParametersCount, getMSXParametersIndex.

getMSXParametersTanksValue()[source]

Retrieves the parameters tanks value.

Example:: d = epanet(‘net2-cl2.inp’) d.loadMSXFile(‘net2-cl2.msx’) tankIndex = d.getNodeTankIndex() d.getMSXParametersTanksValue{tankIndex} Retrieves the value of the first tank.
See also setMSXParametersTanksValue, getMSXParametersCount,: getMSXParametersIndex, getMSXParametersPipesValue.

getMSXPatternsLengths(*indices)[source]

Return the length (number of factors) of one or more MSX patterns.

Parameters

*indicesint | iterable[int], optional: 1-based pattern indices. • No arguments → return the length of all patterns. • One iterable → its items are treated as the index list. • Several ints → those exact pattern indices.

Returns

list[int]: Pattern lengths in the same order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’) d.addMSXPattern(‘P1’, [1.0, 0.0, 1.0]) d.addMSXPattern(‘P2’, [0.0, 0.0, 2.0]) d.addMSXPattern(‘P3’, [0.0, 1.0, 2.0]) d.addMSXPattern(‘P4’, [1.0, 1.0, 2.0])

Examples:

>>> d.getMSXPatternsLengths()           # all patterns
>>> d.getMSXPatternsLengths(1)          # pattern 1
>>> d.getMSXPatternsLengths(1, 2)       # patterns 1 and 2
>>> d.getMSXPatternsLengths([2, 4])     # iterable form

getMSXPattern()[source]

Retrieves the time patterns.

Example:: d = epanet(‘net2-cl2.inp’) d.loadMSXFile(‘net2-cl2.msx’) d.addMSXPattern(‘P1’, [1.0 0.0 1.0]) d.addMSXPattern(‘P2’, [1.0 0.0 1.0]) d.addMSXPattern(‘P3’, [0.0 1.0 2.0]) d.addMSXPattern(‘P4’, [1.0 2.0 2.5]) patterns = d.getMSXPattern() Retrieves all the patterns.
See also setMSXPattern, setMSXPatternMatrix, setMSXPatternValue,: getMSXPatternsIndex, getMSXPatternsNameID,.

getMSXSpeciesType(*indices)[source]

Return the MSX type (bulk-flow, wall, etc.) of one or more species.

Parameters

*indicesint | iterable[int], optional: 1-based species indices. • No arguments → types for all species. • One iterable → its items are treated as the index list. • Several ints → those exact species indices.

Returns

list[int]: Species-type codes in the same order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXSpeciesType()           # all species
>>> d.getMSXSpeciesType(1)          # species 1
>>> d.getMSXSpeciesType(5, 7)       # species 5 and 7
>>> d.getMSXSpeciesType([2, 4, 6])  # iterable form

See also getMSXSpeciesIndex, getMSXSpeciesCount, getMSXSpeciesConcentration,
getMSXSpeciesnameID, getMSXSpeciesUnits, getMSXSpeciesATOL, getMSXSpeciesRTOL.

getMSXSpeciesUnits(*indices)[source]

Return the units string for one or more MSX species.

Parameters

*indicesint | iterable[int], optional: 1-based species indices. • No arguments – return units for all species. • One iterable – its elements are treated as the index list. • Several ints – those exact species indices.

Returns

list[str]: Units strings in the same order requested.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXSpeciesUnits()             # all species
>>> d.getMSXSpeciesUnits(1)            # species 1
>>> d.getMSXSpeciesUnits(1, 16)        # species 1 and 16
>>> d.getMSXSpeciesUnits([2, 4, 5])    # iterable form
See also getMSXSpeciesIndex, getMSXSpeciesCount, getMSXSpeciesConcentration,
              getMSXSpeciesType, getMSXSpeciesNameID, getMSXSpeciesATOL,
              getMSXSpeciesRTOL.

getMSXEquationsTerms()[source]

Retrieves equation terms.

Example:: d = epanet(‘net2-cl2.inp’) d.loadMSXFile(‘net2-cl2.msx’) d.getMSXEquationsTerms()

See also getMSXEquationsPipes, getMSXEquationsTanks.

getMSXEquationsPipes()[source]

Retrieves equation for pipes.

Example:: d = epanet(‘net2-cl2.inp’) d.loadMSXFile(‘net2-cl2.msx’) d.getMSXEquationsPipes()

See also getMSXEquationsTerms, getMSXEquationsTanks.

getMSXEquationsTanks()[source]

Retrieves equation for tanks.

Example:: d = epanet(‘net2-cl2.inp’) d.loadMSXFile(‘net2-cl2.msx’) d.getMSXEquationsTanks()

See also getMSXEquationsTerms, getMSXEquationsPipes.

getMSXSources()[source]: Retrieves Msx sources

getMSXSourceType(*nodes)[source]

Return the source-type code(s) for one or more nodes.

Each MSX source is defined per (node, species). The toolkit call MSXgetsource(node, species) returns a 4-tuple (type, level, pattern, _reserved); we keep only the first element (the type code).

Parameters

*nodesint | iterable[int], optional: 1-based node indices. • No arguments → all nodes. • One iterable → its items are treated as the node list. • Several ints → those exact nodes.

Returns

list[list[int]]: Outer list follows the order requested; inner list contains the source- type code for every species at that node (length = getMSXSpeciesCount()).
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXSourceType()            # all nodes
>>> d.getMSXSourceType(1)           # node 1
>>> d.getMSXSourceType(1, 2)        # nodes 1 and 2
>>> d.getMSXSourceType([3, 5, 7])   # iterable form

See also getMSXSources, getMSXSourceNodeNameID: getMSXSourceLevel, getMSXSourcePatternIndex.

getMSXSourceLevel(*nodes)[source]

Return the level value of one or more MSX sources.

For every (node, species) pair the EPANET-MSX toolkit call MSXgetsource(node, species) returns a 4-tuple (type, level, pattern, _reserved). This helper extracts only level (index 1).

Parameters

*nodesint | iterable[int], optional: 1-based node indices. • No arguments – all nodes. • One iterable – its items are treated as the node list. • Several ints – those exact node indices.

Returns

list[list[float]]: Outer list follows the order requested; each inner list contains the level for every species at that node (length = getMSXSpeciesCount()).
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXSourceLevel()               # levels for all nodes
>>> d.getMSXSourceLevel(1)              # node 1
>>> d.getMSXSourceLevel(1, 5)           # nodes 1 and 5
>>> d.getMSXSourceLevel([2, 4, 7])      # iterable form

See also getMSXSources, getMSXSourceNodeNameID: getMSXSourceType, getMSXSourcePatternIndex.

getMSXSourcePatternIndex(*nodes)[source]

Return the pattern index associated with the source at one or more nodes.

For every (node, species) pair the EPANET-MSX call

MSXgetsource(node, species)

returns a 4-tuple (type, level, patternIndex, _reserved). This helper extracts only patternIndex (element 2).

Parameters

*nodesint | iterable[int], optional: 1-based node indices. • No arguments → pattern indices for all nodes. • One iterable → its elements are the node list. • Several ints → those exact nodes.

Returns

list[list[int]]: Outer list follows the order requested; each inner list contains the pattern index for every species at that node (length = getMSXSpeciesCount()).
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXSourcePatternIndex()              # every node
>>> d.getMSXSourcePatternIndex(1)             # node 1
>>> d.getMSXSourcePatternIndex(1, 5)          # nodes 1 and 5
>>> d.getMSXSourcePatternIndex([2, 4, 7])     # iterable form

See also getMSXSources, getMSXSourceNodeNameID: getMSXSourceType, getMSXSourceLevel.

getMSXLinkInitqualValue(*links)[source]

Return the initial-quality value for one or more links.

Parameters

*linksint | iterable[int], optional: 1-based link indices. • No arguments → values for all links. • One iterable → its items are treated as the index list. • Several ints → those exact link indices.

Returns

list[list[float]]: Outer list follows the order requested; each inner list contains the initial-quality value for every species at that link (length = getMSXSpeciesCount()).
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXLinkInitqualValue()             # every link
>>> d.getMSXLinkInitqualValue(1)            # link 1
>>> d.getMSXLinkInitqualValue(1, 3)         # links 1 and 3
>>> d.getMSXLinkInitqualValue([2, 5, 7])    # iterable form

Parameters

*nodesint or iterable of int, optional: 1-based node indices. • No arguments → all nodes. • One iterable → the iterable’s contents are the node list. • Several ints → those specific nodes.

Returns

list[list[float]]: Outer list is in the same order requested; each inner list contains the species-quality values for that node.
Setup:: d = epanet(‘Net3-NH2CL.inp’) d.loadMSXFile(‘Net3-NH2CL.msx’)

Examples:

>>> d.getMSXNodeInitqualValue()          # all nodes
>>> d.getMSXNodeInitqualValue(1)         # node 1
>>> d.getMSXNodeInitqualValue(1, 3, 7)   # nodes 1, 3, 7
>>> d.getMSXNodeInitqualValue([2, 5])    # nodes 2 and 5

Parameters:

resultsobj
A results object returned by getMSXComputedQualityNode. It must expose Time (1-D array-like) and Quality

output_filestr, default "computedtoexcel.xlsx"
Name (or path) for the Excel file to create. “.xlsx” is appended automatically when omitted.

selected_nodeslist[str | int] | None, default None
Node IDs or zero-based node indices to include. • None → export all nodes. • Strings → treated as node IDs. • Integers → treated as node indices.

selected_specieslist[str | int] | None, default None
Species names or zero-based species indices to include. Same ID / index rules as selected_nodes.

headerbool, default True
Write column headers (“NODE INDEX”, “NODE ID”, time steps …). If False, headers are suppressed and the first data row is removed—useful for appending to an existing sheet.

Simple Example with all nodes and species:
G = epanet(“net2-cl2.inp”) G.loadMSXFile(“net2-cl2.msx”) MSX_comp = G.getMSXComputedQualityNode() G.exportMSXts(MSX_comp, “net2”) G.exportMSXstatistics(“net2”,”summarynet2”)

Advanced Examples:
G = epanet(“net2-cl2.inp”) G.loadMSXFile(“net2-cl2.msx”)

# Run MSX simulation and grab node-quality results msx_results = G.getMSXComputedQualityNode()

# 1) Export every species for every node (default behaviour) G.exportMSXts(msx_results, “net2_full.xlsx”)

# 2) Export only chlorine for two specific nodes, keep headers G.exportMSXts(

MSX_comp, output_file=”chlorine_subset.xlsx”, selected_nodes=[“10”, “15”], #select nodes by their id selected_species=[“CL2”]

)

G.exportMSXts(

MSX_comp, output_file=”chlorine_subset1.xlsx”, selected_nodes=[9, 14], #select node by their index selected_species=[“CL2”]

)

# 3) Export species index 0 for nodes 0-4, omit headers G.exportMSXts(

msx_results, “first_species_nodes0to4.xlsx”, selected_nodes=list(range(5)), selected_species=[0], #select specie by its index header=False

exportMSXstatistics(input_path, output_path='summary_output.xlsx', nodeids=True, nodeindex=True)[source]

Summarizes min, max, and average values for each node in an Excel file with a specific structure.

Parameters:: input_path (str): Path to the input Excel file. output_path (str): Path to save the output summary Excel file. nodeids (bool): Include node IDs (from column 1) in the summary. nodeindex (bool): Include node index (from column 0) in the summary.
Simple Example with all nodes and species:: G = epanet(“net2-cl2.inp”) G.loadMSXFile(“net2-cl2.msx”) MSX_comp = G.getMSXComputedQualityNode() G.exportMSXts(MSX_comp, “net2”) G.exportMSXstatistics(“net2”,”summarynet2”)

# Example usage: exportMSXstatistics(“outexcel3.xlsx”,”summary_output1.xlsx”, nodeids=True, nodeindex=False) # Only node IDs exportMSXstatistics(“outexcel3.xlsx”, “summary_output2.xlsx”,nodeids=False, nodeindex=True) # Only node indices exportMSXstatistics(“outexcel3.xlsx”,”summary_output3.xlsx”, nodeids=True, nodeindex=True) # Both

epyt package

Subpackages

Submodules

epyt.epanet module

Parameters

Returns

Examples

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters

Returns

Examples:

Parameters:

Module contents