Improve code quality

[veenstrajelmer]

Todo:

• convert TODO from hatyan functions and example scripts into Github issues (https://github.com/search?q=repo%3ADeltares%2Fhatyan+TODO&type=code, 55 occurences on 15-12-2022, 14 on 13-5-2024)
• reduce code complexity of analysis_prediction.py and timeseries.py
• clean up code with help of SIG, status badge shows quality status or only finishing of action? Possible to let badge link to public online dashboard with code analysis results? Possible to let badge show color-coded code rating? Possible to (also) get all-code scores back from analysis (now only new code and often N/A)
• improve code quality by solving sonarcloud high severity issues (21 issues at 6-9-2024)
• style guide: https://www.python.org/dev/peps/pep-0008/
• isort/black
• argument type checking (pydantic?) >> hatyansettings
• introduce types for essential variables: https://docs.python.org/3/library/typing.html (and update docstring)
• Check flake8 warnings, maybe i.c.w. black code formatter