epanet-plus 0.1.2__cp312-cp312-macosx_10_13_x86_64.whl

epanet_plus/include/epanet_plus.h

@@ -0,0 +1,9 @@
+#ifndef EPANETPLUS_H
+#define EPANETPLUS_H
+
+#include "epanet2_2.h"
+
+int DLLEXPORT ENopenfrombuffer(const char *inpBuffer, const char *inpFile, const char *rptFile, const char *outFile);
+int DLLEXPORT EN_openfrombuffer(EN_Project p, const char *inpBuffer, const char *inpFile, const char *rptFile, const char *outFile);
+
+#endif //EPANETPLUS_H

epanet_plus-0.1.2.dist-info/METADATA

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: epanet-plus
+Version: 0.1.2
+Summary: Python interface for EPANET-PLUS (incl. EPANET and EPANET-MSX)
+Author-email: André Artelt <aartelt@techfak.uni-bielefeld.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/WaterFutures/EPANET-PLUS
+Project-URL: Documentation, https://epanet-plus.readthedocs.io/en/stable/
+Project-URL: Repository, https://github.com/WaterFutures/EPANET-PLUS.git
+Project-URL: Issues, https://github.com/WaterFutures/EPANET-PLUS/issues
+Keywords: epanet,water,networks,hydraulics,quality,simulations
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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
+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 + 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)
+
+# EPANET-PLUS
+
+EPANET-PLUS is a C library that merges [EPANET](https://github.com/OpenWaterAnalytics/EPANET) 
+and [EPANET-MSX](https://github.com/OpenWaterAnalytics/epanet-msx) into a single library.
+Most importantly, it also provides a Python package with a high-performance interface
+(i.e., C extension) to the C library, together with additional helper functions for an easier
+use of EPANET and EPANET-MSX.
+
+If you are interested in creating and simulating complex scenarios, we recommend to take a look
+at [EPyT-Flow](https://github.com/WaterFutures/EPyT-Flow), which builds upon EPANET-PLUS.
+
+## Unique Features
+
+Unique features of EPANET-PLUS that make it superior to other Python interfaces of EPANET are the following:
+
+- High-performance (single) interface to the latest version of EPANET and EPANET-MSX
+- Additional C-functions to extend EPANET and EPANET-MSX
+- Python toolkit with handy functions for working with EPANET and EPANET-MSX 
+
+## Installation
+
+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.
+
+### PyPI
+
+```
+pip install epanet-plus
+```
+
+
+### Git
+
+Download or clone the repository:
+
+```
+git clone https://github.com/WaterFutures/EPANET-PLUS.git
+cd EPANET-PLUS
+```
+
+Install all requirements as listed in [REQUIREMENTS.txt](https://raw.githubusercontent.com/WaterFutures/EPANET-PLUS/main/REQUIREMENTS.txt):
+
+```
+pip install -r REQUIREMENTS.txt
+```
+
+Build and install the package:
+
+```
+pip install .
+```
+
+## Quick Example
+
+```python
+from epanet_plus import EPyT, EpanetConstants
+
+if __name__ == "__main__":
+    # Load an .inp file in EPANET using the toolkit class
+    epanet_api = EPyT("net2-cl2.inp")
+
+    # Print some general information
+    print(f"All nodes: {epanet_api.get_all_nodes_id()}")
+    print(f"All links: {epanet_api.get_all_links_id()}")
+    
+    print(f"Simulation duration in seconds: {epanet_api.get_simulation_duration()}")
+    print(f"Hydraulic time step in seconds: {epanet_api.get_hydraulic_time_step()}")
+    print(f"Demand model: {epanet_api.get_demand_model()}")
+
+    # Run hydraulic simulation and output pressure at each node (at every simulation step)
+    epanet_api.openH()
+    epanet_api.initH(EpanetConstants.EN_NOSAVE)
+
+    tstep = 1
+    while tstep > 0:
+        t = epanet_api.runH()
+
+        print(epanet_api.getnodevalues(EpanetConstants.EN_PRESSURE))
+
+        tstep = epanet_api.nextH()
+
+    epanet_api.closeH()
+
+    # Close EPANET
+    epanet_api.close()
+```
+
+## Documentation
+
+Documentation is available on readthedocs: [https://epanet-plus.readthedocs.io/en/latest/](https://epanet-plus.readthedocs.io/en/stable)
+
+# License
+
+MIT license -- see [LICENSE](LICENSE)
+
+## How to Cite?
+
+If you use this software, please cite it as follows:
+
+```bibtex
+@misc{github:epanetplus,
+        author = {André Artelt},
+        title = {{EPANET-PLUS}},
+        year = {2025},
+        publisher = {GitHub},
+        journal = {GitHub repository},
+        howpublished = {https://github.com/WaterFutures/EPANET-PLUS}
+}
+```
+
+## How to get Support?
+
+If you come across any bug or need assistance please feel free to open a new
+[issue](https://github.com/WaterFutures/EPyT-Flow/issues/)
+if non of the existing issues answers your questions.
+
+## How to Contribute?
+
+Contributions (e.g. creating issues, pull-requests, etc.) are welcome --
+please make sure to read the [code of conduct](CODE_OF_CONDUCT.md) and
+follow the [developers' guidelines](DEVELOPERS.md).

epanet_plus-0.1.2.dist-info/RECORD

@@ -0,0 +1,106 @@
+epanet.cpython-312-darwin.so,sha256=vChv89DOQvUczIF4j43wCYYrb12rhwbrLRZDYourCPI,703624
+python-extension/pyepanetmsx.h,sha256=BXI0jBTl2RzAaogfIeALgv7n1-pizSVtYqUtupEVTkQ,2088
+python-extension/ext.c,sha256=sjDx2HWTY9Ov35rxDH0E6szI249YDCK5DT2EKLFSfVg,38183
+python-extension/pyepanet.h,sha256=RUQ79GAv58Wo_FqFXcUgz4MpPA_t6tWze0P4wjFniJE,9153
+python-extension/pyepanet_plus.c,sha256=A_6eN31QeNBw3nfACpblDsvndzvKB1N9Bq4qT6f6UUs,938
+python-extension/pyepanet2.h,sha256=tmaekND6Zb00Tl99TAa5M53nQnsoPZ-L0LfM1JKgBsA,9122
+python-extension/pyepanetmsx.c,sha256=3uZcfLpyVFhOxzyqk-1iuLV8XRAcprOsKUCkj57JmL4,9282
+python-extension/pyepanet.c,sha256=uc3gVN7uoMLLC3shTRnfAz5RMsK4D9Bt88kAnR0Hmrc,56051
+python-extension/pyepanet_plus.h,sha256=2Pz6cVxJas_nlcYVeYU3xnqXMTcsCJ18P-vnnZa_YAs,156
+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
+epanet-msx-src/dispersion.h,sha256=qYeHTzI4N2Y2ja0qGkKUBG6aGaD_erNgvHuhGgy0iLM,941
+epanet-msx-src/smatrix.h,sha256=heHTNgQNNDTs_Jx0YBts7_B7dPg8VUF1jgBBmU-qbfc,1567
+epanet-msx-src/msxout.c,sha256=x_gLPmsFfh1Bqb3J9GrPcVKdCpyVB2vNyf2HBf3sBZg,11246
+epanet-msx-src/newton.c,sha256=tgbGLLn_cwbD7zKu5DA1xZfx2h8mKsSIO09vhYiMI-Y,4387
+epanet-msx-src/ros2.c,sha256=ycMgrsopw2yD_nKRfjUaGY-fWibrR124PPugkwcFikg,8542
+epanet-msx-src/msxutils.c,sha256=HLPavITgmlX9-s6mOUkQPt3noQUiv0I1gT_59Q33dfs,12104
+epanet-msx-src/mempool.c,sha256=WR_2IU5YdYD74f-s4gr2ia9AlgNXMMoLCdXxdVbseQM,4283
+epanet-msx-src/rk5.c,sha256=3rCy4ivgbwZXS0DfCckrdO_bpFqhsaFTtFDCA7sC3UA,9778
+epanet-msx-src/msxfuncs.h,sha256=P7BfVu7xrFp7DUfNcO-TuBIITcPEJYmqkKRVdj_k5Qs,1337
+epanet-msx-src/hash.c,sha256=bxilMFOs3t-UuI2ZxJQZrjbUi6sUNMrp6MO0Q5snMmo,2848
+epanet-msx-src/msxchem.c,sha256=CzJoJyAepVAylmKH78uucUKYz3Ng4CkCy2RI2Mv4h-E,35046
+epanet-msx-src/smatrix.c,sha256=l4VVV_44Jm7xAqQ4EEk66JZCyZ0MWOFwm99VAqgq5l4,28375
+epanet-msx-src/msxerr.c,sha256=kFqe96sn-kFjj6PwwLKyJ3fAQ0dslVc8PE-e2AM6fKU,3055
+epanet-msx-src/msxtank.c,sha256=UNeZg9pcBjx8kHiVgDWWAPrfOrUDr3gpEwDO66_bh20,12126
+epanet-msx-src/mathexpr.c,sha256=ZddmJu3NvnmOZwqF58vXcy4x8fijB86DzSi_sr-g8b0,23189
+epanet-msx-src/msxcompiler.c,sha256=mYzjdspLZSZM7L2ECgzmHOk_VoqB_cf0mcbL-oMrG1s,10817
+epanet-msx-src/msxdict.h,sha256=1nAa1vhcJUY8QFgigPXRaZcbNxJwyQ1awpeuD5nmbrQ,2147
+epanet-msx-src/mempool.h,sha256=zErH6G07mEDdrBRe-VoaEzjyuxD8RICxAAv9ROpnkGQ,455
+epanet-msx-src/msxproj.c,sha256=Of2YTh98MXMUv2ZiwNyUcKf7gh2QsYVEMV_yJiQ7bBs,21817
+epanet-msx-src/ros2.h,sha256=Ll-IInq4X1pVGchQH8PRGiPPLhoson7Vt0w3c0_Xx1o,1249
+epanet-msx-src/msxrpt.c,sha256=RW-sD7Q1LaxKLNSBXrxSkEKerGNCMMdA9BkSkJm3Pis,11505
+epanet-msx-src/newton.h,sha256=mkSbH7deDiL83DstIt1xLoC933G0gc16ofc7QL04r5s,1090
+epanet-msx-src/msxutils.h,sha256=R1qNWqw74TcaAErzzeBjXnH6cwDX2NYvQYX-pc4mfMA,1811
+epanet-msx-src/msxdispersion.c,sha256=qsFYBGV1OUkGTnSa6u6gy-qebiV7NqyISZo_MoHBbi0,14274
+epanet-msx-src/msxtypes.h,sha256=0LSgX4yiCxWBuFm0Dt1lD0lryRob5T8x38ukXWg9rSc,24060
+epanet-msx-src/hash.h,sha256=2C4ebltth9ekERJvJy8QI2s-4zpIudpqW5bdy2IIeSA,412
+epanet-msx-src/msxinp.c,sha256=QNrZt2yLo7sXiK4QXgMskDNXYXXmS5iyCZIxkC4WWT0,38985
+epanet-msx-src/rk5.h,sha256=HzbHtGY4vMc16-CtBoM1epjQgt53NJ44asBnIW_3L3c,1280
+epanet-msx-src/msxfuncs.c,sha256=uXdp0LUQapVIgE9Yj0V9qG99SSrvqzIt7olysuRKbJQ,4364
+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=aSqbkNVPcadn8i-eCnVEY59pk1HY34-IGTIJW016Fw0,73708
+epanet_plus/epanet_toolkit.py,sha256=N3Nb0QXIeuy5swwQUeoW2jEsqhOyXGTCrzWXrKnquiU,82037
+epanet_plus/__init__.py,sha256=XorLU8AO-crTDUwlM-EVyrOYynh3FrGkhQuSsWwI9Ls,215
+epanet_plus/VERSION,sha256=VKRsZExOtvEo-Z9_CENJGGF7MbaAUi7UrLV8lCQ3KCc,5
+epanet_plus/epanet_plus.c,sha256=zWfYlLgYdQCQtIkVHNpgEBOBqJefeJX7H3cHZThkxnw,3183
+epanet_plus/include/epanet_plus.h,sha256=z2PEExuz6szxUp1k5vwsMQy2uSRz_X-W9B7xSP2f33s,340
+epanet_plus-0.1.2.dist-info/RECORD,,
+epanet_plus-0.1.2.dist-info/WHEEL,sha256=mer8vOuI-KlBtJIdzgyZALHdls6RZGRaE6RPt7dfKrk,138
+epanet_plus-0.1.2.dist-info/top_level.txt,sha256=igwRsFnggi2fSCG7AHkP3LfOLlgsT2aUu0oa8DpvHDo,103
+epanet_plus-0.1.2.dist-info/METADATA,sha256=f5wloAuAXscSr91AuUfOrW2fupyJP7jdxV6TBIwWK-o,5451
+epanet_plus-0.1.2.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
+tests/test_epanet.py,sha256=jgiqFiHZ3UB7on6WzbWKS6D0aXxIUTBCexDGoSmLitQ,463
+docs/conf.py,sha256=xd41cfAn4qscUNt--XoojOmgC9kWUI7ZNfpLjbRPpuU,2132
+epanet-src/inpfile.c,sha256=obYLcr4DikW89h_uBc-LvLViU2m9gJozZa1CsXy19nY,28208
+epanet-src/validate.c,sha256=nT6Xyd2E0ZXVZEZj2Zuo-K_TOBznIGrODUXqXmpMcCI,12117
+epanet-src/input2.c,sha256=qJUHBY-tcmXLriah3VOTNTNnbUvWNtrh_L7gy0ftysA,29542
+epanet-src/errors.dat,sha256=5p-lbCKco6-iNNLVUKohi4eLa3sE1l4_F3BuALmW3WE,3014
+epanet-src/text.h,sha256=sFv5LZQ-7pKRz9xe6NVMT2PeJZzdeuP4jE6CIYXqu9M,17731
+epanet-src/LICENSE,sha256=XrPEC-tu4Ha8AGxwh4uSTgaENMyXGrsTdVOzsFBk8A0,1090
+epanet-src/hydstatus.c,sha256=C7X660ow5T1AmSqIB-EHc7xD5NoF_dGqS9NrufERGi8,13196
+epanet-src/report.c,sha256=AbKWhEj4itrGgSVWgSr2Z6fZcIpBN1qvOA2cV5C0-HM,46033
+epanet-src/types.h,sha256=3y8YCn5xCQgzDB-_2UUH_BRPmLm16-zyUyEaBb6EGG0,33129
+epanet-src/AUTHORS,sha256=8nnSXx3x4js8FtPZrcluaIbwm5vUxxCZlGhAAx2XALc,1916
+epanet-src/rules.c,sha256=OaJIr1WCZ0keJp8mxJs2-S_mE8QB1TVKEeprAfhof5Y,39491
+epanet-src/mempool.c,sha256=3idwF-IfhG4fWZPeESnmG2nWeRpdATaPpiNkPC6wGus,3646
+epanet-src/hydsolver.c,sha256=tO6zfzyzhoDXGjReE0CRn2_EtEYIM9cxO4kp4-VA3_M,25428
+epanet-src/project.c,sha256=Z1K01Of1ga4wB6paXkhklM6Z_ny94IZ6pYINFpHVzHM,51675
+epanet-src/epanet2.def,sha256=5265uHv5EV-GSO5XbdXvod469pencib1LZThMyJ7siM,7782
+epanet-src/input1.c,sha256=W8DJFAaaOwyfiBWei8pVZNAvXyIqlkbxncdliHTLepc,22899
+epanet-src/hash.c,sha256=wY8Rzw-93oNrXUOFsfe4NVRn7NYXhlVHAciQm11goH0,4231
+epanet-src/epanet2.c,sha256=AgRfutfQraTcjrE-IlEbejg_BxuzS_Ly98i6OIW3a80,27910
+epanet-src/leakage.c,sha256=ygnmgJCAZhpzERdM2hQATlOmbNexH2RclXlH3r8x6Zs,16470
+epanet-src/flowbalance.c,sha256=zEFAgmMRtKR9KJkEKb7j3JXui01jsnj1zLJiGI3Y_ik,5661
+epanet-src/smatrix.c,sha256=NNZIRSKTyzfi_fdWyqwcUsqJXRjFC2pnmRZhTrLX3oA,26020
+epanet-src/epanet.c,sha256=3r7smEFzN4Ndt4d8V_YBFaTRqQGg9k2k1B6B2gK5lw4,182356
+epanet-src/hydcoeffs.c,sha256=CP0p6F-8000e_9153T9qruJPPjICL1J6Wd2uxNhi7kc,38589
+epanet-src/qualreact.c,sha256=W2nxecPc3E44EkRUWU_bSFmA_SNYUKMkpIDsVxXSa5E,23731
+epanet-src/genmmd.c,sha256=qM0JX1LbiGTawbANyXs93XK-khVPMyWhiGQRNQ8SSKE,32936
+epanet-src/hydraul.c,sha256=VlAsh6sfSqn-HGwI0LrO0khDP823Rdayc-KUNEl8OfQ,33686
+epanet-src/funcs.h,sha256=bpm0sKJnH9Mydl-HCeLrAZ9kcFn8jZu1a0OMcPYosxQ,7018
+epanet-src/mempool.h,sha256=JKSJX5vBHjhQ3_rme6MtAkXSy2KPbiKu-7-nMRcp5I8,677
+epanet-src/qualroute.c,sha256=nq0DtBsWYukvZxn0yYYdYjiGm7kyiAvhqJXEc0FL8sw,21714
+epanet-src/quality.c,sha256=dbm7zLxaFu-UaUVRf3ZVMg_aYGKOL7gGKMTFxaR28fE,19839
+epanet-src/input3.c,sha256=SZpAWtSus00dd78MrFo5JQW1qXE9P0RD_mRXuoHUqwI,68743
+epanet-src/enumstxt.h,sha256=aJYz_VOnGF4oJ3spdtbHlJq7k3rJSjc0koszg32Y9FI,4974
+epanet-src/output.c,sha256=SuOVWz0ZT3hqxqXKOc2DAt7sg3XKKPhKqel89FR0LKU,26680
+epanet-src/hash.h,sha256=xRyuJSJz6tQB9Jds6FZtE57kIWq3bgJUf-Bis--QcJI,896
+epanet-src/util/filemanager.h,sha256=QM0J6ED52S-LjJIOJ3zYw0KRSGnQ9KCogJtf77kqsb0,1844
+epanet-src/util/errormanager.c,sha256=yvdysNOo6yeoSWWYYGsBn6ywtpTmuV5Qpq4Vy_QIdLs,2058
+epanet-src/util/cstr_helper.h,sha256=2ivKuiOY097jBCFb0hWWoSgZqrxUyo6BVVbdmqkTYlc,727
+epanet-src/util/cstr_helper.c,sha256=qFvFKXV0YLtk_Q79T0ERuXlgvsgznPMQKbpzz40xbkI,1348
+epanet-src/util/errormanager.h,sha256=ghebj0NO_1lvmFncgUt35t9Z9D4zrWwTSnpxzyfahig,982
+epanet-src/util/filemanager.c,sha256=ul4LdINZ8Lb273KPCRWo1KjCLC6dIzhWE62sXJwX5kc,4666
+epanet-src/include/epanet2_enums.h,sha256=vP4c3AhIB6Md2HLS8YaKVXADUqXiuJSu1NmNDl9vhEY,22683
+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.2.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_10_13_x86_64
+Generator: delocate 0.13.0
+

epanet_plus-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) EPANET-PLUS Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

epanet_plus-0.1.2.dist-info/top_level.txt

@@ -0,0 +1,11 @@
+build
+docs
+epanet
+epanet-msx-src
+epanet-src
+epanet_plus
+examples
+python-extension
+src
+tests
+wheelhouse

examples/basic_usage.py

@@ -0,0 +1,35 @@
+"""
+Basic example showing how to load an .inp file and run a hydraulic simulation.
+"""
+from epanet_plus import EPyT, EpanetConstants
+
+
+if __name__ == "__main__":
+    # Load an .inp file in EPANET using the toolkit class
+    epanet_api = EPyT("net2-cl2.inp")
+
+    # Print some general information
+    print(f"All nodes: {epanet_api.get_all_nodes_id()}")
+    print(f"All links: {epanet_api.get_all_links_id()}")
+
+    print(f"Simulation duration in seconds: {epanet_api.get_simulation_duration()}")
+    print(f"Hydraulic time step in seconds: {epanet_api.get_hydraulic_time_step()}")
+    print(f"Demand model: {epanet_api.get_demand_model()}")
+
+    # Run hydraulic simulation and output pressure at each node (at every simulation step)
+    epanet_api.openH()
+    epanet_api.initH(EpanetConstants.EN_NOSAVE)
+
+    tstep = 1
+    r = []
+    while tstep > 0:
+        t = epanet_api.runH()
+
+        print(f"Current pressure per node: {epanet_api.getnodevalues(EpanetConstants.EN_PRESSURE)}")
+
+        tstep = epanet_api.nextH()
+
+    epanet_api.closeH()
+
+    # Close EPANET
+    epanet_api.close()

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