Short and clear description of the software and its purpose.
e.g.
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: https://github.com/orgs/OpenWaterAnalytics/discussions
- Project Description
- Table of Contents
- How to cite
- Requirements
- How to install
- How to use the toolkit / Usage
- How to fix/report bugs
- License
- Contributors
- Contributing
- Reproducibility
- Repository Structure
- Publications
If you use this software in academic work, please cite using the provided CITATION.cff file or the following format:
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}
}
- Python >=3.9
- Windows, OSX or Linux
- EPANET 2.2
- Operating System: Windows / Linux / macOS
- Language / Platform: e.g. Python, MATLAB, C++
- Dependencies: list required libraries or tools
pip install epyt
git clone https://github.com/KIOS-Research/project-name.git
cd project-nameAdd any project-specific installation steps if needed.
Basic example:
python main.py / matlab main.mProvide additional usage instructions or configuration examples if required.
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.
EPANET: Public DomainEPANET-Python Toolkit (EPyT): EUPL This software is released under the [License Name]
(e.g. European Union Public License v1.2 – EUPL-1.2)
- Name Surname, KIOS Research and Innovation Center of Excellence, University of Cyprus
- Name Surname, KIOS Research and Innovation Center of Excellence, University of Cyprus
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.
Scripts and data required to reproduce results and figures are included in this repository.
Refer to the /scripts or /examples directory for step-by-step execution.
project-name/
├── src/ # Source code
├── data/ # Datasets
├── scripts/ # Experiment / utility scripts
├── examples/ # Usage examples
├── results/ # Generated outputs
├── figures/ # Figures and plots
├── CITATION.cff
├── LICENSE
└── README.md
- Paper Title, Journal/Conference, Year — DOI: XXXXX
- Paper Title, Journal/Conference, Year — DOI: XXXXX