From d6f21a7f7ba067fb6e83e0bdf3be20b8f29d7af2 Mon Sep 17 00:00:00 2001 From: Sebastian Kerger <sebastian.kerger@rwth-aachen.de> Date: Wed, 5 Mar 2025 10:28:44 +0100 Subject: [PATCH] Edit README.md --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2619a0e..560638d 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,22 @@ The project is based on the Pyhton interface [MIKE+Py](https://github.com/DHI/mi - 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 ## Requirements -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +- 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 -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +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 -If you have ideas for releases in the future, it is a good idea to list them in the README. +The code is currently not developed any further as the project came to an end. ## Contributing State if you are open to contributions and what your requirements are for accepting them. @@ -38,6 +39,3 @@ Please note that this project is released with a [Contributor Code of Conduct](h ## Project status The work on this project ends with the project in march 2025. - -##Citation -Work in progress -- GitLab