epanet-plus 0.0.1__cp39-cp39-macosx_10_9_x86_64.whl → 0.1.0__cp39-cp39-macosx_10_9_x86_64.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,13 +1,13 @@
-epanet.cpython-39-darwin.so,sha256=3C0Vi2546NQ5-dNMqTqoJ785QSz_2UKEPmAQ4ak7ANE,703352
+epanet.cpython-39-darwin.so,sha256=AucbSQTcHvUdVn25SFoe94ibRcRae0ZnCHgFbBh6QZw,703568
 python-extension/pyepanetmsx.h,sha256=BXI0jBTl2RzAaogfIeALgv7n1-pizSVtYqUtupEVTkQ,2088
 python-extension/ext.c,sha256=sjDx2HWTY9Ov35rxDH0E6szI249YDCK5DT2EKLFSfVg,38183
-python-extension/pyepanet.h,sha256=jh7NJrkogyV78BwpVEFpXqxBQiNGLE1f1FaUlOTz-vs,9094
+python-extension/pyepanet.h,sha256=RUQ79GAv58Wo_FqFXcUgz4MpPA_t6tWze0P4wjFniJE,9153
 python-extension/pyepanet_plus.c,sha256=A_6eN31QeNBw3nfACpblDsvndzvKB1N9Bq4qT6f6UUs,938
-python-extension/pyepanet2.h,sha256=fmyrc6py14iiwvd-co_V4bQ_v46gp0hcNDhyKd7PhrQ,9064
+python-extension/pyepanet2.h,sha256=tmaekND6Zb00Tl99TAa5M53nQnsoPZ-L0LfM1JKgBsA,9122
 python-extension/pyepanetmsx.c,sha256=3uZcfLpyVFhOxzyqk-1iuLV8XRAcprOsKUCkj57JmL4,9282
-python-extension/pyepanet.c,sha256=YkhB-Ey_GsaCINczvEIIbZ1oS4DeZItlJUUe6qqa1bs,55640
+python-extension/pyepanet.c,sha256=uc3gVN7uoMLLC3shTRnfAz5RMsK4D9Bt88kAnR0Hmrc,56051
 python-extension/pyepanet_plus.h,sha256=2Pz6cVxJas_nlcYVeYU3xnqXMTcsCJ18P-vnnZa_YAs,156
-python-extension/pyepanet2.c,sha256=h9HJE7B3X7wyXlFagOzN9hRLVqvwcJNc2WN-T3Y4emI,44567
+python-extension/pyepanet2.c,sha256=KfoGO2AJQ4ttoKNpPYo3Z57HmJaR5vVsnlcF7bSi9TY,44875
 epanet-msx-src/mathexpr.h,sha256=1nbte9BLbqk8l9Ai2HhY1rqSmEUw0Ex03goUWBaN3QQ,1342
 epanet-msx-src/msxtoolkit.c,sha256=0KgIpPP28-sOCCExBaq1Hh8ib2J-W65kNf0-fR5D5OE,33863
 epanet-msx-src/msxqual.c,sha256=6Aj6Lu9ehnmjp-9AL3kN34aG4NaD8a9I6MQX93IjEpE,57805
@@ -43,17 +43,12 @@ epanet-msx-src/msxfuncs.c,sha256=uXdp0LUQapVIgE9Yj0V9qG99SSrvqzIt7olysuRKbJQ,436
 epanet-msx-src/msxfile.c,sha256=rVG-dKgvfrhaNP-Sy1_4EmTWi8GCwlAqYa0Vbnnk8aY,7068
 epanet-msx-src/include/epanetmsx.h,sha256=P4baHSK7NQzuwYhrWLE0VmieTlXW2XOQF52UgyhZDuk,3456
 epanet-msx-src/include/epanetmsx_export.h,sha256=h5UMaf6pH_0asRJOmhWUGAZhyA180ui2Cz8_y5h1FKw,1054
-epanet_plus/epanet_wrapper.py,sha256=YQggdIm7IBPd7sPzBSqgWCnFTNL6XCnnRu63LQJ4_-s,73126
+epanet_plus/epanet_wrapper.py,sha256=e0DkZhO3wwi8Sp2d7ft1tE2OLNkn0twGGHaq_ltz-eY,73572
 epanet_plus/epanet_toolkit.py,sha256=VNAV_oqIWvuvuK7EvfV8DAc-3v94GIAeJvx1oUIVgEM,80937
 epanet_plus/__init__.py,sha256=XorLU8AO-crTDUwlM-EVyrOYynh3FrGkhQuSsWwI9Ls,215
-epanet_plus/VERSION,sha256=axN4nkPlSFY0Uz3hamXYup00xMl1hYi2ZYBUNfgOsRU,5
+epanet_plus/VERSION,sha256=atlhOkVXmNbZLl9fOQq0uqcFlryGntaxf1zdKyhjXwY,5
 epanet_plus/epanet_plus.c,sha256=zWfYlLgYdQCQtIkVHNpgEBOBqJefeJX7H3cHZThkxnw,3183
 epanet_plus/include/epanet_plus.h,sha256=z2PEExuz6szxUp1k5vwsMQy2uSRz_X-W9B7xSP2f33s,340
-epanet_plus-0.0.1.dist-info/RECORD,,
-epanet_plus-0.0.1.dist-info/WHEEL,sha256=Prymy4iewnr2C3GLPmIomJyLIRtmCgaf6MSAdd7b500,135
-epanet_plus-0.0.1.dist-info/top_level.txt,sha256=IkN0NUJqQt4PPucWMqE1vZB7g2hodjY1A1iBTqsMtgs,97
-epanet_plus-0.0.1.dist-info/METADATA,sha256=NCBbW5G9wreRT6-ftlK69Tt_O89E7RyBfSH8_PXEZl4,5207
-epanet_plus-0.0.1.dist-info/licenses/LICENSE,sha256=q5jqVgUtLMJstE7DSa26FnVk3N2yAuQPCW6wCtQm6Eo,1074
 tests/test_epanetmsx.py,sha256=mAKTEscKVcZG_RKZg7fco7G6CQmLNK0XKnPJpT0EeFs,996
 tests/test_epyt.py,sha256=ZTIi5f4gfTPFCjIvpnGopcf5s8tAEDsAcha7QJUIxtc,3533
 tests/test_load_inp_from_buffer.py,sha256=-EqeKqI_-FNcARpe1SPrBs7lSNtMvfw6oUKyDPhIabo,543
@@ -103,3 +98,9 @@ epanet-src/include/epanet2_enums.h,sha256=vP4c3AhIB6Md2HLS8YaKVXADUqXiuJSu1NmNDl
 epanet-src/include/epanet2_2.h,sha256=JAs1spcJixip6zdSd0G-cWG19PGKBR6CKQM5UDGJiJg,77508
 epanet-src/include/epanet2.h,sha256=qggFwluyLeh0ZudO3aCowpq3Bq5da9exd5qhoXDCcEw,15274
 examples/basic_usage.py,sha256=c2PlqGFLPxpoe2f37neEN4T479deTqummNfojumzLUo,1087
+examples/epanet_msx.py,sha256=_aPu9DaXH4H1tC6MEg8s2_8__W7QEhDGRGdprXaYbDY,1220
+epanet_plus-0.1.0.dist-info/RECORD,,
+epanet_plus-0.1.0.dist-info/WHEEL,sha256=Prymy4iewnr2C3GLPmIomJyLIRtmCgaf6MSAdd7b500,135
+epanet_plus-0.1.0.dist-info/top_level.txt,sha256=IkN0NUJqQt4PPucWMqE1vZB7g2hodjY1A1iBTqsMtgs,97
+epanet_plus-0.1.0.dist-info/METADATA,sha256=N_Go9IvqsySan_q-JBbGvUXX44ACz-3_Fl0-ssm0Evk,5275
+epanet_plus-0.1.0.dist-info/licenses/LICENSE,sha256=q5jqVgUtLMJstE7DSa26FnVk3N2yAuQPCW6wCtQm6Eo,1074

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);