@@ -7,21 +7,22 @@ The project is based on the Pyhton interface [MIKE+Py](https://github.com/DHI/mi
...
@@ -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 hydraulic calibration of a MIKE+ model
- Automated calibration of a waterquality / sediment transport model
- Automated calibration of a waterquality / sediment transport model
- Automated optimization of heuristic control rules
- Automated optimization of heuristic control rules
- Analysis of P-RTC potential
## Requirements
## 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.
- Python version:
- see env.yml file for all necessary packages to runs the scripts
## 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.
## Usage
## 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.
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
## 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
## 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
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
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
...
@@ -38,6 +39,3 @@ Please note that this project is released with a [Contributor Code of Conduct](h
## Project status
## Project status
The work on this project ends with the project in march 2025.
The work on this project ends with the project in march 2025.
