Awesome

<a href="http://www.kios.ucy.ac.cy"><img src="https://www.kios.ucy.ac.cy/wp-content/uploads/2021/07/Logotype-KIOS.svg" width="200" height="100"/><a>

EPANET Python Toolkit (EPyT)

The EPANET-Python Toolkit is an open-source software, originally developed by the KIOS Research and Innovation Center of Excellence, University of Cyprus which operates within the Python environment, for providing a programming interface for the latest version of EPANET, a hydraulic and quality modeling software created by the US EPA, with Python, a high-level technical computing software. The goal of the EPANET Python Toolkit is to serve as a common programming framework for research and development in the growing field of smart water networks.

The EPANET-Python Toolkit features easy to use commands/wrappers for viewing, modifying, simulating and plotting results produced by the EPANET libraries.

For support, please use the OWA community forum : http://community.wateranalytics.org/

Table of Contents

• EPANET Python Toolkit (EPyT)
• How to cite
• Requirements
• How to install
• How to use the Toolkit
• How to fix/report bugs
• Licenses
• Contributors
• Contributing
• Recommendation
• List of Python Class Functions
• List of EPANET 2.2 Functions

How to cite

Kyriakou, M. S., Demetriades, M., Vrachimis, S. G., Eliades, D. G., & Polycarpou, M. M. (2023). EPyT: An EPANET-Python Toolkit for Smart Water Network Simulations. Journal of Open Source Software, 8(92), 5947. https://doi.org/10.21105/joss.05947

@article{Kyriakou2023,
author = {Kyriakou, Marios S. and Demetriades, Marios and Vrachimis, Stelios G. and Eliades, Demetrios G. and Polycarpou, Marios M.},
doi = {10.21105/joss.05947},
journal = {Journal of Open Source Software},
month = dec,
number = {92},
pages = {5947},
title = {{EPyT: An EPANET-Python Toolkit for Smart Water Network Simulations}},
url = {https://joss.theoj.org/papers/10.21105/joss.05947},
volume = {8},
year = {2023}
}

↑ Back to top

Requirements

• Python >=3.8
• Windows, OSX or Linux
• EPANET 2.2

Linux: sudo cp libepanet2.so /lib/x86_64-linux-gnu/libepanet.so

↑ Back to top

How to install

Environments -> base (root) -> open terminal -> pip install epyt

• PyPI: <b>pip install epyt</b>

↑ Back to top

How to use the Toolkit

Minimum Example:

>>> from epyt import epanet
>>> 
>>> d = epanet('Net1.inp')
>>> d.getNodeCount()
>>> d.getNodeElevations()

Minumun Example using custom Library:

>>> from epyt import epanet
>>>
>>>epanetlib=os.path.join(os.getcwd(), 'epyt','libraries','win','epanet2.dll')
>>>msxlib=os.path.join(os.getcwd(), 'epyt','libraries','win','epanetmsx.dll')
>>>d = epanet(inpname, customlib=epanetlib)
>>>d.loadMSXFile(msxname, customMSXlib=msxlib)

More examples:

https://github.com/KIOS-Research/EPYT/tree/main/epyt/examples

↑ Back to top

How to fix/report bugs

To fix a bug Fork the EPyT, Edit the code and make the appropriate change, and then Pull it so that we evaluate it.

Keep in mind that some bugs may exist in the EPANET libraries, in case you are not receiving the expected results.

↑ Back to top

Licenses

• EPANET: Public Domain
• EPANET-Python Toolkit (EPyT): EUPL

↑ Back to top

Contributors

• Marios Kyriakou, KIOS Research and Innovation Center of Excellence, University of Cyprus
• Marios Demetriades, KIOS Research and Innovation Center of Excellence, University of Cyprus
• Stelios Vrachimis, KIOS Research and Innovation Center of Excellence, University of Cyprus
• Demetrios Eliades, KIOS Research and Innovation Center of Excellence, University of Cyprus

The EPyT is based/inspired on the EPANET-Matlab Toolkit.

Contributing

If you want to contribute, please check out our Code of Conduct. Everyone is welcome to contribute whether reporting a new issue, suggesting a new feature, or writing code. If you want to contribute code, you can create a new fork in the repo to your own account. Make your commits on your dev branch (based on dev) and when you are finished then you can create a pull request to test the code and discuss your changes.

Recommendation

• Install Anaconda<br>
• Run EPyT with Spyder IDE
• Run EPyT with PyCharm

Settings on Spyder IDE

• Tools -> Preferrences
• View -> Window layouts -> Matlab layout
• Enable interactive plot on matlibplot : Tools -> Preferences -> IPython console -> Graphics -> Graphics backend -> Backend: Automatic

↑ Back to top

List of Python Class Functions

List of EPANET 2.2 Functions

↑ Back to top