Skip to content

Feature/ble merge#17

Merged
bates-j merged 32 commits into
mainfrom
feature/ble-merge
Jul 2, 2025
Merged

Feature/ble merge#17
bates-j merged 32 commits into
mainfrom
feature/ble-merge

Conversation

@bates-j

@bates-j bates-j commented Jun 3, 2025

Copy link
Copy Markdown
Member

This PR adds the "ble" CheckSuite along with the checks listed below. It also includes functionality to write results to the disk in the form of an html log file and, when applicable, ESRI Shapefiles.

  • associated layers (AssociatedLayers): reports the layers (e.g., terrain, land cover, etc.) associated with each geometry as a 'note' to be reviewed by the user
  • breakline enforcement (BreaklineEnforcement): checks the breakline enforcement within the current geometry and returns a GeoDataFrame of delinquent breaklines
  • current saved plan (CurrentPlan): reports the name and title of the plan saved as the current plan within a RAS model
  • erroneous cells (ErroneousCells): checks the current geometry within a RAS model and returns a GeoDataFrame of erroneous 2D mesh cells (those with the center point outside the cell boundary)
  • 2D equation set (EquationSet2DNote): reports the selected 2D equation set for the current geometry of a RAS model as a 'note' to be reviewed by the user
  • computational settings (CompSettings): reports the computational timestep settings for each plan of a RAS model as a 'note' to be reviewed by the user
  • geometry projection (GeomProjectionNote): reports the projection of the current geometry of a RAS model as a 'note' to be reviewed by the user
  • ras version (RasVersion): reports the RAS version used to develop a RAS model geometry as a 'note' to be reviewed by the user
  • refinement region enforcement (RefRegionEnforcement): checks the refinement region enforcement within the current geometry and returns a GeoDataFrame of delinquent refinement regions
  • short cell faces (ShortCellFaces): checks the current geometry within a RAS model and returns a GeoDataFrame of short cell faces that can cause instabilities
  • structure overflow method (OverflowMethod): checks the overflow method set for non-bridge structures within the current geometry of a RAS model to ensure they are set to the normal 2D equation and lists any flagged structures to investigate
  • file structure (FileStructure): reports the file structure of a RAS model as a 'note' to be reviewed by the user
  • gridded precip (MeteorologyPrecip): reports any gridded precipitation sources set for each plan in a RAS model as a 'note' to be reviewed by the user
  • precip hydrographs (PrecipHydrographs): reports any precipitation hydrograph boundary conditions set for each plan in a RAS model as a 'note' to be reviewed by the user
  • flow hydrographs (FlowHydrographs): reports any flow hydrograph boundary conditions set for each plan in a RAS model as a 'note' to be reviewed by the user
  • stage hydrographs (StageHydrographs): reports any stage hydrograph boundary conditions set for each plan in a RAS model as a 'note' to be reviewed by the user
  • normal depths (NormalDepths): reports any normal depth boundary conditions set for each plan in a RAS model as a 'note' to be reviewed by the user
  • rating curves (RatingCurves): reports any rating curve boundary conditions set for each plan in a RAS model as a 'note' to be reviewed by the user
  • initial conditions (InitialConditions): reports any initial conditions set for each plan in a RAS model as a 'note' to be reviewed by the user
  • volume accounting (VolumeError): checks the volume error associated with a given simulation run to ensure it's less than 2% of the total volume
  • structures (BridgeXsData): checks if the bank stations are set to a valid point station within the cross section and that they are congruent with manning's breaks for the channel

@bates-j
bates-j requested a review from thwllms June 3, 2025 21:29
@bates-j bates-j self-assigned this Jun 3, 2025
@bates-j bates-j added the enhancement New feature or request label Jun 3, 2025
Comment thread rasqc/checkers/associated_layers.py
Comment thread rasqc/checkers/plan_settings.py Outdated
Comment thread rasqc/checkers/refinement_regions.py Outdated
Comment thread rasqc/checkers/short_cell_faces.py Outdated
Comment thread rasqc/cli.py Outdated
Comment thread rasqc/utils.py Outdated
Comment thread rasqc/checkers/volume_accounting.py Outdated
Comment thread rasqc/cli.py Outdated
Comment thread rasqc/cli.py Outdated
Comment thread rasqc/utils.py Outdated
@thwllms

thwllms commented Jun 24, 2025

Copy link
Copy Markdown
Contributor

@bates-j will also need to bump version number to 0.0.5

@bates-j

bates-j commented Jun 27, 2025

Copy link
Copy Markdown
Member Author

@bates-j will also need to bump version number to 0.0.5

pyproject.toml updated to version 0.0.5

@bates-j bates-j closed this Jun 27, 2025
@bates-j bates-j reopened this Jun 27, 2025
@bates-j
bates-j requested a review from thwllms June 27, 2025 18:11
@bates-j
bates-j merged commit 1647ed6 into main Jul 2, 2025
8 checks passed
@bates-j
bates-j deleted the feature/ble-merge branch July 2, 2025 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants