epanet-plus 0.0.1__cp310-cp310-win_amd64.whl → 0.1.0__cp310-cp310-win_amd64.whl

epanet_plus/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

epanet_plus/epanet_wrapper.py

@@ -237,6 +237,21 @@ class EpanetAPI():
         else:
             return self._process_result(epanet.EN_open(self._ph, inpFile, rptFile, outFile))
 
+    def openX(self, inpFile: str, rptFile: str, outFile: str):
+        """
+        EN_openX
+
+        Parameters
+        ----------
+        inpFile : `str`
+        rptFile : `str`
+        outFile : `str`
+        """
+        if self._use_project is False:
+            return self._process_result(epanet.ENopenX(inpFile, rptFile, outFile))
+        else:
+            return self._process_result(epanet.EN_openX(self._ph, inpFile, rptFile, outFile))
+
     def gettitle(self):
         """
         EN_gettitle

{epanet_plus-0.0.1.dist-info → epanet_plus-0.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epanet-plus
-Version: 0.0.1
+Version: 0.1.0
 Summary: Python interface for EPANET-PLUS (incl. EPANET and EPANET-MSX)
 Author-email: André Artelt <aartelt@techfak.uni-bielefeld.de>
 License-Expression: MIT
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -25,7 +26,7 @@ Dynamic: license-file
 [![pypi](https://img.shields.io/pypi/v/epanet-plus.svg)](https://pypi.org/project/epanet-plus/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/epanet-plus)
-[![build](https://github.com/WaterFutures/EPANET-PLUS/actions/workflows/build.yml/badge.svg)](https://github.com/WaterFutures/EPANET-PLUS/actions/workflows/build.yml)
+[![Build + Test](https://github.com/WaterFutures/EPANET-PLUS/actions/workflows/build_test.yml/badge.svg)](https://github.com/WaterFutures/EPANET-PLUS/actions/workflows/build_test.yml)
 [![Documentation Status](https://readthedocs.org/projects/epanet-plus/badge/?version=stable)](https://epanet-plus.readthedocs.io/en/stable/?badge=stable)
 [![Downloads](https://static.pepy.tech/badge/epanet-plus)](https://pepy.tech/project/epanet-plus)
 [![Downloads](https://static.pepy.tech/badge/epanet-plus/month)](https://pepy.tech/project/epanet-plus)
@@ -48,7 +49,7 @@ Unique features of EPANET-PLUS that make it superior to other Python interfaces
 
 ## Installation
 
-Note that EPANET-PLUS supports Python 3.9 - 3.13. 
+Note that EPANET-PLUS supports Python 3.9 - 3.14. 
 The Python package contains the the C library as a C extension and is
 already pre-build for all major platforms.
 

{epanet_plus-0.0.1.dist-info → epanet_plus-0.1.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-epanet.cp310-win_amd64.pyd,sha256=KukBZk4nE2LlrjhVdfOfUdYnu3r-NBBi6WIjSC7MWus,494080
+epanet.cp310-win_amd64.pyd,sha256=8YD3meZS_Fu1Tt18U-Wzb0zphDhOcJFVM7dI3CcJ82E,494080
 docs/conf.py,sha256=tsJLrKG1OZnnK8B0mzDX3fbG4CYe_rIRZvTH3JkvN7Y,2199
 epanet-msx-src/dispersion.h,sha256=rarrxJdtslA_yuZXei5xFN9j7nqWn5L9F4aLMPsCIh4,967
 epanet-msx-src/hash.c,sha256=IVzS2dWv8-GVJsQrWOP3ypcOizyfA16CnLpVhQ56ePQ,2955
@@ -78,19 +78,20 @@ epanet-src/util/errormanager.c,sha256=ooXxWIppEVavff6TKKto8Q6NCgNvwyh9foT1j9ingf
 epanet-src/util/errormanager.h,sha256=U31MIi-DL7xa-IhXJoAGBFRsoUl7YDtzj8OQDHpJDCs,1021
 epanet-src/util/filemanager.c,sha256=fs8H97AN8ZFyJV2sbJYiBW2i3e--MELZfMOU52oZqUs,4878
 epanet-src/util/filemanager.h,sha256=Ktdb0aGoxgiAmYuqrc4Mc3vQGQ3CYDfMBzc0U-3qGjY,1925
-epanet_plus/VERSION,sha256=axN4nkPlSFY0Uz3hamXYup00xMl1hYi2ZYBUNfgOsRU,5
+epanet_plus/VERSION,sha256=atlhOkVXmNbZLl9fOQq0uqcFlryGntaxf1zdKyhjXwY,5
 epanet_plus/__init__.py,sha256=6LIHTbuelmJeIKzQomyObM4lrlZJEKhDgrEFGd-gCj4,223
 epanet_plus/epanet_plus.c,sha256=KnuP2GwTK56vmNN_742si856WDEa-PyuCifryzSCQB4,3301
 epanet_plus/epanet_toolkit.py,sha256=71lhwvBubd8USwDTHjHVbAy4gKkHhpLikpL05sFaJ_w,83667
-epanet_plus/epanet_wrapper.py,sha256=U7Xa9KKbazodWV768S0g0_7zQ5CF44qEfD7wrC0FHrw,75540
+epanet_plus/epanet_wrapper.py,sha256=k7S_6JmFLLOkb1BlRhc-ajPjFktQPVCz6l1SXXKPhIs,76001
 epanet_plus/include/epanet_plus.h,sha256=lSCjHsQRSl2fS2lLcC_lj_6N4g9KanUBBuWqmPvrThs,348
-epanet_plus-0.0.1.dist-info/licenses/LICENSE,sha256=SkZQpJ9ap2kNSGgeKesdFgWc73oFIgLP1UmSStMM8ms,1095
+epanet_plus-0.1.0.dist-info/licenses/LICENSE,sha256=SkZQpJ9ap2kNSGgeKesdFgWc73oFIgLP1UmSStMM8ms,1095
 examples/basic_usage.py,sha256=yHAg16dAjGa-ktyVjT5MeL8Rh5dYpWsUrh81N2zywtw,1122
+examples/epanet_msx.py,sha256=D5wXc5oe3uEJi6bh3lYIfxDQZf60LWcpN741p90bXWc,1255
 python-extension/ext.c,sha256=HRAB553RjcNlgoBYnuNbt5IYFZymmUGZ65PSqYfe-dw,38527
-python-extension/pyepanet.c,sha256=iLpv-rBz5i_KuUG4Hwc9qRk7mfGVD8001kZ5KeHqFA8,57772
-python-extension/pyepanet.h,sha256=l9PdEJrMeyfrxfBQqLOiPn6AZ4etHaC7JWW-HATszlE,9236
-python-extension/pyepanet2.c,sha256=M2DZazB_tM0SmlkqqSnYHHaNJhoBOToC8qXqz-o0K84,46389
-python-extension/pyepanet2.h,sha256=-JdfrKuEsanNnQQQrP_s46W0_OvBXPOgoy4I43sjyqA,9204
+python-extension/pyepanet.c,sha256=CuuNcWv7YIy7X-LsaVYdByEQ31DLcK4OFvzlIAOQKlo,58200
+python-extension/pyepanet.h,sha256=3G46vHe9ZUldRlAVGML921jIa_nSzorgULfCrjpEjGY,9296
+python-extension/pyepanet2.c,sha256=a5iifpTxNjesJE2h4DXCegLncJ7jpDGd3TOGhrH_rw4,46709
+python-extension/pyepanet2.h,sha256=HkVvXUfgY7RmizZoU8QatE9N1qJfVmmETE4e1vlGpa4,9263
 python-extension/pyepanet_plus.c,sha256=yq0MGLq6EyTDYTSM9jM-h1rrYWvqo1tQjg1sAwfqtco,975
 python-extension/pyepanet_plus.h,sha256=CN4Dyfdi4B-EkYuzsoPbxOq7hT2DSHbnxMSD-2085p0,160
 python-extension/pyepanetmsx.c,sha256=NQOCcP8roqBPwFZUIKZbnGf0dVfin_LzsS6Nzu2Oreg,9670
@@ -99,7 +100,7 @@ tests/test_epanet.py,sha256=0umog3hTNUFyN2vrlS6U423w422WfZvLAq3N1CinPWU,479
 tests/test_epanetmsx.py,sha256=2zp2pb_5slxlfv2O1ti7igdpb10hQ9q4q0Y0jenzFlk,1032
 tests/test_epyt.py,sha256=kUuF8p4nUNr-2MGVzSGp3eHamF--UsnhNPNsvgRjxsM,3647
 tests/test_load_inp_from_buffer.py,sha256=7MLhiEk8qGKmUR4mJid8VEO5ZF8djfzmtL_hVAVezzA,561
-epanet_plus-0.0.1.dist-info/METADATA,sha256=StwQ9sWl6yr44C-28khd6PcHJ290s73pMxkgUj4Nq0g,5359
-epanet_plus-0.0.1.dist-info/WHEEL,sha256=KUuBC6lxAbHCKilKua8R9W_TM71_-9Sg5uEP3uDWcoU,101
-epanet_plus-0.0.1.dist-info/top_level.txt,sha256=igwRsFnggi2fSCG7AHkP3LfOLlgsT2aUu0oa8DpvHDo,103
-epanet_plus-0.0.1.dist-info/RECORD,,
+epanet_plus-0.1.0.dist-info/METADATA,sha256=XeQADkHrmi-qW0blAInOnaWAMZiLduWNusqKSqQK5Vw,5428
+epanet_plus-0.1.0.dist-info/WHEEL,sha256=KUuBC6lxAbHCKilKua8R9W_TM71_-9Sg5uEP3uDWcoU,101
+epanet_plus-0.1.0.dist-info/top_level.txt,sha256=igwRsFnggi2fSCG7AHkP3LfOLlgsT2aUu0oa8DpvHDo,103
+epanet_plus-0.1.0.dist-info/RECORD,,

examples/epanet_msx.py

@@ -0,0 +1,35 @@
+"""
+Basic example demonstrating how to run an EPANET-MSX simulation.
+"""
+from epanet_plus import EPyT, EpanetConstants
+
+
+if __name__ == "__main__":
+    # Load an .inp and .msx file -- recall that for using EPANET-MSX,
+    # we have to fall back to EPANET < 2.2 (i.e., use_project=False)
+    epanet_api = EPyT("net2-cl2.inp", use_project=False)
+    epanet_api.load_msx_file("net2-cl2.msx")
+
+    print(f"Simulation duration: {epanet_api.gettimeparam(EpanetConstants.EN_DURATION)}")
+
+    # Solve hydraulics by calling MSXsolveH -- alternatively, the hydraulics can be solved
+    # in EPANET once and exported as a .hyd file, which can then be loaded into EPANET-MSX
+    epanet_api.MSXsolveH()
+
+    #epanet_api.solveH()    # Only do this once -- you can then just load the .hyd file
+    #epanet_api.savehydfile("mySimNet2.hyd")
+    #epanet_api.MSXusehydfile("mySimNet2.hyd")
+
+    # Run EPANET-MSX simulation
+    epanet_api.MSXinit(0)
+    print(f"Species ID: {epanet_api.MSXgetindex(EpanetConstants.MSX_SPECIES, 'CL2')}")
+
+    while True:
+        t, tleft = epanet_api.MSXstep()
+
+        print(f"{epanet_api.MSXgetqual(EpanetConstants.MSX_NODE, 2, 1)} mg/L")
+
+        if tleft == 0:
+            break
+
+    epanet_api.close()

python-extension/pyepanet.c

@@ -61,6 +61,23 @@ PyObject* method_EN_open(PyObject* self, PyObject* args)
     return PyTuple_Pack(1, PyLong_FromLong(err));
 }
 
+PyObject* method_EN_openX(PyObject* self, PyObject* args)
+{
+    uintptr_t ptr;
+    char* inpFile = NULL;
+    char* rptFile = NULL;
+    char* outFile = NULL;
+
+    if(!PyArg_ParseTuple(args, "Ksss", &ptr, &inpFile, &rptFile, &outFile)) {
+        return NULL;
+    }
+    EN_Project ph = (EN_Project) ptr;
+
+    int err = EN_openX(ph, inpFile, rptFile, outFile);
+
+    return PyTuple_Pack(1, PyLong_FromLong(err));
+}
+
 PyObject* method_EN_gettitle(PyObject* self, PyObject* args)
 {
     uintptr_t ptr;

python-extension/pyepanet.h

@@ -5,6 +5,7 @@ PyObject* method_EN_createproject(PyObject* self, PyObject* Py_UNUSED(args));
 PyObject* method_EN_deleteproject(PyObject* self, PyObject* args);
 PyObject* method_EN_init(PyObject* self, PyObject* args);
 PyObject* method_EN_open(PyObject* self, PyObject* args);
+PyObject* method_EN_openX(PyObject* self, PyObject* args);
 PyObject* method_EN_gettitle(PyObject* self, PyObject* args);
 PyObject* method_EN_settitle(PyObject* self, PyObject* args);
 PyObject* method_EN_getcomment(PyObject* self, PyObject* args);

python-extension/pyepanet2.c

@@ -16,6 +16,18 @@ PyObject* method_ENopen(PyObject* self, PyObject* args)
     return PyTuple_Pack(1, PyLong_FromLong(err));
 }
 
+PyObject* method_ENopenX(PyObject* self, PyObject* args)
+{
+    char *inpFile, *rptFile, *outFile = NULL;
+
+    if(!PyArg_ParseTuple(args, "sss", &inpFile, &rptFile, &outFile)) {
+        return NULL;
+    }
+
+    int err = ENopenX(inpFile, rptFile, outFile);
+
+    return PyTuple_Pack(1, PyLong_FromLong(err));
+}
 
 PyObject* method_ENclose(PyObject* self, PyObject* Py_UNUSED(args))
 {

python-extension/pyepanet2.h

@@ -2,6 +2,7 @@
 
 
 PyObject* method_ENopen(PyObject* self, PyObject* args);
+PyObject* method_ENopenX(PyObject* self, PyObject* args);
 PyObject* method_ENclose(PyObject* self, PyObject* Py_UNUSED(args));
 PyObject* method_ENaddcontrol(PyObject* self, PyObject* args);
 PyObject* method_ENaddcurve(PyObject* self, PyObject* args);