Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BMI for nhd_networks #587

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Conversation

shorvath-noaa
Copy link
Contributor

Initial version of a BMI wrapper for t-route. This was designed for working with nhd_networks, but should be easily customizable to work with HYFeatures. Many functions from main.py have been moved into network/main_utilities.py so they are callable from the BMI wrapper.

run-troute-with-bmi.ipynb shows an example of running this with the LowerColorado_TX test AnA config file.

Additions

  • bmi_troute.py with bmi specific functions to call t-route
  • run-troute-with-bmi.ipynb for an example of how to run t-route with the BMI wrapper
  • network/main_utilities.py: houses functions that perform the modified workflow from main.py
  • bmi specific functions that are used: initialize(), set_value(), update(), update_until(), get_value(), get_current_time()

Removals

Changes

Testing

Screenshots

Notes

Todos

  • We probably want to reorganize the directory structure. Some files in troute-network should be housed somewhere else (e.g., main_utilities.py)
  • Adapt to work with HYFeatures network

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 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Windows
  • Linux
  • Browser

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

@shorvath-noaa
Copy link
Contributor Author

We should also revisit all of the logging and timing options that were used in v3.0, most of them have been removed

@jameshalgren
Copy link
Contributor

May make sense to connect to #596

@shorvath-noaa
Copy link
Contributor Author

@jameshalgren Thanks! We're beginning to work on revamping this PR to be compatible with HYFeatures rather than NHD network, so we'll keep #596 in mind as we do that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants