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

Release/0.9.0rc #313

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Release/0.9.0rc #313

wants to merge 26 commits into from

Conversation

mdeshotel
Copy link
Collaborator

Feature-release 0.9.0rc

Summary

This PR adds checks for both source HEC-RAS model units and whether the source HEC-RAS model is an unsteady model. If the source model units are not English then an error is raised because rippl1d only supports English units. If the source model was an unsteady model then an error is raised as ripple1d only supports steady state 1d HEC-RAS source models.

This PR also includes updates to the 2 endpoints. Conflate_model and compute_conflation_metrics now require a model_name arg. This was added so that the geopackage file did not have to be inferred from the directory/directory name. Now the geopackage name is derived from combining the source_model_directory arg and the model_name arg.

Lastly, this PR adds a flag in the rating curve database for when a plan/profile overtops one of the cross sections in the model. The column for this boolean is named xs_overtopped.

Features Added

Check Units

The source HEC-RAS model (and thus the derived submodel) must have units of English. If it does not then an error is raised in the create_model_run_normal_depth endpoint. To do this several additional changes had to be made to the schema.

  • units is now passed from the source_model.gpkg to the conflation.json during conflate_model.
  • source_model_metadata is now passed from the conflation.json to the ripple1d.json during extract_submodel.
  • units and steady (which is a boolean indicating if the source model was steady state) is now passed from the conflation.json to the submodel.gpkg during extract_submodel. This required adding a new metadata table to the submodel.gpkg.
  • create_model_run_normal_depth reads the ripple1d.json and raises an error if units is not English.

Handle Unsteady Source Model

The handling of unsteady flow files in the source RAS model has been updated. Unsteady RAS models can now be extracted for cataloging purposes without error. However, it was decided that unsteady 1d models should not be processed through ripple1d as a steady state model and so an error is raised during create_model_run_normal_depth if the forcing file extension from the source model does not contains f indicating that it is not a steady state model.

Identify Overtopped Cross Sections

A column named xs_overtopped has been to the rating curve database which indicates if any cross sections were overtopped for any plan/profile. This should help to identify when a FIM should be scrutinized, discarded, or other decision made with regards to how it should be interpret it.

Add Model Name as arg

A required arg, model_name has been added to the conflate_model and compute_conflation_metrics endpoint. This enables the the user to specify the name of the model instead of inferring it from the model directory name which was not full proof.

closes #186
closes #303
closes #123
closes #176

slawler and others added 26 commits January 20, 2025 17:38
Fix handling of unsteady flows simulations in source model
Add xs_overtopped column to rating curve db
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants