Refactor Step 1 (stream network delineation)
This milestone targets Step 1 of the original hazard assessment code. This milestone is complete when the codebase for step 1 have been refactored into a collection of smaller, more manageable Python modules.
Since the codebase is being altered, the outputs of the new code will need to undergo scientific validation. This will consist of a qualitative comparison of the refactored code's outputs with the original code's outputs. Relatedly, the new codebase will also require technical validation. As such, each module in the new codebase should be accompanied by a pytest testing suite.
Finally, as a matter of best practices, the new codebase should be heavily documented. All modules should be accompanied by comprehensive docstrings and additional block-level comments are encouraged. Documentation of the testing suites is also encouraged, but descriptive test names may provide an acceptable alternative to block-level comments and docstrings.
The following is a checklist and suggested issue list for each module in the refactored codebase:
- Code Refactored
- Scientific Validation
- Pytest testing suite
- Documentation (Note that documentation may be combined with refactoring in Gitlab issues)