From e6d3640e68f4cf3c9aea265a09f661364536f538 Mon Sep 17 00:00:00 2001 From: Sebastian Kerger <sebastian.kerger@rwth-aachen.de> Date: Mon, 13 May 2024 10:33:22 +0200 Subject: [PATCH] Update README.md --- README.md | 78 ++++++++++--------------------------------------------- 1 file changed, 14 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index eb1d89f..f159dea 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,14 @@ -# MIKEplusPy_scripts +# MIKE+Py_scripts - - -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://git-ce.rwth-aachen.de/sebastiankerger/mikepluspy_scripts.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://git-ce.rwth-aachen.de/sebastiankerger/mikepluspy_scripts/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. +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). ## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +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 -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals +## 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 @@ -84,10 +31,13 @@ For people who want to make changes to your project, it's helpful to have some d 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 -Show your appreciation to those who have contributed to the project. +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/). -## License -For open source projects, say how it is licensed. +## Code of Conduct +Please note that this project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/). By participating in this project you agree to abide by its terms. ## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +The work on this project ends with the project in march 2025. + +##Citation +Work in progress -- GitLab