Skip to content

Commit

Permalink
add parameter display_msg, some fixes, refactor code.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Mariosmsk
Mariosmsk committed May 11, 2024
1 parent 449f5b7 commit 290548e
Showing 1 changed file with 34 additions and 35 deletions.
69 changes: 34 additions & 35 deletions epyt/epanet.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,8 +510,9 @@ class epanet:
d = epanet(inpname, msx=True,customlib=epanetlib)
"""

def __init__(self, *argv, version=2.2, ph=False, loadfile=False, customlib=None):
def __init__(self, *argv, version=2.2, ph=False, loadfile=False, customlib=None, display_msg=True):
# Constants
self.msx = None
warnings.simplefilter('always')
# Demand model types. DDA #0 Demand driven analysis,
# PDA #1 Pressure driven analysis.
Expand Down Expand Up @@ -573,8 +574,10 @@ def __init__(self, *argv, version=2.2, ph=False, loadfile=False, customlib=None)
# Initial attributes
self.classversion = __version__
self.api = epanetapi(version, ph=ph, customlib=customlib)
print(f'EPANET version {self.getVersion()} '
f'loaded (EPyT version {self.classversion}).')
self.display_msg = display_msg
if self.display_msg:
print(f'EPANET version {self.getVersion()} '
f'loaded (EPyT version {self.classversion}).')

# ToolkitConstants: Contains all parameters from epanet2_2.h
self.ToolkitConstants = ToolkitConstants()
Expand Down Expand Up @@ -632,7 +635,8 @@ def __init__(self, *argv, version=2.2, ph=False, loadfile=False, customlib=None)
self.netName = os.path.basename(self.InputFile)
self.LibEPANETpath = self.api.LibEPANETpath
self.LibEPANET = self.api.LibEPANET
print(f'Input File {self.netName} loaded successfully.\n')
if self.display_msg:
print(f'Input File {self.netName} loaded successfully.\n')

# Global plot settings
plt.rcParams["figure.figsize"] = [3, 2]
Expand Down Expand Up @@ -3697,7 +3701,7 @@ def getLinkVertices(self, *argv):
continue
x_mat = []
y_mat = []
for j in range(1, self.getLinkVerticesCount(i) +1):
for j in range(1, self.getLinkVerticesCount(i) + 1):
xy = self.api.ENgetvertex(i, j)
x_mat.append(xy[0])
y_mat.append(xy[1])
Expand Down Expand Up @@ -10394,7 +10398,9 @@ def unload(self):
safe_delete(file)
except:
pass
print(f'Close toolkit for the input file "{self.netName[0:-4]}". EPANET Toolkit is unloaded.\n')
if self.display_msg:
print(f'Close toolkit for the input file "{self.netName[0:-4]}". EPANET Toolkit is '
f'unloaded.\n')

def useHydraulicFile(self, hydname):
""" Uses the contents of the specified file as the current binary hydraulics file.
Expand Down Expand Up @@ -11185,8 +11191,8 @@ def loadMSXFile(self, msxname, customMSXlib=None, ignore_properties=False):
Example using custom msx library :
msxlib=os.path.join(os.getcwd(), 'epyt','libraries','win','epanetmsx.dll')

d = epanet(inpname, msx=True,customlib=epanetlib)
d.loadMSXFile(msxname,customMSXlib=msxlib)"""
d = epanet(inpname, msx=True, customlib=epanetlib)
d.loadMSXFile(msxname, customMSXlib=msxlib)"""

if not os.path.exists(msxname):
for root, dirs, files in os.walk(resource_filename("epyt", "")):
Expand All @@ -11203,16 +11209,10 @@ def loadMSXFile(self, msxname, customMSXlib=None, ignore_properties=False):
copyfile(msxname, self.msxname)
self.msx = epanetmsxapi(self.msxname, customMSXlib=customMSXlib)

# Message to user if he uses ph with msx
if self.api.ph is not None:
warnings.warn('Please set ph=False when using MSX.')




#message to user if he uses ph with msx
if self.api._ph is not None:
print("In order for LoadMSX to work remove from epanet the ph")
print("Example: change this line ")
print("from this: <<<d = epanet(inpname,ph=True, customlib=epanetlib)")
print("To this: <<<d = epanet(inpname, customlib=epanetlib)")
if ignore_properties:
self.msx.MSXEquationsTerms = self.getMSXEquationsTerms()
self.msx.MSXEquationsPipes = self.getMSXEquationsPipes()
Expand All @@ -11223,7 +11223,7 @@ def loadMSXFile(self, msxname, customMSXlib=None, ignore_properties=False):
self.msx.MSXPatternsCount = self.getMSXPatternsCount()
self.msx.MSXSpeciesIndex = self.getMSXSpeciesIndex()
self.msx.MSXSpeciesNameID = self.getMSXSpeciesNameID()
self.MSXSpeciesType = self.getMSXSpeciesType()
self.msx.MSXSpeciesType = self.getMSXSpeciesType()
self.msx.MSXSpeciesUnits = self.getMSXSpeciesUnits()
self.msx.MSXSpeciesATOL = self.getMSXSpeciesATOL()
self.msx.MSXSpeciesRTOL = self.getMSXSpeciesRTOL()
Expand Down Expand Up @@ -11446,8 +11446,9 @@ def getMSXOptions(self):
# PECLET value
try:
# Key-value pairs to search for
keys = ["AREA_UNITS", "RATE_UNITS", "SOLVER", "COUPLING", "TIMESTEP", "ATOL", "RTOL", "COMPILER", "SEGMENTS", \
"PECLET"]
keys = ["AREA_UNITS", "RATE_UNITS", "SOLVER", "COUPLING", "TIMESTEP", "ATOL", "RTOL", "COMPILER",
"SEGMENTS", \
"PECLET"]
float_values = ["TIMESTEP", "ATOL", "RTOL", "SEGMENTS", "PECLET"]
values = {key: None for key in keys}

Expand Down Expand Up @@ -12880,9 +12881,9 @@ def setMSXLinkInitqualValue(self, value):
"""
for i in range(len(value)):
for j in range(len(value[0])):
self.msx.MSXsetinitqual(1, i+1, j+1, value[i][j])
self.msx.MSXsetinitqual(1, i + 1, j + 1, value[i][j])

def setMSXSources(self, nodeID, speciesID, sourcetype, concentration, patID ):
def setMSXSources(self, nodeID, speciesID, sourcetype, concentration, patID):
""" Sets the attributes of an external source of a particular chemical species
to a specific node of the pipe network.

Expand All @@ -12900,7 +12901,7 @@ def setMSXSources(self, nodeID, speciesID, sourcetype, concentration, patID ):
MSXTYPESOURCE = {'NOSOURCE', 'CONCEN', 'MASS', 'SETPOINT', 'FLOWPACED'}
node = self.getNodeIndex(nodeID)
species = self.getMSXSpeciesIndex(speciesID)
species=species[0]
species = species[0]
pat = self.getMSXPatternsIndex(patID)
pat = pat[0]
if sourcetype == 'NOSOURCE' or sourcetype == 'nosource':
Expand All @@ -12911,7 +12912,7 @@ def setMSXSources(self, nodeID, speciesID, sourcetype, concentration, patID ):
type = 1
elif sourcetype == 'SETPOINT' or sourcetype == 'setpoint':
type = 2
elif sourcetype == 'FLOWPACED' or sourcetype == 'flowpaced':
elif sourcetype == 'FLOWPACED' or sourcetype == 'flowpaced':
type = 3

self.msx.MSXsetsource(node, species, type, concentration, pat)
Expand All @@ -12932,7 +12933,8 @@ def setMSXNodeInitqualValue(self, value):
"""
for i in range(len(value)):
for j in range(len(value[0])):
self.msx.MSXsetinitqual(0, i+1, j+1, value[i][j])
self.msx.MSXsetinitqual(0, i + 1, j + 1, value[i][j])

def setMSXWrite(self):
value = EpytValues()
value.FILENAME = ""
Expand All @@ -12957,14 +12959,14 @@ def setMSXWrite(self):
value.PARAMETERS = {}
value.PATERNS = {}


return value

def writeMSXFile(self, msx):
filename = msx.FILENAME
with open(filename, 'w')as f:
with open(filename, 'w') as f:
f.write("[TITLE]\n")
f.write(msx.TITLE)
#OPTIONS
# OPTIONS
f.write("\n\n[OPTIONS]")
ans = msx.AREA_UNITS
f.write("\nAREA_UNITS\t{}".format(ans))
Expand All @@ -12983,7 +12985,6 @@ def writeMSXFile(self, msx):
ans = msx.ATOL
f.write("\nATOL\t\t{}".format(ans))


f.write("\n\n[SPECIES]\n")
ans = list(msx.SPECIES)
for item in ans:
Expand Down Expand Up @@ -13026,7 +13027,6 @@ def writeMSXFile(self, msx):
for item in ans:
f.write("{}\n".format(item))


f.write('\n[REPORT]\n')
f.write('NODES ALL\n')
f.write('LINKS ALL\n')
Expand Down Expand Up @@ -13504,7 +13504,6 @@ def ENgetaveragepatternvalue(self, index):
value The average of all of the time pattern's factors.
"""


if self._ph is not None:
value = c_double()
self.errcode = self._lib.EN_getaveragepatternvalue(self._ph, int(index), byref(value))
Expand Down Expand Up @@ -13868,7 +13867,6 @@ def ENgetdemandname(self, node_index, demand_index):
OWA-EPANET Toolkit: http://wateranalytics.org/EPANET/group___demands.html
"""


if self._ph is not None:
demand_name = create_string_buffer(100)
self.errcode = self._lib.EN_getdemandname(self._ph, int(node_index), int(demand_index),
Expand Down Expand Up @@ -14644,7 +14642,7 @@ def ENgetvertex(self, index, vertex):
x the vertex's X-coordinate value.
y the vertex's Y-coordinate value.
"""
x = c_double() # need double for EN_ or EN functions.
x = c_double() # need double for EN_ or EN functions.
y = c_double()
if self._ph is not None:
self.errcode = self._lib.EN_getvertex(self._ph, int(index), vertex, byref(x), byref(y))
Expand Down Expand Up @@ -15694,7 +15692,8 @@ def ENsettankdata(self, index, elev, initlvl, minlvl, maxlvl, diam, minvol, volc
c_double(maxlvl), c_double(diam), c_double(minvol), volcurve.encode('utf-8'))
else:
self.errcode = self._lib.ENsettankdata(index, c_float(elev), c_float(initlvl), c_float(minlvl),
c_float(maxlvl), c_float(diam), c_float(minvol), volcurve.encode('utf-8'))
c_float(maxlvl), c_float(diam), c_float(minvol),
volcurve.encode('utf-8'))

self.ENgeterror()

Expand Down Expand Up @@ -15783,7 +15782,7 @@ def ENsetvertices(self, index, x, y, vertex):

else:
self.errcode = self._lib.ENsetvertices(int(index), (c_double * vertex)(*x),
(c_double * vertex)(*y), vertex)
(c_double * vertex)(*y), vertex)

self.ENgeterror()

Expand Down

0 comments on commit 290548e

Please sign in to comment.