Add function to read DFlow output to create coastal_boundary_depth_df dataframe. Update reading SCHISM files as well.
This works for now, but in my opinion we should refactor t-route so all forcing related operations are handled by a single "forcing" module. This could be an abstract class that has child classes that define reading channel forcing values based on input file format or network type (NHD or HYFeatures). Similarly, how coastal model outputs are read could be defined in abstract subclasses.
Additions
AbstractNewtork.py
read_DFlow_output(), read_SCHISM_output(), and read_coastal_output() functions.
Removals
-
Changes
diffusive_utils_v02.py
Remove converting coastal_df columns from str to datetime. They are now already datetime values.
Testing
Tested that t-route successfully reads coastal output files (DFlow and SCHISM) and creates a dataframe.
Need to verify that there is a proper check of timestamps to ensure coastal_df times match routing/forcing times.
Screenshots
Notes
-
Todos
Add BMI functionality.
Perhaps create separate "forcing" module to handle all forcing inputs.
Checklist
[ ] PR has an informative and human-readable title
[ ] Changes are limited to a single goal (no scope creep)
[ ] Code can be automatically merged (no conflicts)
[ ] Code follows project standards (link if applicable)
[ ] Passes all existing automated tests
[ ] Any change in functionality is tested
[ ] New functions are documented (with a description, list of inputs, and expected output)
[ ] Placeholder code is flagged / future todos are captured in comments
[ ] Visually tested in supported browsers and devices (see checklist below :point_down:)
[ ] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
[ ] Reviewers requested with the Reviewers tool :arrow_right:
Add function to read DFlow output to create
coastal_boundary_depth_df
dataframe. Update reading SCHISM files as well.This works for now, but in my opinion we should refactor t-route so all forcing related operations are handled by a single "forcing" module. This could be an abstract class that has child classes that define reading channel forcing values based on input file format or network type (NHD or HYFeatures). Similarly, how coastal model outputs are read could be defined in abstract subclasses.
Additions
AbstractNewtork.py
read_DFlow_output()
,read_SCHISM_output()
, andread_coastal_output()
functions.Removals
-
Changes
diffusive_utils_v02.py
coastal_df
columns fromstr
todatetime
. They are now alreadydatetime
values.Testing
Screenshots
Notes
-
Todos
Checklist
Testing checklist
Target Environment support
Accessibility
Other