From eea000145885d6ebb4eb41df075cb5928a2e8924 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 10:22:18 +0800 Subject: [PATCH 01/12] Ignore db inp --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index c713d15..376844c 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,6 @@ __pycache__/ # dev_demo dev_demo.py + +# db inp +*.db.inp From 2c43e5ad6daae7a6c0b44abada4daa57b8f9f162 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 10:22:35 +0800 Subject: [PATCH 02/12] Add epanet module --- epanet/__init__.py | 1 + 1 file changed, 1 insertion(+) create mode 100644 epanet/__init__.py diff --git a/epanet/__init__.py b/epanet/__init__.py new file mode 100644 index 0000000..437d5bd --- /dev/null +++ b/epanet/__init__.py @@ -0,0 +1 @@ +from .epanet import run_project \ No newline at end of file From 74509acc50fb9639de4d287755a5a60f0b6e553e Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 11:11:56 +0800 Subject: [PATCH 03/12] Start to read output --- epanet/epanet.py | 44 +++++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index 56bb8ed..ce661be 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -6,40 +6,54 @@ sys.path.append("..") from api import project from api import parser -_lib_core = None -_lib_output = None -def _load_epanet(): +def _verify_platform(): _platform = platform.system() if _platform != "Windows": raise Exception(f'Platform {_platform} unsupported (not yet)') - _lib_core = ctypes.CDLL("./epanet2.dll") - #version = ctypes.c_int() - #lib_core.EN_getversion(ctypes.byref(version)) - #print(f'Load EPANET {version}') - _lib_output = ctypes.CDLL("./epanet-output.dll") + + +def _check(result): + if result != 0: + raise Exception("Failed to read output {name}") + # readable True => json, False => binary output def run_project(name: str, readable: bool = True) -> str: if not project.have_project(name): - raise Exception("No such project!") + raise Exception(f'Not found project {name}') dir = os.path.dirname(os.getcwd()) db_inp = os.path.join(os.path.join(dir, 'db_inp'), name + '.db.inp') parser.dump_inp(name, db_inp) - name += '.db' - + input = name + '.db' exe = os.path.join(os.path.join(dir, 'epanet'), 'runepanet.exe') - inp = os.path.join(os.path.join(dir, 'db_inp'), name + '.inp') - rpt = os.path.join(os.path.join(dir, 'temp'), name + '.rpt') - opt = os.path.join(os.path.join(dir, 'temp'), name + '.opt') + inp = os.path.join(os.path.join(dir, 'db_inp'), input + '.inp') + rpt = os.path.join(os.path.join(dir, 'temp'), input + '.rpt') + opt = os.path.join(os.path.join(dir, 'temp'), input + '.opt') command = f'{exe} {inp} {rpt} {opt}' #print(command) result = os.system(command) + if result != 0: + raise Exception("Failed to run simulation for project {name}") + + _lib_output = ctypes.CDLL(os.path.join(os.getcwd(), 'epanet-output.dll')) + + handle = ctypes.c_void_p() + + _check(_lib_output.ENR_init(ctypes.byref(handle))) + + _check(_lib_output.ENR_open(handle, ctypes.c_char_p(opt.encode()))) + + + + _check(_lib_output.ENR_close(ctypes.byref(handle))) + return '' + if __name__ == '__main__': - _load_epanet() + _verify_platform() run_project('net3') From 5faab15da6b085ce8ef344e86b47cd3c1be6077a Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 11:26:04 +0800 Subject: [PATCH 04/12] Add closure --- epanet/epanet.py | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index ce661be..1ad3169 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -13,11 +13,6 @@ def _verify_platform(): raise Exception(f'Platform {_platform} unsupported (not yet)') -def _check(result): - if result != 0: - raise Exception("Failed to read output {name}") - - # readable True => json, False => binary output def run_project(name: str, readable: bool = True) -> str: if not project.have_project(name): @@ -34,7 +29,7 @@ def run_project(name: str, readable: bool = True) -> str: rpt = os.path.join(os.path.join(dir, 'temp'), input + '.rpt') opt = os.path.join(os.path.join(dir, 'temp'), input + '.opt') command = f'{exe} {inp} {rpt} {opt}' - #print(command) + result = os.system(command) if result != 0: raise Exception("Failed to run simulation for project {name}") @@ -43,12 +38,14 @@ def run_project(name: str, readable: bool = True) -> str: handle = ctypes.c_void_p() + def _check(result): + if result != 0: + raise Exception(f'Failed to read output {name}') + _check(_lib_output.ENR_init(ctypes.byref(handle))) _check(_lib_output.ENR_open(handle, ctypes.c_char_p(opt.encode()))) - - _check(_lib_output.ENR_close(ctypes.byref(handle))) return '' From 36d121a425937727ed6815862afe31e4143dbc91 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 17:08:12 +0800 Subject: [PATCH 05/12] Read data from output --- epanet/epanet.py | 93 ++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 75 insertions(+), 18 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index 1ad3169..4a3b670 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -13,10 +13,81 @@ def _verify_platform(): raise Exception(f'Platform {_platform} unsupported (not yet)') +class Output: + def __init__(self, name: str) -> None: + self._name = name + + self._lib = ctypes.CDLL(os.path.join(os.getcwd(), 'epanet-output.dll')) + + self._handle = ctypes.c_void_p() + self._check(self._lib.ENR_init(ctypes.byref(self._handle))) + + dir = os.path.dirname(os.getcwd()) + opt = os.path.join(os.path.join(dir, 'temp'), self._name + '.db.opt') + self._check(self._lib.ENR_open(self._handle, ctypes.c_char_p(opt.encode()))) + + + def _check(self, result): + if result != 0: + msg = ctypes.c_char_p() + code = self._lib.ENR_checkError(self._handle, ctypes.byref(msg)) + assert code == result + + error = f'Failed to read project [{self._name}] output, message [{msg.value.decode()}]' + + self._lib.ENR_free(ctypes.byref(msg)) + + raise Exception(error) + + + def version(self) -> int: + v = ctypes.c_int() + self._check(self._lib.ENR_getVersion(self._handle, ctypes.byref(v))) + return v.value + + + def net_size(self) -> dict[str, int]: + element_count = ctypes.POINTER(ctypes.c_int)() + length = ctypes.c_int() + self._check(self._lib.ENR_getNetSize(self._handle, ctypes.byref(element_count), ctypes.byref(length))) + assert length.value == 5 + category = ['node', 'tank', 'link', 'pump', 'valve'] + counts = {} + for i in range(length.value): + counts[category[i]] = element_count[i] + self._lib.ENR_free(ctypes.byref(element_count)) + return counts + + + def units(self) -> dict[str, str]: + f_us = ['CFS', 'GPM', 'MGD', 'IMGD', 'AFD', 'LPS', 'LPM', 'MLD', 'CMH', 'CMD'] + p_us = ['PSI', 'MTR', 'KPA'] + q_us = ['NONE', 'MGL', 'UGL', 'HOURS', 'PRCNT'] + f, p, q = ctypes.c_int(1), ctypes.c_int(2), ctypes.c_int(3) + f_u, p_u, q_u = ctypes.c_int(), ctypes.c_int(), ctypes.c_int() + self._check(self._lib.ENR_getUnits(self._handle, f, ctypes.byref(f_u))) + self._check(self._lib.ENR_getUnits(self._handle, p, ctypes.byref(p_u))) + self._check(self._lib.ENR_getUnits(self._handle, q, ctypes.byref(q_u))) + return { 'flow': f_us[f_u.value], 'pressure': p_us[p_u.value], 'quality': q_us[q_u.value] } + + + def __del__(self): + # throw exception in destructor ? :) + self._check(self._lib.ENR_close(ctypes.byref(self._handle))) + + +def _read_output(name: str) -> str: + opt = Output(name) + print(opt.version()) + print(opt.net_size()) + print(opt.units()) + return '' + + # readable True => json, False => binary output def run_project(name: str, readable: bool = True) -> str: if not project.have_project(name): - raise Exception(f'Not found project {name}') + raise Exception(f'Not found project [{name}]') dir = os.path.dirname(os.getcwd()) @@ -32,25 +103,11 @@ def run_project(name: str, readable: bool = True) -> str: result = os.system(command) if result != 0: - raise Exception("Failed to run simulation for project {name}") + raise Exception("Failed to run simulation for project [{name}]") - _lib_output = ctypes.CDLL(os.path.join(os.getcwd(), 'epanet-output.dll')) - - handle = ctypes.c_void_p() - - def _check(result): - if result != 0: - raise Exception(f'Failed to read output {name}') - - _check(_lib_output.ENR_init(ctypes.byref(handle))) - - _check(_lib_output.ENR_open(handle, ctypes.c_char_p(opt.encode()))) - - _check(_lib_output.ENR_close(ctypes.byref(handle))) - - return '' + return _read_output(name) if __name__ == '__main__': _verify_platform() - run_project('net3') + _read_output('net3') From 0b4d01d2ad076cbd87638b0a18aaafd7470fd3a2 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:08:47 +0800 Subject: [PATCH 06/12] Refine git ignore --- .gitignore | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 376844c..6d3c1d9 100644 --- a/.gitignore +++ b/.gitignore @@ -7,12 +7,13 @@ __pycache__/ # pytest .pytest_cache/ -# epanet -*.rpt -*.opt - -# dev_demo +# dev dev_demo.py # db inp *.db.inp + +# calculation +*.rpt +*.opt +*.out.json From 0d946af50bebf518fc5bb7793bffacb2714cc3b1 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:09:17 +0800 Subject: [PATCH 07/12] Fix typo --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 6d3c1d9..6015708 100644 --- a/.gitignore +++ b/.gitignore @@ -16,4 +16,4 @@ dev_demo.py # calculation *.rpt *.opt -*.out.json +*.opt.json From dbc8b041145875f150b88795087b4c706a9c4cbe Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:09:48 +0800 Subject: [PATCH 08/12] Support dump output to json --- epanet/epanet.py | 88 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 75 insertions(+), 13 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index 4a3b670..c6ec611 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -1,7 +1,9 @@ import ctypes import platform import os -import sys +import sys +import json +from typing import Any sys.path.append("..") from api import project from api import parser @@ -23,8 +25,8 @@ class Output: self._check(self._lib.ENR_init(ctypes.byref(self._handle))) dir = os.path.dirname(os.getcwd()) - opt = os.path.join(os.path.join(dir, 'temp'), self._name + '.db.opt') - self._check(self._lib.ENR_open(self._handle, ctypes.c_char_p(opt.encode()))) + self.opt = os.path.join(os.path.join(dir, 'temp'), self._name + '.db.opt') + self._check(self._lib.ENR_open(self._handle, ctypes.c_char_p(self.opt.encode()))) def _check(self, result): @@ -52,11 +54,11 @@ class Output: self._check(self._lib.ENR_getNetSize(self._handle, ctypes.byref(element_count), ctypes.byref(length))) assert length.value == 5 category = ['node', 'tank', 'link', 'pump', 'valve'] - counts = {} + sizes = {} for i in range(length.value): - counts[category[i]] = element_count[i] + sizes[category[i]] = element_count[i] self._lib.ENR_free(ctypes.byref(element_count)) - return counts + return sizes def units(self) -> dict[str, str]: @@ -71,6 +73,61 @@ class Output: return { 'flow': f_us[f_u.value], 'pressure': p_us[p_u.value], 'quality': q_us[q_u.value] } + def times(self) -> dict[str, int]: + ts = [] + for i in range(1, 5): + t = ctypes.c_int(1) + self._check(self._lib.ENR_getTimes(self._handle, ctypes.c_int(i), ctypes.byref(t))) + ts.append(t.value) + d = {} + category = ['report_start', 'report_step', 'sim_duration', 'num_periods'] + for i in range(4): + d[category[i]] = ts[i] + return d + + + def element_name(self) -> dict[str, list[str]]: + sizes = self.net_size() + + node_type = ctypes.c_int(1) + nodes = [] + for i in range(1, sizes['node'] + 1): + name = ctypes.c_char_p() + name_len = ctypes.c_int() + self._check(self._lib.ENR_getElementName(self._handle, node_type, ctypes.c_int(i), ctypes.byref(name), ctypes.byref(name_len))) + nodes.append(name.value.decode()) + self._lib.ENR_free(ctypes.byref(name)) + + link_type = ctypes.c_int(2) + links = [] + for i in range(1, sizes['link'] + 1): + name = ctypes.c_char_p() + name_len = ctypes.c_int() + self._check(self._lib.ENR_getElementName(self._handle, link_type, ctypes.c_int(i), ctypes.byref(name), ctypes.byref(name_len))) + links.append(name.value.decode()) + self._lib.ENR_free(ctypes.byref(name)) + + return { 'nodes' : nodes, 'links': links } + + + # { pump_index, link_index, utilization, avg.efficiency, avg.kW/flow, avg.kwatts, max.kwatts, cost/day } + def energy_usage(self) -> list[dict[str, Any]]: + size = self.net_size()['pump'] + usages = [] + category = ['utilization', 'avg.efficiency', 'avg.kW/flow', 'avg.kwatts', 'max.kwatts', 'cost/day' ] + for i in range(1, size + 1): + index = ctypes.c_int() + values = ctypes.POINTER(ctypes.c_float)() + length = ctypes.c_int() + self._check(self._lib.ENR_getEnergyUsage(self._handle, ctypes.c_int(i), ctypes.byref(index), ctypes.byref(values), ctypes.byref(length))) + assert length.value == 6 + d = { 'pump_index' : i - 1, 'link_index' : index.value - 1 } + for j in range(length.value): + d |= { category[j] : values[j] } + usages.append(d) + return usages + + def __del__(self): # throw exception in destructor ? :) self._check(self._lib.ENR_close(ctypes.byref(self._handle))) @@ -78,14 +135,19 @@ class Output: def _read_output(name: str) -> str: opt = Output(name) - print(opt.version()) - print(opt.net_size()) - print(opt.units()) - return '' + data = {} + data |= { 'version' : opt.version() } + data |= { 'net_size' : opt.net_size() } + data |= { 'units' : opt.units() } + data |= { 'times' : opt.times() } + data |= { 'element_name' : opt.element_name() } + data |= { 'energy_usage' : opt.energy_usage() } + with open(opt.opt + '.json', 'w') as f: + json.dump(data, f) + return json.dumps(data) -# readable True => json, False => binary output -def run_project(name: str, readable: bool = True) -> str: +def run_project(name: str) -> str: if not project.have_project(name): raise Exception(f'Not found project [{name}]') @@ -110,4 +172,4 @@ def run_project(name: str, readable: bool = True) -> str: if __name__ == '__main__': _verify_platform() - _read_output('net3') + print(_read_output('net3')) From 25b5de9e2dc6c0542c8b35429e915ad79d30c68b Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:16:52 +0800 Subject: [PATCH 09/12] Code refactor --- epanet/epanet.py | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index c6ec611..bcfa732 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -128,6 +128,20 @@ class Output: return usages + def dump(self, cache: bool = False) -> str: + data = {} + data |= { 'version' : self.version() } + data |= { 'net_size' : self.net_size() } + data |= { 'units' : self.units() } + data |= { 'times' : self.times() } + data |= { 'element_name' : self.element_name() } + data |= { 'energy_usage' : self.energy_usage() } + if cache: + with open(self.opt + '.json', 'w') as f: + json.dump(data, f) + return json.dumps(data) + + def __del__(self): # throw exception in destructor ? :) self._check(self._lib.ENR_close(ctypes.byref(self._handle))) @@ -135,16 +149,7 @@ class Output: def _read_output(name: str) -> str: opt = Output(name) - data = {} - data |= { 'version' : opt.version() } - data |= { 'net_size' : opt.net_size() } - data |= { 'units' : opt.units() } - data |= { 'times' : opt.times() } - data |= { 'element_name' : opt.element_name() } - data |= { 'energy_usage' : opt.energy_usage() } - with open(opt.opt + '.json', 'w') as f: - json.dump(data, f) - return json.dumps(data) + return opt.dump() def run_project(name: str) -> str: From 94e35851cdc31ce501c7cd65ef43c7f26a853ac8 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:30:45 +0800 Subject: [PATCH 10/12] Code refactor --- epanet/epanet.py | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index bcfa732..62af392 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -16,17 +16,15 @@ def _verify_platform(): class Output: - def __init__(self, name: str) -> None: - self._name = name + def __init__(self, path: str) -> None: + self._path = path self._lib = ctypes.CDLL(os.path.join(os.getcwd(), 'epanet-output.dll')) self._handle = ctypes.c_void_p() self._check(self._lib.ENR_init(ctypes.byref(self._handle))) - dir = os.path.dirname(os.getcwd()) - self.opt = os.path.join(os.path.join(dir, 'temp'), self._name + '.db.opt') - self._check(self._lib.ENR_open(self._handle, ctypes.c_char_p(self.opt.encode()))) + self._check(self._lib.ENR_open(self._handle, ctypes.c_char_p(self._path.encode()))) def _check(self, result): @@ -35,7 +33,7 @@ class Output: code = self._lib.ENR_checkError(self._handle, ctypes.byref(msg)) assert code == result - error = f'Failed to read project [{self._name}] output, message [{msg.value.decode()}]' + error = f'Failed to read project [{self._path}] output, message [{msg.value.decode()}]' self._lib.ENR_free(ctypes.byref(msg)) @@ -147,8 +145,8 @@ class Output: self._check(self._lib.ENR_close(ctypes.byref(self._handle))) -def _read_output(name: str) -> str: - opt = Output(name) +def dump_output(path: str) -> str: + opt = Output(path) return opt.dump() @@ -170,11 +168,16 @@ def run_project(name: str) -> str: result = os.system(command) if result != 0: - raise Exception("Failed to run simulation for project [{name}]") + msg = f'Failed to run simulation for project [{name}]' + raise Exception(msg) - return _read_output(name) + return dump_output(opt) + + +def run_inp(inp: str) -> str: + return '' if __name__ == '__main__': _verify_platform() - print(_read_output('net3')) + print(run_project('net3')) From e2a0f6f95cae1812a4845d1a5006cf41677c0176 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:32:19 +0800 Subject: [PATCH 11/12] Support more analyze apis --- epanet/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/epanet/__init__.py b/epanet/__init__.py index 437d5bd..7aedf70 100644 --- a/epanet/__init__.py +++ b/epanet/__init__.py @@ -1 +1 @@ -from .epanet import run_project \ No newline at end of file +from .epanet import run_project, run_inp, dump_output \ No newline at end of file From 80b88976a4f094649f2356a10f6344912152d307 Mon Sep 17 00:00:00 2001 From: "WQY\\qiong" Date: Sat, 19 Nov 2022 18:41:49 +0800 Subject: [PATCH 12/12] Add api for simulation and dump output --- epanet/epanet.py | 23 ++++++++++++++++++----- tjnetwork.py | 12 ++++++++++++ 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/epanet/epanet.py b/epanet/epanet.py index 62af392..76830d6 100644 --- a/epanet/epanet.py +++ b/epanet/epanet.py @@ -126,7 +126,7 @@ class Output: return usages - def dump(self, cache: bool = False) -> str: + def dump(self, cache: bool = True) -> str: data = {} data |= { 'version' : self.version() } data |= { 'net_size' : self.net_size() } @@ -135,7 +135,7 @@ class Output: data |= { 'element_name' : self.element_name() } data |= { 'energy_usage' : self.energy_usage() } if cache: - with open(self.opt + '.json', 'w') as f: + with open(self._path + '.json', 'w') as f: json.dump(data, f) return json.dumps(data) @@ -174,10 +174,23 @@ def run_project(name: str) -> str: return dump_output(opt) -def run_inp(inp: str) -> str: - return '' +def run_inp(name: str) -> str: + dir = os.path.dirname(os.getcwd()) + + exe = os.path.join(os.path.join(dir, 'epanet'), 'runepanet.exe') + inp = os.path.join(os.path.join(dir, 'inp'), name + '.inp') + rpt = os.path.join(os.path.join(dir, 'temp'), name + '.rpt') + opt = os.path.join(os.path.join(dir, 'temp'), name + '.opt') + command = f'{exe} {inp} {rpt} {opt}' + + result = os.system(command) + if result != 0: + msg = f'Failed to run simulation for project [{name}]' + raise Exception(msg) + + return dump_output(opt) if __name__ == '__main__': _verify_platform() - print(run_project('net3')) + print(run_inp('net3')) diff --git a/tjnetwork.py b/tjnetwork.py index 4c09e8c..91c4dc9 100644 --- a/tjnetwork.py +++ b/tjnetwork.py @@ -1,5 +1,6 @@ from typing import Any import api +import epanet ############################################################ @@ -129,6 +130,17 @@ def read_inp(name: str, inp: str) -> None: def dump_inp(name: str, inp: str) -> None: return api.dump_inp(name, inp) +def run_project(name: str) -> str: + return epanet.run_project(name) + +# put in inp folder, name without extension +def run_inp(name: str) -> str: + return epanet.run_inp(name) + +# path is absolute path +def dump_output(path: str) -> str: + return epanet.dump_output(path) + ############################################################ # operation