rasqc

Automated QA/QC checks on HEC-RAS models.

Pronunciation: raz·kju·si

Developer Setup

Create a virtual environment in the project directory:

$ python -m venv venv-rasqc

Activate the virtual environment:

# For macOS/Linux
$ source ./venv-rasqc/bin/activate

# For Windows
$ ./venv-rashdf/Scripts/activate

Install dev dependencies:

(venv-rasqc) $ pip install ".[dev]"

Code Formatting

(venv-rasqc) $ ruff format

Unit Testing

(venv-rasqc) $ pytest

Run

(venv-rasqc) $ python -m rasqc.cli --help

Build Console App

(venv-rasqc) $ pyinstaller "./rasqc/cli.py" --name rasqc --onefile --collect-all pyogrio --add-data "./rasqc/template.html:./rasqc"

CLI

The rasqc command-line interface allows export directly to a variety of formats.

$ & "rasqc.exe" ras_model [--checksuite] [--theme] [<options$]

CLI help:

$ & "rasqc.exe" --help

Example: run the "ble" checksuite and write output files to the disk ({model root folder}/rasqc):

$ & "rasqc.exe" "Muncie.prj" --checksuite ble --files

Example: run the "ble" checksuite and write results to stdout:

$ & "rasqc.exe" "Muncie.prj" --checksuite ble

Example: run the "ble" checksuite, print results as GeoJSON, and return a dict of results:

$ & "rasqc.exe" "Muncie.prj" --checksuite ble --json