epanet-plus 0.2.1__cp311-cp311-macosx_11_0_arm64.whl

python-extension/pyepanetmsx.h

@@ -0,0 +1,35 @@
+#include <Python.h>
+
+
+PyObject* method_MSXENopen(PyObject* self, PyObject* args);
+PyObject* method_MSXopen(PyObject* self, PyObject* args);
+PyObject* method_MSXsolveH(PyObject* self, PyObject* Py_UNUSED(args));
+PyObject* method_MSXusehydfile(PyObject* self, PyObject* args);
+PyObject* method_MSXsolveQ(PyObject* self, PyObject* Py_UNUSED(args));
+PyObject* method_MSXinit(PyObject* self, PyObject* args);
+PyObject* method_MSXstep(PyObject* self, PyObject* args);
+PyObject* method_MSXsaveoutfile(PyObject* self, PyObject* args);
+PyObject* method_MSXsavemsxfile(PyObject* self, PyObject* args);
+PyObject* method_MSXreport(PyObject* self, PyObject* Py_UNUSED(args));
+PyObject* method_MSXclose(PyObject* self, PyObject* Py_UNUSED(args));
+PyObject* method_MSXENclose(PyObject* self, PyObject* Py_UNUSED(args));
+PyObject* method_MSXgetindex(PyObject* self, PyObject* args);
+PyObject* method_MSXgetIDlen(PyObject* self, PyObject* args);
+PyObject* method_MSXgetID(PyObject* self, PyObject* args);
+PyObject* method_MSXgetcount(PyObject* self, PyObject* args);
+PyObject* method_MSXgetspecies(PyObject* self, PyObject* args);
+PyObject* method_MSXgetconstant(PyObject* self, PyObject* args);
+PyObject* method_MSXgetparameter(PyObject* self, PyObject* args);
+PyObject* method_MSXgetsource(PyObject* self, PyObject* args);
+PyObject* method_MSXgetpatternlen(PyObject* self, PyObject* args);
+PyObject* method_MSXgetpatternvalue(PyObject* self, PyObject* args);
+PyObject* method_MSXgetinitqual(PyObject* self, PyObject* args);
+PyObject* method_MSXgetqual(PyObject* self, PyObject* args);
+PyObject* method_MSXgeterror(PyObject* self, PyObject* args);
+PyObject* method_MSXsetconstant(PyObject* self, PyObject* args);
+PyObject* method_MSXsetparameter(PyObject* self, PyObject* args);
+PyObject* method_MSXsetinitqual(PyObject* self, PyObject* args);
+PyObject* method_MSXsetsource(PyObject* self, PyObject* args);
+PyObject* method_MSXsetpatternvalue(PyObject* self, PyObject* args);
+PyObject* method_MSXsetpattern(PyObject* self, PyObject* args);
+PyObject* method_MSXaddpattern(PyObject* self, PyObject* args);

tests/test_epanet.py

@@ -0,0 +1,18 @@
+"""
+This module tests the EPANET functions.
+"""
+import os
+from epanet_plus import EpanetAPI, EpanetConstants
+
+
+def test():
+    epanet_api = EpanetAPI()
+    epanet_api.open(os.path.join("tests", "net2-cl2.inp"),
+                    os.path.join("tests", "net2-cl2.rpt"), "")
+
+    assert epanet_api.gettitle() is not None
+    assert epanet_api.getcount(EpanetConstants.EN_NODECOUNT) > 0
+    assert epanet_api.getcount(EpanetConstants.EN_LINKCOUNT) > 0
+    assert epanet_api.getcount(EpanetConstants.EN_TANKCOUNT) > 0
+
+    epanet_api.close()

tests/test_epanetmsx.py

@@ -0,0 +1,38 @@
+"""
+This module tests EPANET-MSX functions.
+"""
+import os
+from epanet_plus import EPyT, EpanetAPI, EpanetConstants
+
+
+def test_msx_basic():
+    epanet_api = EpanetAPI()
+    epanet_api.MSXENopen(os.path.join("tests", "net2-cl2.inp"),
+                         os.path.join("tests", "net2-cl2.rpt"), "")
+    epanet_api.MSXopen(os.path.join("tests", "net2-cl2.msx"))
+
+    epanet_api.gettitle()
+    epanet_api.MSXgetspecies(1)
+    epanet_api.MSXgetID(3, 1)
+
+    epanet_api.MSXclose()
+    epanet_api.MSXENclose()
+
+
+def test_simulation():
+    with EPyT(os.path.join("tests", "net2-cl2.inp"), use_project=False) as epanet_api:
+        epanet_api.load_msx_file(os.path.join("tests", "net2-cl2.msx"))
+
+        epanet_api.MSXsolveH()
+
+        epanet_api.MSXinit(0)
+        while True:
+            _, tleft = epanet_api.MSXstep()
+
+            for idx in epanet_api.get_all_nodes_idx():
+                assert epanet_api.MSXgetqual(EpanetConstants.MSX_NODE, idx, 1) >= 0
+            for idx in epanet_api.get_all_pipes_idx():
+                assert epanet_api.MSXgetqual(EpanetConstants.MSX_LINK, idx, 1) >= 0
+
+            if tleft == 0:
+                break

tests/test_epyt.py

@@ -0,0 +1,115 @@
+"""
+This module tests the toolkit functions implemented in the clas EPyT.
+"""
+import os
+from epanet_plus import EPyT, EpanetConstants
+
+
+def test_topology():
+    def __test_code(epanet_api: EPyT):
+        assert len(epanet_api.get_all_nodes_id()) > 0
+        assert len(epanet_api.get_all_links_id()) > 0
+
+        assert len(epanet_api.get_all_nodes_idx()) > 0
+        assert len(epanet_api.get_all_links_idx()) > 0
+
+        epanet_api.get_all_junctions_id()
+        epanet_api.get_all_junctions_idx()
+
+        assert len(epanet_api.get_all_pipes_id()) > 0
+        assert len(epanet_api.get_all_pipes_idx()) > 0
+
+        assert len(epanet_api.get_all_tanks_id()) > 0
+        assert len(epanet_api.get_all_tanks_idx()) > 0
+
+        epanet_api.get_all_reservoirs_id()
+        epanet_api.get_all_reservoirs_idx()
+        epanet_api.get_all_pumps_id()
+        epanet_api.get_all_pumps_idx()
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp")) as epanet_api:
+        __test_code(epanet_api)
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp"), use_project=True) as epanet_api:
+        __test_code(epanet_api)
+
+
+def test_parameters():
+    def __test_code(epanet_api: EPyT):
+        assert epanet_api.get_simulation_duration() > 0
+        assert epanet_api.get_hydraulic_time_step() > 0
+        assert epanet_api.get_reporting_start_time() >= 0
+        assert epanet_api.get_reporting_time_step() > 0
+        assert epanet_api.get_quality_time_step() > 0
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp")) as epanet_api:
+        __test_code(epanet_api)
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp"), use_project=True) as epanet_api:
+        __test_code(epanet_api)
+
+
+def test_hyd_simulation():
+    def __test_code(epanet_api: EPyT):
+        epanet_api.openH()
+        epanet_api.initH(EpanetConstants.EN_NOSAVE)
+
+        tstep = 1
+        while tstep > 0:
+            epanet_api.runH()
+
+            assert len(epanet_api.getnodevalues(EpanetConstants.EN_PRESSURE)) > 0
+            assert len(epanet_api.getlinkvalues(EpanetConstants.EN_FLOW)) > 0
+
+            tstep = epanet_api.nextH()
+
+        epanet_api.closeH()
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp")) as epanet_api:
+        __test_code(epanet_api)
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp"), use_project=True) as epanet_api:
+        __test_code(epanet_api)
+
+
+def test_quality_simulation():
+    def __test_code(epanet_api: EPyT):
+        epanet_api.openH()
+        epanet_api.initH(EpanetConstants.EN_NOSAVE)
+
+        epanet_api.openQ()
+        epanet_api.initQ(EpanetConstants.EN_NOSAVE)
+
+        tstep = 1
+        while tstep > 0:
+            epanet_api.runH()
+            epanet_api.runQ()
+
+            assert len(epanet_api.getnodevalues(EpanetConstants.EN_PRESSURE)) > 0
+            assert len(epanet_api.getlinkvalues(EpanetConstants.EN_FLOW)) > 0
+            assert len(epanet_api.getnodevalues(EpanetConstants.EN_QUALITY)) > 0
+            assert len(epanet_api.getlinkvalues(EpanetConstants.EN_QUALITY)) > 0            
+
+            tstep = epanet_api.nextH()
+            epanet_api.nextQ()
+
+        epanet_api.closeQ()
+        epanet_api.closeH()
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp")) as epanet_api:
+        __test_code(epanet_api)
+
+    with EPyT(os.path.join("tests", "net2-cl2.inp"), use_project=True) as epanet_api:
+        __test_code(epanet_api)
+
+
+def test_msx():
+    with EPyT(os.path.join("tests", "net2-cl2.inp"), use_project=False) as epanet_api:
+        epanet_api.load_msx_file(os.path.join("tests", "net2-cl2.msx"))
+
+        assert epanet_api.get_msx_time_step() > 0
+        epanet_api.set_msx_time_step(150)
+        assert epanet_api.get_msx_time_step() == 150
+
+        epanet_api.get_all_msx_species_id()
+        epanet_api.get_all_msx_species_info()

tests/test_load_inp_from_buffer.py

@@ -0,0 +1,59 @@
+"""
+This module tests the EPANET-PLUS function for loading an .inp file from a buffer.
+"""
+import os
+import tempfile
+import epanet
+from epanet_plus import EpanetConstants, EPyT
+
+
+def test_load_from_buffer():
+    inp_buffer = ""
+    with open(os.path.join("tests", "net2-cl2.inp"), "rt") as f_in:
+        inp_buffer = "".join(f_in.readlines())
+
+    assert epanet.ENopenfrombuffer(inp_buffer, os.path.join("tests", "net2-cl2.inp"),
+                                   os.path.join("tests", "net2-cl2.rpt"), "") == (0,)
+
+    assert epanet.ENgettitle() == (0, "EPANET Example Network 2", "", "")
+    assert epanet.ENgetcount(EpanetConstants.EN_NODECOUNT)[1] > 0
+
+    epanet.ENclose()
+
+
+def test_epyt_load_from_buffer():
+    def __test_code(epanet_api: EPyT):
+        epanet_api.openH()
+        epanet_api.initH(EpanetConstants.EN_NOSAVE)
+
+        epanet_api.openQ()
+        epanet_api.initQ(EpanetConstants.EN_NOSAVE)
+
+        tstep = 1
+        while tstep > 0:
+            epanet_api.runH()
+            epanet_api.runQ()
+
+            assert len(epanet_api.getnodevalues(EpanetConstants.EN_PRESSURE)) > 0
+            assert len(epanet_api.getlinkvalues(EpanetConstants.EN_FLOW)) > 0
+            assert len(epanet_api.getnodevalues(EpanetConstants.EN_QUALITY)) > 0
+            assert len(epanet_api.getlinkvalues(EpanetConstants.EN_QUALITY)) > 0            
+
+            tstep = epanet_api.nextH()
+            epanet_api.nextQ()
+
+        epanet_api.closeQ()
+        epanet_api.closeH()
+
+    # Load .inp file into buffer
+    inp_buffer = ""
+    with open(os.path.join("tests", "net2-cl2.inp"), "rt") as f_in:
+        inp_buffer = "".join(f_in.readlines())
+
+    # Load .inp buffer into EPANET via EPyT
+    with EPyT(os.path.join(tempfile.gettempdir(), "net2-cl2.inp"), inp_buffer=inp_buffer) as epanet_api:
+        __test_code(epanet_api)
+
+    with EPyT(os.path.join(tempfile.gettempdir(), "net2-cl2.inp"), use_project=True,
+              inp_buffer=inp_buffer) as epanet_api:
+        __test_code(epanet_api)