From 77e73a31e223538bcab2f4a3309b171e824bc6bb Mon Sep 17 00:00:00 2001 From: Sebastian Kerger <sebastian.kerger@rwth-aachen.de> Date: Mon, 17 Mar 2025 14:14:42 +0100 Subject: [PATCH] Edit README.md --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 560638d..55162c9 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,30 @@ # MIKE+Py Scripts -On this git you can find several scripts which were written to automate the development of real time control rules for control of sewer systems in [MIKE+](https://worldwide.dhigroup.com/de/mikeplus). +On this git you can find several scripts which were written to automate the development of real time control rules for control of sewer systems and the calibration of sewer systems in [MIKE+](https://worldwide.dhigroup.com/de/mikeplus). ## Description The project is based on the Pyhton interface [MIKE+Py](https://github.com/DHI/mikepluspy) which was developed by DHI. It contains several scripts including: - Automated hydraulic calibration of a MIKE+ model - Automated calibration of a waterquality / sediment transport model - Automated optimization of heuristic control rules -- Analysis of P-RTC potential +- Analysis of P-RTC potential +-- these files are not available yet and will be uploaded later ## Requirements -- Python version: - see env.yml file for all necessary packages to runs the scripts -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - ## Support For any questions regarding the code pls reach out to: Sebastian Kerger: kerger@fiw.rwth-aachen.de Leon Trojan: trojan@fiw.rwth-aachen.de ## Roadmap -The code is currently not developed any further as the project came to an end. +Status 03/2025: The project came to an end so most code is not developed any further. +The code for the analysis of P-RTC is still in its last development stages adn will be uploaded later. ## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +@Loan Angaben machen? -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. ## Authors and acknowledgment The code in this project was written by Leon Trojan, Yu-Jin Schroer and Sebastian Kerger. The code was developed in the project [ENTfrachtEN](https://www.fiw.rwth-aachen.de/en/references/entfrachten) carried out by the [Research Institute for Water Management and Climate Future at RWTH Aachen University](https://www.fiw.rwth-aachen.de/en/). The project was funded by the [Deutsche Bundesstiftung Umwelt](https://www.dbu.de/en/). -- GitLab