{ "schema": "rascmdr.examples-gallery/1", "count": 141, "series": [ { "series": 100, "series_name": "Initialization & Execution", "notebooks": [ { "id": "100_using_ras_examples", "title": "Using RasExamples", "summary": "extract official HEC-RAS example projects", "tags": [ "example-projects", "model-sources" ], "difficulty": "beginner", "est_runtime": "35 s", "runtime_seconds": 35.0, "data_project": "BeaverLake", "thumbnail": null, "url": "../notebooks/100_using_ras_examples.md" }, { "id": "101_project_initialization", "title": "Project Initialization", "summary": "initialize projects and inspect project DataFrames", "tags": [ "project-inventory", "dataframes" ], "difficulty": "beginner", "est_runtime": "5 s", "runtime_seconds": 4.6, "data_project": null, "thumbnail": null, "url": "../notebooks/101_project_initialization.md", "input_families": [ "HEC-RAS project text and associated files" ], "operations": [ "Initialize independent project objects", "Inspect file relationships and DataFrames" ], "outputs": [ "Project/plan/geometry/boundary inventories" ], "runtime_requirements": [ "Python; HEC-RAS installation optional for file inspection" ], "evidence_scope": "Inventory and path resolution do not establish that a plan can compute." }, { "id": "102_multiple_project_operations", "title": "Multiple Project Operations", "summary": "Manage separate project objects, clone and configure plans, execute the projects concurrently, and compare their execution records with explicit ras_object context.", "tags": [ "project-inventory", "execution", "parallel" ], "difficulty": "beginner", "est_runtime": "2.2 min", "runtime_seconds": 134.5, "data_project": null, "thumbnail": "assets/thumbs/102_multiple_project_operations.png", "url": "../notebooks/102_multiple_project_operations.md" }, { "id": "103_plan_and_geometry_operations", "title": "Plan and Geometry Operations", "summary": "Clone, associate, configure, and delete plan, geometry, and unsteady files; inspect project metadata and compute the modified plan in a working project.", "tags": [ "geometry" ], "difficulty": "beginner", "est_runtime": "1.8 min", "runtime_seconds": 110.2, "data_project": "Balde Eagle Creek", "thumbnail": null, "url": "../notebooks/103_plan_and_geometry_operations.md" }, { "id": "104_plan_parameter_operations", "title": "Plan Parameter Operations", "summary": "Read and update run flags, computation/output intervals, file descriptions, and simulation dates, then inspect the saved plan configuration.", "tags": [ "plan-authoring", "execution" ], "difficulty": "beginner", "est_runtime": "1.3 min", "runtime_seconds": 78.6, "data_project": "Balde Eagle Creek", "thumbnail": null, "url": "../notebooks/104_plan_parameter_operations.md" }, { "id": "110_single_plan_execution", "title": "Single Plan Execution", "summary": "run plans through RAS Commander", "tags": [ "execution" ], "difficulty": "beginner", "est_runtime": "8.3 min", "runtime_seconds": 497.7, "data_project": "Balde Eagle Creek", "thumbnail": null, "url": "../notebooks/110_single_plan_execution.md", "input_families": [ "Initialized HEC-RAS project and selected plan" ], "operations": [ "Execute one plan through RasCmdr", "Inspect return values and computation messages" ], "outputs": [ "ComputeResult", "Native result and diagnostic files" ], "runtime_requirements": [ "Installed HEC-RAS release compatible with the project; notebook config selects 7.0", "Writable working-copy destination" ], "evidence_scope": "Execution and completion evidence are separate from hydraulic acceptance; inspect the final result and diagnostics." }, { "id": "111_executing_plan_sets", "title": "Executing Plan Sets", "summary": "Select explicit or metadata-filtered plan sets and execute them sequentially in a test copy, including plans that lack retained HDF results.", "tags": [ "execution", "plan-selection" ], "difficulty": "beginner", "est_runtime": "3.0 min", "runtime_seconds": 181.8, "data_project": "Balde Eagle Creek", "thumbnail": null, "url": "../notebooks/111_executing_plan_sets.md" }, { "id": "112_sequential_plan_execution", "title": "Sequential Plan Execution", "summary": "Run dependent plans sequentially with compute_test_mode, inspect the copied project, and summarize per-plan execution outcomes.", "tags": [ "execution" ], "difficulty": "beginner", "est_runtime": "3.3 min", "runtime_seconds": 199.8, "data_project": "Balde Eagle Creek", "thumbnail": null, "url": "../notebooks/112_sequential_plan_execution.md" }, { "id": "113_parallel_execution", "title": "Parallel Execution", "summary": "run plans through RAS Commander", "tags": [ "execution", "remote" ], "difficulty": "beginner", "est_runtime": "3.3 h", "runtime_seconds": 11817.8, "data_project": null, "thumbnail": "assets/thumbs/113_parallel_execution.png", "url": "../notebooks/113_parallel_execution.md" }, { "id": "114_parameter_permutation", "title": "Parameter Permutation Sweeps with RasPermutation", "summary": "Generate Cartesian products of parameter ranges, automatically partition into batch folders (respecting the 99-plan HEC-RAS limit), execute in parallel, and collect results into audit-friendly CSV logs.", "tags": [ "sensitivity" ], "difficulty": "beginner", "est_runtime": "2.3 min", "runtime_seconds": 140.2, "data_project": null, "thumbnail": "assets/thumbs/114_parameter_permutation.png", "url": "../notebooks/114_parameter_permutation.md" }, { "id": "115_real_time_execution_monitoring", "title": "Real-Time Execution Monitoring with Callbacks", "summary": "This notebook demonstrates how to use execution callbacks for real-time monitoring of HEC-RAS plan execution.", "tags": [ "execution" ], "difficulty": "beginner", "est_runtime": "1.4 min", "runtime_seconds": 82.4, "data_project": "Muncie", "thumbnail": null, "url": "../notebooks/115_real_time_execution_monitoring.md" }, { "id": "116_hdf_output_options_benchmark", "title": "HDF Output Options Read Benchmark", "summary": "Use the `BaldEagleCrkMulti2D` example project and plan `06` to compare HDF write settings by measuring ras-commander HDF read performance after the plans have been computed.", "tags": [ "hdf" ], "difficulty": "beginner", "est_runtime": "13.8 min", "runtime_seconds": 826.4, "data_project": null, "thumbnail": null, "url": "../notebooks/116_hdf_output_options_benchmark.md" }, { "id": "117_monte_carlo_uncertainty", "title": "Monte Carlo Preparation and Ensemble Workflow", "summary": "Inspect a real model and generate parameter samples; retain an unexecuted ensemble recipe with explicit convergence and failure-handling requirements.", "tags": [ "sensitivity" ], "difficulty": "beginner", "est_runtime": "10.4 min", "runtime_seconds": 623.9, "data_project": null, "thumbnail": "assets/thumbs/117_monte_carlo_uncertainty.png", "url": "../notebooks/117_monte_carlo_uncertainty.md", "evidence_scope": "Saved outputs demonstrate model inspection and sampling only; no hydraulic ensemble or uncertainty estimate was computed." }, { "id": "120_automating_ras_with_win32com", "title": "Win32COM Automation", "summary": "Demonstrate Windows HEC-RAS GUI automation helpers for dialogs, RAS Mapper, and stored-map workflows that require an interactive desktop.", "tags": [ "windows", "gui", "rasmapper" ], "difficulty": "beginner", "est_runtime": "13 s", "runtime_seconds": 12.7, "data_project": null, "thumbnail": null, "url": "../notebooks/120_automating_ras_with_win32com.md" }, { "id": "121_legacy_hecrascontroller_and_rascontrol", "title": "HECRASController Profiles", "summary": "Use the Windows HECRASController through RasControl to execute configured legacy plans and extract steady profiles or unsteady time series.", "tags": [ "windows", "com", "legacy", "results" ], "difficulty": "beginner", "est_runtime": "2.2 min", "runtime_seconds": 129.7, "data_project": "Balde Eagle Creek", "thumbnail": "assets/thumbs/121_legacy_hecrascontroller_and_rascontrol.png", "url": "../notebooks/121_legacy_hecrascontroller_and_rascontrol.md" }, { "id": "122_rasmapper_spatial_review", "title": "RASMapper Spatial Review", "summary": "Inspect RAS Mapper layer inventories, control map views and visibility, and capture screenshots and spatial review packages.", "tags": [ "rasmapper" ], "difficulty": "beginner", "est_runtime": "1.1 min", "runtime_seconds": 64.4, "data_project": null, "thumbnail": "assets/thumbs/122_rasmapper_spatial_review.png", "url": "../notebooks/122_rasmapper_spatial_review.md" }, { "id": "123_rasmapper_geometry_layer_updates", "title": "RASMapper Geometry Layer Updates", "summary": "Apply selected native RAS Mapper geometry-layer commands across real example projects and inspect updated cross sections, structures, and storage curves.", "tags": [ "geometry", "rasmapper" ], "difficulty": "beginner", "est_runtime": "9.8 min", "runtime_seconds": 587.8, "data_project": null, "thumbnail": "assets/thumbs/123_rasmapper_geometry_layer_updates.png", "url": "../notebooks/123_rasmapper_geometry_layer_updates.md" }, { "id": "124_rasmapper_bank_lines", "title": "RASMapper Bank Lines", "summary": "Generate RAS Mapper bank lines from cross-section bank stations through a supervised Windows GUI workflow.", "tags": [ "rasmapper" ], "difficulty": "beginner", "est_runtime": "44 s", "runtime_seconds": 44.1, "data_project": null, "thumbnail": null, "url": "../notebooks/124_rasmapper_bank_lines.md" }, { "id": "125_rasmapper_stored_maps_arrival_duration", "title": "RASMapper Stored Maps: Arrival Time, Duration, and Percent Time Inundated", "summary": "`RasProcess.store_maps()` generates rendered result rasters through the HEC-RAS mapping engine (RasMapperLib via the bundled `RasStoreMapHelper.exe`). This notebook covers the whole-simulation map types added alongside the profile-based WSE, depth, and velocity products.", "tags": [ "rasmapper" ], "difficulty": "beginner", "est_runtime": null, "runtime_seconds": null, "data_project": "BaldEagleCrkMulti2D", "thumbnail": null, "url": "../notebooks/125_rasmapper_stored_maps_arrival_duration.md" }, { "id": "150_results_dataframe", "title": "Using results_df for Plan Results Summary", "summary": "This notebook demonstrates the `results_df` DataFrame, which provides lightweight HDF-based results summaries for all plans. This enables quick access to execution status, volumetric errors, compute messages, and runtime data without ope...", "tags": [ "results" ], "difficulty": "beginner", "est_runtime": "1.1 min", "runtime_seconds": 63.1, "data_project": "Muncie", "thumbnail": null, "url": "../notebooks/150_results_dataframe.md" } ] }, { "series": 200, "series_name": "Geometry & Calibration", "notebooks": [ { "id": "201_1d_plaintext_geometry", "title": "1D Geometry File Parsing", "summary": "geometry and HTAB workflows", "tags": [ "1d", "geometry" ], "difficulty": "intermediate", "est_runtime": "18 s", "runtime_seconds": 17.8, "data_project": null, "thumbnail": "assets/thumbs/201_1d_plaintext_geometry.png", "url": "../notebooks/201_1d_plaintext_geometry.md" }, { "id": "202_2d_plaintext_geometry", "title": "2D Geometry File Parsing", "summary": "This notebook demonstrates parsing and manipulating 2D geometry elements from HEC-RAS plain text geometry files, including: - Storage Area operations (BaldEagleCrkMulti2D) - SA/2D Connection operations and dam crest profiles (BaldEagleCr...", "tags": [ "2d", "geometry" ], "difficulty": "intermediate", "est_runtime": "3.7 min", "runtime_seconds": 222.7, "data_project": null, "thumbnail": "assets/thumbs/202_2d_plaintext_geometry.png", "url": "../notebooks/202_2d_plaintext_geometry.md" }, { "id": "203_htab_parameter_optimization", "title": "HTAB Parameter Optimization for Model Stability", "summary": "geometry and HTAB workflows", "tags": [ "sensitivity" ], "difficulty": "intermediate", "est_runtime": "33 s", "runtime_seconds": 33.0, "data_project": null, "thumbnail": "assets/thumbs/203_htab_parameter_optimization.png", "url": "../notebooks/203_htab_parameter_optimization.md" }, { "id": "204_culvert_gis_validation", "title": "Culvert GIS Reconstruction and Hydraulic-Validity Checks (1D)", "summary": "Reconstruct 1D culvert barrel locations from geometry, screen invert placement, and compare a pipe-to-box retrofit using computed steady profiles.", "tags": [ "1d" ], "difficulty": "intermediate", "est_runtime": "14 s", "runtime_seconds": 13.7, "data_project": null, "thumbnail": "assets/thumbs/204_culvert_gis_validation.png", "url": "../notebooks/204_culvert_gis_validation.md" }, { "id": "205_extract_xs_xyz_from_geometry", "title": "Extract Cross Section XYZ Coordinates from Plain Text Geometry", "summary": "geometry and HTAB workflows", "tags": [ "geometry" ], "difficulty": "intermediate", "est_runtime": "4 s", "runtime_seconds": 4.5, "data_project": "Muncie", "thumbnail": "assets/thumbs/205_extract_xs_xyz_from_geometry.png", "url": "../notebooks/205_extract_xs_xyz_from_geometry.md" }, { "id": "206_structures_and_metadata", "title": "Structures and Metadata from Geometry Files", "summary": "This notebook demonstrates parsing bridge, culvert, inline weir, and geometry metadata from HEC-RAS plain text geometry files, including: - GeomMetadata: Efficient geometry element counts (HDF-first with text fallback) - GeomBridge: Brid...", "tags": [ "geometry" ], "difficulty": "intermediate", "est_runtime": "4 s", "runtime_seconds": 4.3, "data_project": null, "thumbnail": "assets/thumbs/206_structures_and_metadata.png", "url": "../notebooks/206_structures_and_metadata.md" }, { "id": "207_reference_lines_and_points", "title": "Reference Lines and Points for 2D Calibration", "summary": "Author and read back reference lines and points in geometry text; prepare locations for a subsequent model run.", "tags": [ "2d", "calibration", "reference-lines", "reference-points", "geometry" ], "difficulty": "intermediate", "est_runtime": "3 s", "runtime_seconds": 3.4, "data_project": "BaldEagleCrkMulti2D", "thumbnail": null, "url": "../notebooks/207_reference_lines_and_points.md", "input_families": [ "Working geometry text", "Named line and point coordinates in model CRS" ], "operations": [ "Write reference locations", "Read geometry text back" ], "outputs": [ "Updated geometry text", "Reference location inventories" ], "runtime_requirements": [ "Python geometry authoring; solver required separately for new reference results" ], "evidence_scope": "Retained outputs demonstrate text authoring and readback, not reference hydrographs or a fresh solve." }, { "id": "208_bridge_method_comparison", "title": "Bridge Method Comparison", "summary": "Compare bridge hydraulic method selections with a real HEC-RAS bridge example and show the effect on computed WSE.", "tags": [ "bridges", "hydraulic-methods", "sensitivity" ], "difficulty": "intermediate", "est_runtime": "1.7 min", "runtime_seconds": 103.6, "data_project": null, "thumbnail": "assets/thumbs/208_bridge_method_comparison.png", "url": "../notebooks/208_bridge_method_comparison.md" }, { "id": "209_culvert_authoring", "title": "Culvert Authoring", "summary": "Write taxonomy-checked culvert records and adjacent ineffective-flow areas, inspect spatial placement, and compute an edited plan for result review.", "tags": [ "culverts", "geometry", "authoring" ], "difficulty": "intermediate", "est_runtime": "8 s", "runtime_seconds": 8.5, "data_project": null, "thumbnail": "assets/thumbs/209_culvert_authoring.png", "url": "../notebooks/209_culvert_authoring.md" }, { "id": "210_xs_interpolation_settings", "title": "Cross-Section Interpolation Settings", "summary": "Interpolate cross sections and update bank stations, station/elevation arrays, and expansion/contraction coefficients in an example geometry.", "tags": [ "cross-sections", "geometry", "interpolation" ], "difficulty": "intermediate", "est_runtime": "18 s", "runtime_seconds": 18.3, "data_project": null, "thumbnail": "assets/thumbs/210_xs_interpolation_settings.png", "url": "../notebooks/210_xs_interpolation_settings.md" }, { "id": "211_final_mannings_and_infiltration", "title": "Final Manning's N and Infiltration Analysis", "summary": "This notebook demonstrates how to extract final Manning's N and preprocessed infiltration values from a reproducible example project. It also includes a regression check for multi-ring infiltration override polygons.", "tags": [ "infiltration" ], "difficulty": "intermediate", "est_runtime": "3 s", "runtime_seconds": 2.7, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/211_final_mannings_and_infiltration.png", "url": "../notebooks/211_final_mannings_and_infiltration.md" }, { "id": "212_landcover_mannings_n_write", "title": "Native NLCD Land Cover Authoring and Controlled Manning Validation", "summary": "Author matching NLCD land-cover layers through native RASMapper APIs, change exactly two Manning classes, recompute and solve both projects, and validate final cell, face, WSE, and breach responses with explicit active-cell and regenerated-key accounting.", "tags": [ "2d", "calibration", "rasmapper" ], "difficulty": "intermediate", "est_runtime": "7.6 min", "runtime_seconds": 455.6, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/212_landcover_mannings_n_write.png", "url": "../notebooks/212_landcover_mannings_n_write.md", "input_families": [ "Copied 2D projects", "NLCD classes and geometry land-cover associations" ], "operations": [ "Author native land-cover sidecars", "Modify selected Manning classes", "Recompute and compare final values" ], "outputs": [ "Authored sidecars and geometry overrides", "Cell/face roughness, WSE, and breach comparisons" ], "runtime_requirements": [ "Windows native RASMapper dependencies and HEC-RAS; notebook config selects 7.0", "NLCD data and writable project copies" ], "evidence_scope": "The notebook retains controlled authoring and response comparisons for its selected models/classes; they do not qualify every land-cover or runtime combination." }, { "id": "213_land_classification_polygon_authoring", "title": "Native Land Classification Polygon Authoring", "summary": "Add, update, list, and delete existing-class land-cover polygons through native RASMapper, reject unsupported multipart and interior-ring inputs before mutation, and verify final Manning, WSE, association, backup, and breach behavior.", "tags": [ "2d", "rasmapper" ], "difficulty": "intermediate", "est_runtime": "6.7 min", "runtime_seconds": 402.0, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/213_land_classification_polygon_authoring.png", "url": "../notebooks/213_land_classification_polygon_authoring.md" }, { "id": "214_connection_authoring", "title": "SA/2D Connection Authoring", "summary": "Create, inspect, delete, and re-create SA/2D area connections in a real HEC-RAS geometry file. This notebook demonstrates an engineering-oriented workflow for the `Dam` connection in `BaldEagleDamBrk.g13`:", "tags": [ "2d" ], "difficulty": "intermediate", "est_runtime": "10 s", "runtime_seconds": 9.9, "data_project": null, "thumbnail": "assets/thumbs/214_connection_authoring.png", "url": "../notebooks/214_connection_authoring.md" }, { "id": "215_sa2d_bridge_connection_authoring", "title": "SA/2D Bridge Connection Authoring", "summary": "Read, modify, and round-trip bridge connection sub-records (routing type 32, `Conn BR:` blocks) in a HEC-RAS geometry file. This notebook demonstrates the bridge-specific API on `BaldEagleDamBrk.g03`, which contains 7 bridge connections...", "tags": [ "2d" ], "difficulty": "intermediate", "est_runtime": "21 s", "runtime_seconds": 20.6, "data_project": null, "thumbnail": "assets/thumbs/215_sa2d_bridge_connection_authoring.png", "url": "../notebooks/215_sa2d_bridge_connection_authoring.md" }, { "id": "216_1d_bridge_authoring", "title": "1D Bridge Authoring", "summary": "Author bridge decks, piers, abutments, coefficients, approach sections, and HTAB settings; read back the geometry and inspect computed messages/results.", "tags": [ "1d" ], "difficulty": "intermediate", "est_runtime": "4 s", "runtime_seconds": 4.4, "data_project": null, "thumbnail": "assets/thumbs/216_1d_bridge_authoring.png", "url": "../notebooks/216_1d_bridge_authoring.md" }, { "id": "217_1d_levee_authoring", "title": "1D Cross-Section Levee Authoring", "summary": "Read, modify, insert, and remove cross-section levee station-elevation data in a real HEC-RAS geometry file, then run the unsteady simulation on the modified geometry and verify results extraction from the HDF output.", "tags": [ "1d" ], "difficulty": "intermediate", "est_runtime": "2.4 min", "runtime_seconds": 142.3, "data_project": "Balde Eagle Creek", "thumbnail": "assets/thumbs/217_1d_levee_authoring.png", "url": "../notebooks/217_1d_levee_authoring.md" }, { "id": "218_infiltration_base_override_authoring", "title": "Native Infiltration Base and Region Override Authoring", "summary": "Create native infiltration override regions, edit geometry-wide Base Overrides and one named regional parameter table through RASMapper, then verify spatial attribution in final geometry and plan infiltration arrays and hydraulic results.", "tags": [ "2d", "infiltration", "rasmapper" ], "difficulty": "intermediate", "est_runtime": "16.8 min", "runtime_seconds": 1007.8, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/218_infiltration_base_override_authoring.png", "url": "../notebooks/218_infiltration_base_override_authoring.md" }, { "id": "219_1d_bridge_xs_plotting", "title": "1D Bridge Cross-Section Plotting with Deck/Pier Overlay", "summary": "HEC-RAS 1D bridges use four cross-sections:", "tags": [ "1d" ], "difficulty": "intermediate", "est_runtime": "5 s", "runtime_seconds": 4.7, "data_project": "Bridge Hydraulics", "thumbnail": "assets/thumbs/219_1d_bridge_xs_plotting.png", "url": "../notebooks/219_1d_bridge_xs_plotting.md" }, { "id": "220_calibration_workflow", "title": "Manning's n Calibration with RasCalibrate", "summary": "`RasCalibrate` provides parameter estimation workflows for HEC-RAS models, composing `RasPermutation`, HDF extraction helpers, and statistical metrics into a streamlined calibration API.", "tags": [ "calibration" ], "difficulty": "intermediate", "est_runtime": "8 s", "runtime_seconds": 8.3, "data_project": null, "thumbnail": "assets/thumbs/220_calibration_workflow.png", "url": "../notebooks/220_calibration_workflow.md", "input_families": [ "Real 2D model", "Declared observation or synthetic-target dataset", "Parameter bounds" ], "operations": [ "Evaluate objectives", "Search Manning parameters", "Compare event diagnostics" ], "outputs": [ "Objective values and parameter candidates", "Modeled/target comparisons" ], "runtime_requirements": [ "Scientific Python stack", "Installed HEC-RAS required when RUN_HECRAS is enabled; configured default 6.6" ], "evidence_scope": "The execution switch and target provenance determine what a run establishes. Synthetic targets demonstrate estimation mechanics, not observational validation." }, { "id": "221_calibration_1d_workflow", "title": "1D Manning's N Calibration Workflow", "summary": "Demonstrates automated Manning's n calibration for a 1D HEC-RAS unsteady model using the `RasCalibrate` module with `grid_search()` and `optimize()`.", "tags": [ "1d", "calibration" ], "difficulty": "intermediate", "est_runtime": "18.0 min", "runtime_seconds": 1078.5, "data_project": "Example 24 - Mannings-n-Calibration", "thumbnail": "assets/thumbs/221_calibration_1d_workflow.png", "url": "../notebooks/221_calibration_1d_workflow.md" }, { "id": "222_steady_flow_calibration", "title": "Steady Flow Calibration", "summary": "Demonstrate steady-flow Manning roughness estimation against a synthetic observed WSE profile; inspect objective values without treating the target as field validation.", "tags": [ "calibration", "steady" ], "difficulty": "intermediate", "est_runtime": "44 s", "runtime_seconds": 43.7, "data_project": null, "thumbnail": "assets/thumbs/222_steady_flow_calibration.png", "url": "../notebooks/222_steady_flow_calibration.md" }, { "id": "224_steady_flow_authoring", "title": "Steady Flow Authoring", "summary": "Create, read, and update steady-flow files with profile discharges and typed boundary conditions, then inspect HEC-RAS execution messages.", "tags": [ "steady" ], "difficulty": "intermediate", "est_runtime": "12 s", "runtime_seconds": 11.8, "data_project": null, "thumbnail": null, "url": "../notebooks/224_steady_flow_authoring.md", "input_families": [ "Real steady-flow project", "Profile discharges and typed downstream boundaries" ], "operations": [ "Create and update steady-flow files", "Read back authored records", "Compute and inspect messages" ], "outputs": [ "Steady-flow files and linked plan inputs", "Readback and execution diagnostics" ], "runtime_requirements": [ "Python for text authoring", "Installed HEC-RAS for the notebook computation stage" ], "evidence_scope": "Text roundtrip and native computation are distinct checks; this example does not qualify floodway encroachment authoring." }, { "id": "225_fixit_blocked_obstructions", "title": "Fixing Blocked Obstruction Overlaps with RasFixit", "summary": "This notebook demonstrates using the `RasFixit` module to automatically detect and repair overlapping blocked obstructions in HEC-RAS geometry files.", "tags": [ "geometry", "repair", "blocked-obstructions" ], "difficulty": "intermediate", "est_runtime": "7 s", "runtime_seconds": 7.1, "data_project": null, "thumbnail": "assets/thumbs/225_fixit_blocked_obstructions.png", "url": "../notebooks/225_fixit_blocked_obstructions.md" }, { "id": "226_2d_connection_culvert_invert_validation", "title": "2D Connection Culvert Invert Validation (Terrain Cell Minimum)", "summary": "Compare proposed and authored SA/2D culvert inverts with terrain-derived mesh-cell minima and visualize placement along the connection.", "tags": [ "2d", "terrain" ], "difficulty": "intermediate", "est_runtime": "32 s", "runtime_seconds": 32.5, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/226_2d_connection_culvert_invert_validation.png", "url": "../notebooks/226_2d_connection_culvert_invert_validation.md" }, { "id": "227_2d_connection_culvert_authoring", "title": "Authoring a 2D Connection Culvert (`Connection Culv=`)", "summary": "Author a culvert in a previously weir-only SA/2D connection, read back Connection Culv records, and review placement and native acceptance.", "tags": [ "2d" ], "difficulty": "intermediate", "est_runtime": "22 s", "runtime_seconds": 22.3, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/227_2d_connection_culvert_authoring.png", "url": "../notebooks/227_2d_connection_culvert_authoring.md" }, { "id": "228_mannings_n_from_nlcd", "title": "Manning's n from NLCD Validation", "summary": "Validate `ManningsFromLandCover` on the real `BaldEagleCrkMulti2D` RasExamples project. The workflow compares the existing 1D geometry Manning's n blocks against automated NLCD-derived horizontal variation, checks the project RAS Mapper...", "tags": [ "roughness", "land-cover", "cross-sections" ], "difficulty": "intermediate", "est_runtime": "2.3 min", "runtime_seconds": 135.2, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/228_mannings_n_from_nlcd.png", "url": "../notebooks/228_mannings_n_from_nlcd.md" }, { "id": "229_model_extent_polygons", "title": "Model Extent Polygons (1D, 2D, and Overall Footprints)", "summary": "extract 2D flow-area perimeters, generate 1D river edge lines and reach footprints, combine them into the true model extent, and compare 1D-only, 2D-only, and legacy bounding-box geometries for Bald Eagle Creek and Muncie", "tags": [ "1d", "2d" ], "difficulty": "intermediate", "est_runtime": "7 s", "runtime_seconds": 6.9, "data_project": null, "thumbnail": "assets/thumbs/229_model_extent_polygons.png", "url": "../notebooks/229_model_extent_polygons.md" }, { "id": "230_mesh_sensitivity_analysis", "title": "2D Mesh Cell-Size Sensitivity for Sediment Transport", "summary": "**Model:** Chippewa River 2D (`Chippewa_2D`, HEC's *2D Sediment Transport* example suite, plan *\"100ft Sediment\"*)", "tags": [ "2d", "sensitivity" ], "difficulty": "intermediate", "est_runtime": "3.5 min", "runtime_seconds": 207.1, "data_project": null, "thumbnail": "assets/thumbs/230_mesh_sensitivity_analysis.png", "url": "../notebooks/230_mesh_sensitivity_analysis.md" }, { "id": "231_pipe_network_mesh_generation", "title": "Headless Mesh Generation: Pipe Networks and Refinement Regions", "summary": "Headlessly regenerate a pipe-connected Davis mesh, then author and visually verify a 40-foot refinement region on the Chippewa 2D fixture.", "tags": [ "2d", "mesh", "refinement-regions", "pipes" ], "difficulty": "intermediate", "est_runtime": "8 s", "runtime_seconds": 7.8, "data_project": "Chippewa_2D", "thumbnail": "assets/thumbs/231_pipe_network_mesh_generation.png", "url": "../notebooks/231_pipe_network_mesh_generation.md" }, { "id": "232_weise_2d_sediment_mesh_sensitivity", "title": "2D Mesh Cell-Size Sensitivity for Sediment Transport - Second Case: Weise Flume", "summary": "**Model:** Weise 2D (`Weise_2D`, HEC's *2D Sediment Transport* example suite, plan *\"Weise\"*)", "tags": [ "2d", "sensitivity" ], "difficulty": "intermediate", "est_runtime": "16.7 min", "runtime_seconds": 1001.4, "data_project": null, "thumbnail": "assets/thumbs/232_weise_2d_sediment_mesh_sensitivity.png", "url": "../notebooks/232_weise_2d_sediment_mesh_sensitivity.md" }, { "id": "233_mannings_region_polygon_authoring", "title": "Manning's n Region Polygon Authoring and Solver Validation", "summary": "Author a regional Manning's n polygon on the real Muncie fixture, explicitly associate terrain and land cover, validate the temporary and final plan HDF cell values, and visually confirm solver propagation.", "tags": [ "2d", "mannings-n", "land-cover", "rasmapper", "preprocessing", "validation" ], "difficulty": "advanced", "est_runtime": "1 min", "runtime_seconds": 48.9, "data_project": "Muncie", "thumbnail": "assets/thumbs/233_mannings_region_polygon_authoring.png", "url": "../notebooks/233_mannings_region_polygon_authoring.md" }, { "id": "234_rasmapper_geometry_completion", "title": "Headless RASMapper Geometry Completion (Edge Lines, Interpolation Surface, Flow Paths)", "summary": "Generate the RASMapper-derived geometry layers in-process via pythonnet - river edge lines, the cross-section interpolation surface, and flow path lines - read each one back, surface per-cross-section validation diagnostics, and audit stored 1D reach lengths against freshly recomputed flow lengths on a throwaway copy of the project.", "tags": [ "1d" ], "difficulty": "advanced", "est_runtime": "29 s", "runtime_seconds": 29.0, "data_project": null, "thumbnail": "assets/thumbs/234_rasmapper_geometry_completion.png", "url": "../notebooks/234_rasmapper_geometry_completion.md" }, { "id": "235_1d_breakout_model", "title": "Clip a Texas FEMA eBFE Model to One NWM Reach", "summary": "Classify real NOAA NWM v3 reaches against the Shiloh Branch eBFE footprint, retain 10% upstream and 25% downstream hydraulic buffers around feature 5790868, rasterize a stricter one-cross-section-overlap export domain, and compare the independent breakout to the source model.", "tags": [ "1d", "steady", "breakout", "ebfe", "nwm", "conflation", "raster", "boundary-effects", "validation" ], "difficulty": "advanced", "est_runtime": "1 min", "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/235_1d_breakout_model.md", "input_families": [ "Real 1D source project", "NOAA NWM edge and selected hydraulic/export domains" ], "operations": [ "Select a reach slice", "Assemble an independent breakout", "Compare retained geometry and results" ], "outputs": [ "Standalone HEC-RAS project", "Selection provenance and comparison evidence" ], "runtime_requirements": [ "Source eBFE model and NWM network data", "Windows/native geometry dependencies and HEC-RAS; notebook config selects 7.0" ], "evidence_scope": "Checks apply to the selected Shiloh Branch edge and retained sections; domain and boundary adequacy require review for a new extraction." }, { "id": "236_multi_model_1d_breakout_planning", "title": "Build a Texas FEMA eBFE Breakout from Adjacent Main-Stem Models", "summary": "Catalog and join two adjacent Walnut Creek FEMA eBFE main-stem projects for NOAA NWM feature 5790954, write an independent restationed HEC-RAS project, retain source-block provenance, and visually verify the centerline seam, computational/export domains, two-pass flow-path finalization, inherited geometry diagnostics, and retained-section hydraulic response against both original plans.", "tags": [ "1d", "steady", "breakout", "ebfe", "nwm", "conflation", "multi-model", "geoparquet", "validation" ], "difficulty": "advanced", "est_runtime": "50 s", "runtime_seconds": 41.5, "data_project": null, "thumbnail": "assets/thumbs/236_multi_model_1d_breakout_planning.png", "url": "../notebooks/236_multi_model_1d_breakout_planning.md" } ] }, { "series": 300, "series_name": "Unsteady & DSS", "notebooks": [ { "id": "300_unsteady_flow_operations", "title": "Unsteady Flow Operations", "summary": "Inspect and edit unsteady boundary tables, clone flow and plan files, scale hydrographs, and compare computed cross-section water levels.", "tags": [ "steady", "unsteady" ], "difficulty": "intermediate", "est_runtime": "26 s", "runtime_seconds": 25.9, "data_project": "Dam Breaching", "thumbnail": "assets/thumbs/300_unsteady_flow_operations.png", "url": "../notebooks/300_unsteady_flow_operations.md" }, { "id": "301_flow_hydrograph_optimization", "title": "Flow Hydrograph Optimization", "summary": "Configure native flow-hydrograph optimization, inspect trial results, and compare the optimized hydrograph and WSE; retain a separate multiplier-search fallback.", "tags": [ "sensitivity" ], "difficulty": "intermediate", "est_runtime": "1.0 min", "runtime_seconds": 60.9, "data_project": null, "thumbnail": "assets/thumbs/301_flow_hydrograph_optimization.png", "url": "../notebooks/301_flow_hydrograph_optimization.md" }, { "id": "310_dss_boundary_extraction", "title": "DSS Boundary Extraction", "summary": "from ras_commander import *", "tags": [ "dss" ], "difficulty": "intermediate", "est_runtime": "5 s", "runtime_seconds": 5.4, "data_project": null, "thumbnail": "assets/thumbs/310_dss_boundary_extraction.png", "url": "../notebooks/310_dss_boundary_extraction.md" }, { "id": "312_boundary_df_qmult_dss_paths", "title": "Boundary DataFrame Enhancement: QMult, QMin, and DSS Path Parsing", "summary": "DSS boundary workflows", "tags": [ "dss" ], "difficulty": "intermediate", "est_runtime": "49 s", "runtime_seconds": 49.2, "data_project": "Muncie", "thumbnail": null, "url": "../notebooks/312_boundary_df_qmult_dss_paths.md" }, { "id": "313_hms_to_ras_boundary_matching", "title": "HMS-to-RAS Boundary Condition Matching", "summary": "This notebook demonstrates **correlation-based matching** between HEC-HMS DSS hydrograph outputs and HEC-RAS boundary condition locations using the **BaldEagleCrkMulti2D** example project.", "tags": [ "dss", "boundary-conditions", "hms", "hydrographs" ], "difficulty": "intermediate", "est_runtime": "5 s", "runtime_seconds": 5.4, "data_project": null, "thumbnail": "assets/thumbs/313_hms_to_ras_boundary_matching.png", "url": "../notebooks/313_hms_to_ras_boundary_matching.md" }, { "id": "314_reference_line_generation", "title": "Breakline-Derived Reference Lines And USGS Gauge Points", "summary": "Generate transverse reference lines and gauge points, compute a working plan, and batch plot recorded line hydrographs alongside nearest-cell gauge samples.", "tags": [ "2d", "usgs", "reference-lines", "reference-points", "hydrographs", "batch-plotting" ], "difficulty": "intermediate", "est_runtime": "3.6 min", "runtime_seconds": 216.8, "data_project": null, "thumbnail": "assets/thumbs/314_reference_line_generation.png", "url": "../notebooks/314_reference_line_generation.md", "input_families": [ "Working 2D project and channel-aligned breaklines", "USGS gauge locations" ], "operations": [ "Generate and author reference locations", "Preprocess and compute a plan", "Plot recorded line hydrographs and nearest-cell gauge WSE" ], "outputs": [ "Authored reference geometry", "Computed plan results", "Line hydrograph and gauge sample figures" ], "runtime_requirements": [ "Configured HEC-RAS execution runtime", "Gauge discovery network access" ], "evidence_scope": "Retained outputs show the demonstrated run. Gauge WSE plots use nearest-cell sampling, not solver-recorded reference-point hydrographs; generated lines still require engineering review." }, { "id": "315_2d_computation_options", "title": "2D Computation Options", "summary": "Clone 2D plans with typed computation options, run scenario plans, and compare HDF settings, stability messages, and maximum WSE.", "tags": [ "2d" ], "difficulty": "intermediate", "est_runtime": "1.7 min", "runtime_seconds": 103.1, "data_project": null, "thumbnail": "assets/thumbs/315_2d_computation_options.png", "url": "../notebooks/315_2d_computation_options.md" }, { "id": "316_terrain_modifications", "title": "Terrain Modifications: High-Ground and Polygon Writer Validation", "summary": "This notebook validates ras-commander terrain modification writers with a real HEC-RAS example project. It creates copied terrain sidecar modifications for high-ground lines, boundary-sampled polygon multipoint grading, and `shape_z` pol...", "tags": [ "terrain" ], "difficulty": "intermediate", "est_runtime": "2.9 min", "runtime_seconds": 174.8, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/316_terrain_modifications.png", "url": "../notebooks/316_terrain_modifications.md" }, { "id": "317_restart_file_settings", "title": "Restart File Output and Warm-Start Settings", "summary": "This notebook validates the restart-file API split used by warm-start workflows:", "tags": [ "restart", "initial-conditions", "unsteady" ], "difficulty": "intermediate", "est_runtime": "24 s", "runtime_seconds": 24.1, "data_project": null, "thumbnail": "assets/thumbs/317_restart_file_settings.png", "url": "../notebooks/317_restart_file_settings.md" }, { "id": "318_validating_dss_paths", "title": "Validating DSS File Paths and Data Availability", "summary": "DSS boundary workflows", "tags": [ "dss" ], "difficulty": "intermediate", "est_runtime": "4 s", "runtime_seconds": 4.0, "data_project": null, "thumbnail": null, "url": "../notebooks/318_validating_dss_paths.md" }, { "id": "319_post_fire_debris_flow_nonnewtonian", "title": "Post-fire debris-flow 2D modeling, built from scratch (non-Newtonian)", "summary": "This example builds a **complete 2D HEC-RAS debris-flow model from nothing** — no starting project — and runs a clear-water baseline plus **Bingham non-Newtonian** mud/debris-flow variants, then derives hazard-intensity and arrival-time...", "tags": [ "2d" ], "difficulty": "intermediate", "est_runtime": "6.3 min", "runtime_seconds": 377.5, "data_project": null, "thumbnail": "assets/thumbs/319_post_fire_debris_flow_nonnewtonian.png", "url": "../notebooks/319_post_fire_debris_flow_nonnewtonian.md" }, { "id": "320_1d_boundary_condition_visualization", "title": "1D Boundary Condition Visualization", "summary": "This notebook demonstrates how to extract and visualize 1D boundary conditions from a HEC-RAS project. The workflow:", "tags": [ "1d" ], "difficulty": "intermediate", "est_runtime": "5 s", "runtime_seconds": 4.9, "data_project": null, "thumbnail": null, "url": "../notebooks/320_1d_boundary_condition_visualization.md" } ] }, { "series": 400, "series_name": "HDF Results", "notebooks": [ { "id": "400_1d_hdf_data_extraction", "title": "1D HDF Data Extraction", "summary": "Read 1D unsteady HDF geometry and results, including cross-section time series, storage curves, structures, runtime, and volume accounting.", "tags": [ "1d", "hdf" ], "difficulty": "intermediate", "est_runtime": "1.6 min", "runtime_seconds": 98.4, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/400_1d_hdf_data_extraction.png", "url": "../notebooks/400_1d_hdf_data_extraction.md", "input_families": [ "1D unsteady plan-result HDF", "Geometry HDF or geometry embedded in results" ], "operations": [ "Read cross-section and structure results", "Inspect runtime and volume accounting" ], "outputs": [ "xarray cross-section Dataset", "Spatial geometry and tabular diagnostics" ], "runtime_requirements": [ "Python HDF/geospatial dependencies", "Retained compatible result HDF; no solver required for read-only extraction" ], "evidence_scope": "Dataset presence and extraction establish readable stored results, not freshness or hydraulic acceptance." }, { "id": "401_steady_flow_analysis", "title": "Steady Flow Analysis", "summary": "Read steady HDF profile names, WSE arrays, messages, and metadata; select profiles by name or index and compare their longitudinal elevations.", "tags": [ "steady" ], "difficulty": "intermediate", "est_runtime": "5.8 min", "runtime_seconds": 347.7, "data_project": null, "thumbnail": "assets/thumbs/401_steady_flow_analysis.png", "url": "../notebooks/401_steady_flow_analysis.md", "input_families": [ "1D steady plan-result HDF" ], "operations": [ "List and select steady profiles", "Extract and compare WSE" ], "outputs": [ "Profile-indexed water-surface arrays", "Steady metadata and plots" ], "runtime_requirements": [ "Python HDF dependencies for reading", "Installed HEC-RAS for the notebook initial example computation" ], "evidence_scope": "Steady profiles are separate from unsteady time series; the example comparisons do not establish model calibration." }, { "id": "410_2d_hdf_data_extraction", "title": "2D HDF Data Extraction", "summary": "HDF mesh and results extraction", "tags": [ "2d", "hdf" ], "difficulty": "intermediate", "est_runtime": "19 s", "runtime_seconds": 19.3, "data_project": null, "thumbnail": "assets/thumbs/410_2d_hdf_data_extraction.png", "url": "../notebooks/410_2d_hdf_data_extraction.md", "input_families": [ "2D geometry and unsteady result HDFs" ], "operations": [ "Query mesh cells/faces and result variables", "Inspect time series and maximum values" ], "outputs": [ "GeoDataFrames", "DataArray/Dataset results indexed by mesh-local cell or face IDs" ], "runtime_requirements": [ "Python HDF, xarray, and geospatial dependencies", "Requested output variables must exist in retained HDFs" ], "evidence_scope": "Stored maxima, instantaneous time series, geometry, and derived quantities have different meanings; missing optional output is not zero." }, { "id": "411_2d_hdf_pipes_and_pumps", "title": "Pipes and Pumps", "summary": "Extract pipe-network and pump geometry/time series from HDF results and inspect pipe flow and velocity along profile lines.", "tags": [ "2d", "hdf" ], "difficulty": "intermediate", "est_runtime": "3.3 min", "runtime_seconds": 195.9, "data_project": null, "thumbnail": "assets/thumbs/411_2d_hdf_pipes_and_pumps.png", "url": "../notebooks/411_2d_hdf_pipes_and_pumps.md" }, { "id": "412_2d_detail_face_data_extraction", "title": "2D Face Data Extraction", "summary": "HDF mesh and results extraction", "tags": [ "2d" ], "difficulty": "intermediate", "est_runtime": "3.1 min", "runtime_seconds": 187.6, "data_project": null, "thumbnail": "assets/thumbs/412_2d_detail_face_data_extraction.png", "url": "../notebooks/412_2d_detail_face_data_extraction.md" }, { "id": "413_profile_line_flow_extraction", "title": "Profile Line Flow Extraction", "summary": "Extract named-line flow series and peaks; distinguish native-associated hydrographs of unqualified provenance from face-flow aggregation.", "tags": [ "2d", "hdf", "profile-lines", "reference-lines", "flow", "hydrographs" ], "difficulty": "intermediate", "est_runtime": "3 s", "runtime_seconds": 3.3, "data_project": null, "thumbnail": "assets/thumbs/413_profile_line_flow_extraction.png", "url": "../notebooks/413_profile_line_flow_extraction.md", "input_families": [ "Completed plan HDF and matching geometry", "Named profile-line layer or geometry reference line" ], "operations": [ "Extract named-line flow time series", "Find sampled peak and inspect face-flow comparison" ], "outputs": [ "Flow series with selection provenance", "Peak-flow summary and comparison plot" ], "runtime_requirements": [ "Current canonical API requires pythonnet and compatible RasMapperLib", "External Chippewa fixture described in notebook" ], "evidence_scope": "Saved outputs retain a historical six-face reconstruction, not current native qualification. The native fixture uses seven faces with substantially different flow. Native-associated hydrograph provenance remains unqualified; absolute hydrograph values and summed absolute face flows are different quantities." }, { "id": "414_depth_varying_mannings_n", "title": "Controlled Depth-Varying Manning's n for HEC-RAS 2D Linux Solves", "summary": "Experimental, non-production comparison of baseline, table-extension control, and depth-varying-Manning scenarios in the single tested HEC-RAS 7.0 April 2026 Windows-preprocess/Linux-solve temporary-HDF workflow; all other versions and workflows are untested.", "tags": [ "2d", "hdf" ], "difficulty": "intermediate", "est_runtime": "5.4 min", "runtime_seconds": 321.2, "data_project": null, "thumbnail": "assets/thumbs/414_depth_varying_mannings_n.png", "url": "../notebooks/414_depth_varying_mannings_n.md" }, { "id": "415_2d_spatial_result_queries", "title": "2D Spatial Result Queries with HdfResultsQuery", "summary": "Query water surface elevation, depth, and velocity at arbitrary (x,y) coordinates, extract profiles along transects, compute flood extent with engineering filters, and generate domain-wide statistics -- all using scipy KDTree spatial ind...", "tags": [ "2d", "hdf", "results" ], "difficulty": "intermediate", "est_runtime": "6.0 min", "runtime_seconds": 360.8, "data_project": null, "thumbnail": "assets/thumbs/415_2d_spatial_result_queries.png", "url": "../notebooks/415_2d_spatial_result_queries.md" }, { "id": "416_2d_velocity_profile_line", "title": "2D Velocity Profile Line Extraction", "summary": "Sample native RASMapper velocity, depth and terrain along a polyline at one saved time; distinguish station profiles from recorded reference hydrographs.", "tags": [ "2d", "profile-lines", "rasmapper", "velocity", "terrain" ], "difficulty": "intermediate", "est_runtime": "15 s", "runtime_seconds": 15.3, "data_project": null, "thumbnail": "assets/thumbs/416_2d_velocity_profile_line.png", "url": "../notebooks/416_2d_velocity_profile_line.md", "input_families": [ "Completed 2D plan HDF and matching geometry", "RAS terrain HDF and line coordinates" ], "operations": [ "Select a saved result time", "Query a native station-wise velocity profile" ], "outputs": [ "Station/profile table", "Velocity, depth and terrain figure" ], "runtime_requirements": [ "pythonnet and compatible installed RasMapperLib", "Matching RAS terrain and geometry" ], "evidence_scope": "Retained example output illustrates a single-time station profile, not line-integrated discharge or solver-recorded reference output; this editorial update does not requalify native execution." }, { "id": "417_inspect_results_and_generate_hydraulic_products", "title": "Inspecting Results and Generating Hydraulic Product Packages", "summary": "Read and mechanically inspect an existing completed HEC-RAS result HDF, then generate and independently verify a checksum-pinned COG, Arrow/Parquet, GeoJSON, JSON, and PNG derivative package without modifying the producer HDF or generating model output.", "tags": [ "hdf", "results", "parquet", "cloud-native" ], "difficulty": "intermediate", "est_runtime": "5 s", "runtime_seconds": 5.4, "data_project": null, "thumbnail": null, "url": "../notebooks/417_inspect_results_and_generate_hydraulic_products.md", "input_families": [ "Existing completed unsteady HEC-RAS result HDF" ], "operations": [ "Inspect result identity and completeness", "Export and independently check derivative products" ], "outputs": [ "Checksum-pinned COG, Arrow/Parquet, GeoJSON, JSON, and PNG package" ], "runtime_requirements": [ "Python export/geospatial dependencies", "Retained result HDF with required geometry, CRS, units, and outputs; no solver run" ], "evidence_scope": "Mechanical inspection and derivative verification do not modify the producer HDF or establish hydraulic acceptance." }, { "id": "420_breach_results_extraction", "title": "Dam Breach Results", "summary": "Read breach geometry and hydrographs, clone width and formation-time scenarios, execute the plans, and compare peak flow and breach evolution.", "tags": [ "breach", "results" ], "difficulty": "intermediate", "est_runtime": "2.9 min", "runtime_seconds": 172.1, "data_project": null, "thumbnail": null, "url": "../notebooks/420_breach_results_extraction.md" }, { "id": "430_1d_channel_capacity_analysis", "title": "1D Channel Capacity Analysis", "summary": "This notebook demonstrates the `HdfChannelCapacity` class for analyzing 1D channel capacity using WSE results and bank station elevations. Channel capacity is determined by comparing water surface elevations from multiple AEP storm profi...", "tags": [ "1d" ], "difficulty": "intermediate", "est_runtime": "1.3 min", "runtime_seconds": 77.8, "data_project": null, "thumbnail": null, "url": "../notebooks/430_1d_channel_capacity_analysis.md" } ] }, { "series": 500, "series_name": "Remote Execution", "notebooks": [ { "id": "500_remote_execution_psexec", "title": "Remote Execution with ras-commander", "summary": "This notebook demonstrates how to execute HEC-RAS plans using: 1. **Local parallel execution** - `RasCmdr.compute_parallel()` on your local machine 2. **Remote execution** - `compute_parallel_remote()` on remote machines via PsExec/Docker", "tags": [ "execution", "remote" ], "difficulty": "advanced", "est_runtime": "8.7 min", "runtime_seconds": 524.6, "data_project": null, "thumbnail": null, "url": "../notebooks/500_remote_execution_psexec.md" }, { "id": "510_linux_execution", "title": "Linux Execution of HEC-RAS with ras-commander", "summary": "This notebook demonstrates how to execute HEC-RAS simulations on Linux servers using `RasCmdr.compute_plan_linux()`. This enables scalable, headless execution on cloud VMs, Proxmox containers, Docker, or any Linux host with the HEC-RAS L...", "tags": [ "execution" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/510_linux_execution.md" }, { "id": "511_headless_linux_wine_ras2cng", "title": "Headless Linux/Wine/Ras2Cng Setup and Qualification", "summary": "Set up an isolated Linux task that uses official HEC-RAS Linux executables where supported and the same Windows HEC-RAS version under Wine only for RasProcess/RASMapper gaps and ras2cng stored-map export. This is a qualification workflow...", "tags": [ "cloud-native", "execution", "linux", "ras2cng", "wine" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/511_headless_linux_wine_ras2cng.md" }, { "id": "512_docker_precompute_and_linux_compute", "title": "Docker Precompute and Native Linux Compute", "summary": "Run the same two Python calls on Windows or Linux: first prepare a HEC-RAS plan with the Wine container, then execute the matching native Linux unsteady container. Both containers use [ras-commander](https://rascommander.info/ras/) APIs...", "tags": [ "execution", "remote" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/512_docker_precompute_and_linux_compute.md" }, { "id": "560_modpuls_routing_extraction", "title": "Modified Puls Routing Extraction from HEC-RAS 2D Models", "summary": "> **⚠️ BETA**: `RasModPuls` and this notebook are currently **beta** and have not yet been > validated in production. The workflow, API, and outputs may change in future releases. > We welcome feedback from third-party users looking to v...", "tags": [ "2d" ], "difficulty": "advanced", "est_runtime": "3.5 min", "runtime_seconds": 207.9, "data_project": null, "thumbnail": "assets/thumbs/560_modpuls_routing_extraction.png", "url": "../notebooks/560_modpuls_routing_extraction.md" } ] }, { "series": 600, "series_name": "Floodplain Mapping", "notebooks": [ { "id": "600_floodplain_mapping_gui", "title": "Floodplain Mapping via GUI Automation", "summary": "This notebook demonstrates floodplain mapping using **HEC-RAS GUI automation** to generate: - Maximum Water Surface Elevation (WSE) rasters - Maximum Depth rasters", "tags": [ "floodplain-mapping", "rasmapper", "gui" ], "difficulty": "intermediate", "est_runtime": "19.5 min", "runtime_seconds": 1168.6, "data_project": null, "thumbnail": "assets/thumbs/600_floodplain_mapping_gui.png", "url": "../notebooks/600_floodplain_mapping_gui.md" }, { "id": "601_headless_stored_map_generation_rasmapper", "title": "Headless Stored Map Generation Using RasMapper", "summary": "This notebook demonstrates headless stored map generation using **RasMapper** through RasProcess.store_maps() to create maximum WSE rasters, maximum depth rasters, and inundation boundary polygons.", "tags": [ "rasmapper" ], "difficulty": "intermediate", "est_runtime": "6.1 min", "runtime_seconds": 365.4, "data_project": null, "thumbnail": "assets/thumbs/601_headless_stored_map_generation_rasmapper.png", "url": "../notebooks/601_headless_stored_map_generation_rasmapper.md" }, { "id": "610_generate_fluvial_pluvial_delineations_max_wse_arrival_time", "title": "Generate Fluvial Pluvial Delineations using Max WSE Arrival Time", "summary": "Use differences in time of maximum 2D WSE to derive draft fluvial/pluvial transition lines and polygons for interpretation and map review.", "tags": [ "2d", "flood-source-screening", "gis" ], "difficulty": "intermediate", "est_runtime": "16.8 min", "runtime_seconds": 1009.2, "data_project": null, "thumbnail": "assets/thumbs/610_generate_fluvial_pluvial_delineations_max_wse_arrival_time.png", "url": "../notebooks/610_generate_fluvial_pluvial_delineations_max_wse_arrival_time.md" }, { "id": "611_validating_map_layers", "title": "Validating RAS Mapper Layers and Terrain Files", "summary": "Discover registered RAS Mapper layers and screen their format, CRS, raster metadata, spatial extent, and terrain/land-cover associations.", "tags": [ "terrain" ], "difficulty": "intermediate", "est_runtime": "9 s", "runtime_seconds": 9.0, "data_project": null, "thumbnail": "assets/thumbs/611_validating_map_layers.png", "url": "../notebooks/611_validating_map_layers.md" }, { "id": "612_benefit_area_analysis", "title": "Benefit-area mapping for storm-system alternatives", "summary": "This example builds and computes HEC-RAS 7.0 conduit, second-pump, and combined alternatives, compares hydraulic performance, and maps categorical benefits, adverse depth increases, and building-footprint exposure.", "tags": [ "benefit-area", "depth", "stormwater", "gis" ], "difficulty": "intermediate", "est_runtime": "1.3 min", "runtime_seconds": 76.2, "data_project": "Davis", "thumbnail": "assets/thumbs/612_benefit_area_analysis.png", "url": "../notebooks/612_benefit_area_analysis.md", "input_families": [ "Storm-system baseline and alternative projects", "Comparable stored Depth rasters" ], "operations": [ "Author pipe/pump alternatives", "Compute and compare benefits and adverse depth changes" ], "outputs": [ "BenefitArea rasters and polygons", "Hydraulic comparisons and adverse-depth screens" ], "runtime_requirements": [ "Installed HEC-RAS and native stored-map tooling", "Geospatial raster dependencies and writable model copies" ], "evidence_scope": "Benefit categories use declared depth thresholds and aligned pre/post rasters; no qualifying benefit does not imply no physical change." } ] }, { "series": 700, "series_name": "Sensitivity & Precipitation", "notebooks": [ { "id": "700_core_sensitivity", "title": "Core Sensitivity Testing with results_df", "summary": "This notebook demonstrates **processor core sensitivity analysis** for HEC-RAS 2D unsteady flow models. Understanding how computational performance scales with available CPU cores is essential for:", "tags": [ "results", "sensitivity" ], "difficulty": "intermediate", "est_runtime": "17.0 min", "runtime_seconds": 1019.8, "data_project": null, "thumbnail": "assets/thumbs/700_core_sensitivity.png", "url": "../notebooks/700_core_sensitivity.md" }, { "id": "701_benchmarking_versions_6.1_to_6.6", "title": "Version Benchmarking and Core Scaling (HEC-RAS 5.0.5, 6.0, 6.3.1, 6.6, 7.0)", "summary": "Benchmark one 2D plan across selected HEC-RAS versions and core counts; compare execution time, speedup, continuity diagnostics, and completion evidence.", "tags": [ "benchmarking", "execution", "version-comparison" ], "difficulty": "intermediate", "est_runtime": "2 s", "runtime_seconds": 1.8, "data_project": null, "thumbnail": null, "url": "../notebooks/701_benchmarking_versions_6.1_to_6.6.md" }, { "id": "710_mannings_sensitivity_bulk_analysis", "title": "Manning's n Bulk Sensitivity Analysis", "summary": "This notebook demonstrates **bulk Manning's n sensitivity analysis** for HEC-RAS 2D models with spatially variable roughness. The workflow:", "tags": [ "sensitivity" ], "difficulty": "intermediate", "est_runtime": "2.7 min", "runtime_seconds": 163.6, "data_project": null, "thumbnail": "assets/thumbs/710_mannings_sensitivity_bulk_analysis.png", "url": "../notebooks/710_mannings_sensitivity_bulk_analysis.md" }, { "id": "711_mannings_sensitivity_multi_interval", "title": "One-at-a-Time (OAT) Manning's n Sensitivity Analysis", "summary": "This notebook performs a one-at-a-time Manning's n sensitivity analysis on the Muncie 2D example project using GeomLandCover edits, local parallel execution, preprocessed cell roughness propagation QA, and POI max-WSE sensitivity plots.", "tags": [ "sensitivity" ], "difficulty": "intermediate", "est_runtime": "26.9 min", "runtime_seconds": 1614.0, "data_project": null, "thumbnail": "assets/thumbs/711_mannings_sensitivity_multi_interval.png", "url": "../notebooks/711_mannings_sensitivity_multi_interval.md" }, { "id": "720_precipitation_methods_comprehensive", "title": "Precipitation Hyetograph Generation - Complete Method Comparison", "summary": "precipitation methods", "tags": [ "precipitation" ], "difficulty": "intermediate", "est_runtime": "16 s", "runtime_seconds": 15.8, "data_project": null, "thumbnail": "assets/thumbs/720_precipitation_methods_comprehensive.png", "url": "../notebooks/720_precipitation_methods_comprehensive.md", "input_families": [ "NOAA Atlas 14 depth-duration information", "Declared storm duration and temporal distribution" ], "operations": [ "Compare precipitation temporal methods" ], "outputs": [ "Hyetographs and comparison plots" ], "runtime_requirements": [ "Python precipitation dependencies", "Network or cached precipitation source data; optional StormGenerator sections depend on availability" ], "evidence_scope": "Method comparison demonstrates temporal construction; it does not select a locally appropriate design storm or prove delivery to a hydraulic solver." }, { "id": "721_precipitation_hyetograph_comparison", "title": "Precipitation Hyetograph Comparison", "summary": "Generate and read back 30 precipitation patterns; verify intended, written and native accumulated rainfall in two bounded HEC-RAS 7.0 Davis runs.", "tags": [ "precipitation" ], "difficulty": "intermediate", "est_runtime": "13.2 min", "runtime_seconds": 792.0, "data_project": null, "thumbnail": "assets/thumbs/721_precipitation_hyetograph_comparison.png", "url": "../notebooks/721_precipitation_hyetograph_comparison.md", "evidence_scope": "All 30 patterns are authored and read back. Two hourly HEC-RAS 7.0 Davis runs verify native precipitation across 2,705 rainfall-receiving cells and 217 times; other versions, SI units, fixed-start boundaries, sub-hourly intervals and hydraulic acceptance remain unqualified." }, { "id": "722_gridded_precipitation_atlas14", "title": "Gridded Precipitation with Atlas 14: Current Workflow", "summary": "Migration guide to the implemented Atlas 14 workflow in notebook 727, with capability lookup and links to GeoTIFF, MRMS, and HRRR examples. Retires obsolete placeholder APIs and raw meteorology edits.", "tags": [ "2d", "precipitation" ], "difficulty": "intermediate", "est_runtime": "1.1 min", "runtime_seconds": 64.3, "data_project": null, "thumbnail": "assets/thumbs/722_gridded_precipitation_atlas14.png", "url": "../notebooks/722_gridded_precipitation_atlas14.md" }, { "id": "723_storm_generator_abm_validation", "title": "StormGenerator Alternating Block Method - Independent Textbook Validation", "summary": "Compare StormGenerator alternating-block hyetographs with an independent reference calculation and optional HMS storm classes; check depth conservation and temporal placement.", "tags": [ "precipitation", "design-storms", "abm" ], "difficulty": "intermediate", "est_runtime": "5 s", "runtime_seconds": 5.4, "data_project": null, "thumbnail": "assets/thumbs/723_storm_generator_abm_validation.png", "url": "../notebooks/723_storm_generator_abm_validation.md" }, { "id": "725_atlas14_spatial_variance", "title": "Atlas 14 Spatial Variance Analysis", "summary": "precipitation methods", "tags": [ "precipitation" ], "difficulty": "intermediate", "est_runtime": "1.3 min", "runtime_seconds": 75.3, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/725_atlas14_spatial_variance.png", "url": "../notebooks/725_atlas14_spatial_variance.md" }, { "id": "726_abm_hyetograph_grid", "title": "Gridded ABM Hyetograph Generation", "summary": "Generate spatial ABM design-storm interval depths in CF NetCDF and identify the separate HEC-RAS conversion and qualification steps.", "tags": [ "precipitation" ], "difficulty": "intermediate", "est_runtime": "2.4 min", "runtime_seconds": 143.6, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/726_abm_hyetograph_grid.png", "url": "../notebooks/726_abm_hyetograph_grid.md" }, { "id": "727_atlas14_gridded_rain_on_grid_hecras", "title": "Atlas 14 Gridded Design Storm Rain-on-Grid in HEC-RAS", "summary": "Convert spatial NOAA Atlas 14 depths to projected ABM rain-on-grid forcing, execute controlled no-rain, spatial, and equivalent-uniform Bald Eagle HEC-RAS scenarios, and quantify the modeled hydraulic response.", "tags": [ "2d", "unsteady", "precipitation" ], "difficulty": "advanced", "est_runtime": "17 min", "runtime_seconds": 987.7, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/727_atlas14_gridded_rain_on_grid_hecras.png", "url": "../notebooks/727_atlas14_gridded_rain_on_grid_hecras.md" }, { "id": "728_extend_gridded_dss_forcing_window", "title": "Extending Gridded DSS Forcing Through the Simulation Window", "summary": "preserve and extend a model-covering gridded DSS family with three explicit dry intervals, then verify temporary/final HDF forcing, a HEC-RAS 7.0 compute, the dry-tail plateau, active-cell agreement, runtime diagnostics, and hydraulic results on Bald Eagle Creek", "tags": [ "dss", "precipitation" ], "difficulty": "intermediate", "est_runtime": "1 min", "runtime_seconds": 75.4, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/728_extend_gridded_dss_forcing_window.png", "url": "../notebooks/728_extend_gridded_dss_forcing_window.md" }, { "id": "729_direct_geotiff_gridded_rain_on_grid", "title": "Direct GeoTIFF Gridded Rain-on-Grid", "summary": "Author projected precipitation GeoTIFFs, validate temporary plan-HDF rainfall, compute Bald Eagle, and inspect final rainfall and hydraulics", "tags": [ "precipitation", "geotiff", "rain-on-grid", "validation" ], "difficulty": "intermediate", "est_runtime": "39 s", "runtime_seconds": 39.3, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/729_direct_geotiff_gridded_rain_on_grid.png", "url": "../notebooks/729_direct_geotiff_gridded_rain_on_grid.md" }, { "id": "730_raster_processing_performance_profiling", "title": "Raster Processing Performance Profiling", "summary": "Measure stored-map and VRT-to-GeoTIFF configurations, graph CPU, memory, throughput, and IOPS tradeoffs, and write an HTML decision report from a copied HEC-RAS project.", "tags": [ "performance", "raster", "rasmapper", "terrain", "profiling" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/730_raster_processing_performance_profiling.md" }, { "id": "731_atlas14_shared_temporal_existing_model", "title": "Atlas 14 Shared Temporal Pattern for an Existing Model", "summary": "Apply a shared NOAA temporal curve to an existing model footprint, validate native rainfall NetCDF, export Float32 intervals with explicit bilinear SHG conversion, and optionally configure a staged model copy without computing.", "tags": [ "precipitation" ], "difficulty": "intermediate", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/731_atlas14_shared_temporal_existing_model.md" } ] }, { "series": 800, "series_name": "Quality Assurance", "notebooks": [ { "id": "800_quality_assurance_rascheck", "title": "Quality Assurance with RasCheck", "summary": "This notebook demonstrates how to use the RasCheck module for validating HEC-RAS steady flow models using **multiple example projects** to show different validation scenarios.", "tags": [ "quality-assurance", "steady", "diagnostics" ], "difficulty": "advanced", "est_runtime": "17 s", "runtime_seconds": 16.5, "data_project": "ProjectName", "thumbnail": "assets/thumbs/800_quality_assurance_rascheck.png", "url": "../notebooks/800_quality_assurance_rascheck.md", "input_families": [ "Computed steady-flow example projects" ], "operations": [ "Run RasCheck diagnostics", "Review messages and thresholds" ], "outputs": [ "CheckResults messages", "Tabular/HTML review outputs" ], "runtime_requirements": [ "Python HDF dependencies", "Installed HEC-RAS for example computation when needed" ], "evidence_scope": "Diagnostics support review and may have incomplete dataset coverage. Floodway authoring/checking remains experimental; empty messages are not a compliance finding." }, { "id": "801_advanced_structure_validation", "title": "Advanced Structure Validation with RasCheck", "summary": "This notebook demonstrates the **advanced structure validation features** added to RasCheck in December 2025:", "tags": [ "quality-assurance", "structures", "steady" ], "difficulty": "advanced", "est_runtime": "5 s", "runtime_seconds": 4.5, "data_project": null, "thumbnail": null, "url": "../notebooks/801_advanced_structure_validation.md" } ] }, { "series": 900, "series_name": "Data Integration", "notebooks": [ { "id": "900_aorc_precipitation", "title": "AORC Precipitation for HEC-RAS Rain-on-Grid Models", "summary": "This notebook demonstrates a complete workflow for using NOAA's Analysis of Record for Calibration (AORC) gridded precipitation data with HEC-RAS 2D rain-on-grid models, including data-driven simulation buffer selection based on observed...", "tags": [ "precipitation" ], "difficulty": "advanced", "est_runtime": "4.8 min", "runtime_seconds": 288.1, "data_project": null, "thumbnail": "assets/thumbs/900_aorc_precipitation.png", "url": "../notebooks/900_aorc_precipitation.md" }, { "id": "901_aorc_precipitation_catalog", "title": "AORC Precipitation Catalog for HEC-RAS Rain-on-Grid Models", "summary": "This notebook demonstrates a complete workflow for using NOAA's Analysis of Record for Calibration (AORC) gridded precipitation data with HEC-RAS 2D rain-on-grid models.", "tags": [ "precipitation" ], "difficulty": "advanced", "est_runtime": "3.1 min", "runtime_seconds": 186.4, "data_project": null, "thumbnail": "assets/thumbs/901_aorc_precipitation_catalog.png", "url": "../notebooks/901_aorc_precipitation_catalog.md" }, { "id": "910_usgs_gauge_catalog", "title": "USGS Gauge Catalog Generation", "summary": "gauge, validation, forecast, and coastal boundary workflows", "tags": [ "usgs" ], "difficulty": "advanced", "est_runtime": "7.3 min", "runtime_seconds": 439.6, "data_project": null, "thumbnail": "assets/thumbs/910_usgs_gauge_catalog.png", "url": "../notebooks/910_usgs_gauge_catalog.md" }, { "id": "911_usgs_gauge_data_integration", "title": "USGS Gauge Data Integration for HEC-RAS", "summary": "This notebook demonstrates how to integrate USGS gauge data with HEC-RAS models using the `ras_commander.usgs` submodule.", "tags": [ "usgs" ], "difficulty": "advanced", "est_runtime": "32 s", "runtime_seconds": 32.0, "data_project": null, "thumbnail": "assets/thumbs/911_usgs_gauge_data_integration.png", "url": "../notebooks/911_usgs_gauge_data_integration.md" }, { "id": "912_usgs_real_time_monitoring", "title": "USGS Real-Time Gauge Monitoring", "summary": "Inspect a real model domain with live USGS station metadata and illustrate monitoring APIs; distinguish the refreshed map from historical monitoring outputs.", "tags": [ "usgs" ], "difficulty": "advanced", "est_runtime": "2.8 min", "runtime_seconds": 165.8, "data_project": null, "thumbnail": "assets/thumbs/912_usgs_real_time_monitoring.png", "url": "../notebooks/912_usgs_real_time_monitoring.md", "evidence_scope": "Current saved setup/map output uses real HDF geometry and successful USGS station metadata. Later monitoring outputs retain their historical configuration and were not rerun." }, { "id": "913_bc_generation_from_live_gauge", "title": "Boundary Condition Generation from Live USGS Gauge Data", "summary": "This example demonstrates how to generate HEC-RAS boundary conditions from real-time USGS gauge data. We'll use the Bald Eagle Creek model and create a flow hydrograph boundary condition from live gauge readings with drainage area scaling.", "tags": [ "usgs" ], "difficulty": "advanced", "est_runtime": "3 s", "runtime_seconds": 3.2, "data_project": null, "thumbnail": null, "url": "../notebooks/913_bc_generation_from_live_gauge.md" }, { "id": "914_historical_event_validation", "title": "Historical AORC Event Diagnostic Comparison with USGS Stage", "summary": "execute an archived 48-hour AORC rain-on-grid event under HEC-RAS 7.0, verify source precipitation through durable, temporary, and final HDFs, inspect runtime and hydraulic results, and compare timezone-correct USGS stage as a diagnostic rather than calibration validation", "tags": [ "2d", "aorc", "hdf", "precipitation", "usgs" ], "difficulty": "advanced", "est_runtime": "5 min", "runtime_seconds": 35.3, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/914_historical_event_validation.png", "url": "../notebooks/914_historical_event_validation.md" }, { "id": "915_realtime_forecast_workflow", "title": "Operational Forecast Orchestration and Readiness", "summary": "build a deterministic timezone-explicit forecast-cycle manifest, inspect current public API signatures, and visually audit the executed HRRR, STOFS-3D, MRMS, and WPC component artifacts without claiming a duplicate model compute or independent format/version qualification", "tags": [ "forecast", "operations", "precipitation", "qaqc" ], "difficulty": "advanced", "est_runtime": "5 s", "runtime_seconds": 2.2, "data_project": null, "thumbnail": "assets/thumbs/915_realtime_forecast_workflow.png", "url": "../notebooks/915_realtime_forecast_workflow.md" }, { "id": "916_hrrr_precipitation_forecast", "title": "HRRR Forecast to HEC-RAS: Executed Rain-on-Grid Qualification", "summary": "reproduce an archived 8 August 2024 15Z HRRR event as 18 hourly native DSS grids, verify source-to-DSS-to-temporary-and-final-HDF forcing, compare no-rain and forecast hydraulics under HEC-RAS 7.0, and map localized convergence exceptions for manual review", "tags": [ "2d", "dss", "forecast", "hdf", "precipitation" ], "difficulty": "advanced", "est_runtime": "4.2 min", "runtime_seconds": 250.6, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/916_hrrr_precipitation_forecast.png", "url": "../notebooks/916_hrrr_precipitation_forecast.md" }, { "id": "917_mrms_precipitation_qpe", "title": "MRMS QPE Boundary-Hyetograph Hydraulic Comparison", "summary": "Align archived MRMS interval ends with the model clock, write uniform precipitation boundaries, and inspect complete native cumulative rainfall histories and baseline/event hydraulic diagnostics for Davis and New Orleans.", "tags": [ "2d", "dss", "hdf", "precipitation" ], "difficulty": "advanced", "est_runtime": "5.3 min", "runtime_seconds": 318.4, "data_project": null, "thumbnail": "assets/thumbs/917_mrms_precipitation_qpe.png", "url": "../notebooks/917_mrms_precipitation_qpe.md", "input_families": [ "Archived hourly MRMS MultiSensor QPE Pass2 GRIB2", "Davis and New Orleans Metro RasExamples projects" ], "operations": [ "Audit source units, absolute times and spatial support", "Author and read back uniform precipitation boundaries", "Compare baseline/event native cumulative rainfall and hydraulic diagnostics" ], "outputs": [ "Source and serialized rainfall tables", "Native computation receipts and cumulative rainfall comparisons", "Diagnostic maps, pump plots and animations" ], "runtime_requirements": [ "Windows with HEC-RAS 7.0 for native computation", "HEC-Vortex and RasDss Java dependencies; archived MRMS downloads or cache", "ffmpeg for animations" ], "evidence_scope": "Four hourly US-customary HEC-RAS 7.0 baseline/event runs verify complete cumulative rainfall histories at 505 times across 2,705 Davis cells and 361 times across 19,711 New Orleans cells. Saved outputs inspect retained runs and regenerate diagnostic figures; the gallery runtime covers inspection/rendering only. Native run durations are recorded separately. Uniform boundaries follow simulation start; spatial rain-on-grid, other configurations and hydraulic acceptance remain unqualified. Follow-ups: issues 398, 438, 440 and 441." }, { "id": "918_hms_ras_coupled_forecast", "title": "HMS-RAS Coupled Forecast Execution", "summary": "illustrate the HMS-to-RAS handoff pattern with a synthetic outlet hydrograph and printed templates for HMS execution, inline or DSS boundary writes, plan-date alignment, and optional HEC-RAS execution; no coupled models are run", "tags": [ "execution" ], "difficulty": "advanced", "est_runtime": "11 s", "runtime_seconds": 10.8, "data_project": null, "thumbnail": null, "url": "../notebooks/918_hms_ras_coupled_forecast.md" }, { "id": "919_operational_forecast_cycling", "title": "Operational Forecast Cycling", "summary": "compare four deterministic synthetic QPF cycles with routed flow and rating-curve stage estimates, plot crest convergence and flood-threshold exceedance, and dry-run RAS-ready cycle metadata with optional execution hooks", "tags": [ "forecasting", "synthetic-forcing", "workflow" ], "difficulty": "advanced", "est_runtime": "5 s", "runtime_seconds": 4.7, "data_project": null, "thumbnail": "assets/thumbs/919_operational_forecast_cycling.png", "url": "../notebooks/919_operational_forecast_cycling.md" }, { "id": "920_terrain_creation", "title": "Creating a RAS Terrain with ras-commander", "summary": "terrain and geometry surface workflows", "tags": [ "terrain" ], "difficulty": "advanced", "est_runtime": "12 s", "runtime_seconds": 11.6, "data_project": null, "thumbnail": "assets/thumbs/920_terrain_creation.png", "url": "../notebooks/920_terrain_creation.md" }, { "id": "921_usgs_study_package_from_primitives", "title": "USGS Study Package From Primitives", "summary": "This notebook demonstrates the composable primitives in `ras_commander.usgs` for USGS gauge study assembly.", "tags": [ "usgs" ], "difficulty": "advanced", "est_runtime": "13 s", "runtime_seconds": 13.3, "data_project": null, "thumbnail": null, "url": "../notebooks/921_usgs_study_package_from_primitives.md" }, { "id": "922_model_validation_with_usgs", "title": "Model Comparison with USGS Gauge Data", "summary": "Compare delivered Kalamazoo HDF water levels with 276 matched USGS gauge observations; retain provenance, metrics, initialization error and calibration-comparison limits.", "tags": [ "usgs", "calibration", "hdf", "comparison" ], "difficulty": "advanced", "est_runtime": "9 s", "runtime_seconds": 9.1, "data_project": null, "thumbnail": "assets/thumbs/922_model_validation_with_usgs.png", "url": "../notebooks/922_model_validation_with_usgs.md", "input_families": [ "Delivered Kalamazoo HDF reference-point water levels", "USGS gauge observations for the matched period" ], "operations": [ "Align units and time references", "Calculate observation comparisons with provenance" ], "outputs": [ "Matched series and comparison metrics", "Recorded initialization/calibration limitations" ], "runtime_requirements": [ "Python HDF and USGS dependencies", "Retained model artifacts and gauge data or network access; no new solver run in the repaired comparison" ], "evidence_scope": "Retained evidence covers 276 matched observations. Initialization failed and a distinct calibrated run was unavailable; no before/after calibration improvement is claimed." }, { "id": "923_stofs3d_coastal_boundary", "title": "STOFS-3D Coastal Water Levels: Units and Datum", "summary": "Extract an archived NOAA station time series with explicit datum metadata, compare feet and meters, and distinguish source inspection from experimental stage authoring.", "tags": [ "coastal", "stofs", "datum", "boundary-conditions" ], "difficulty": "advanced", "est_runtime": "3 s", "runtime_seconds": 2.8, "data_project": null, "thumbnail": "assets/thumbs/923_stofs3d_coastal_boundary.png", "url": "../notebooks/923_stofs3d_coastal_boundary.md" }, { "id": "924_mrms_netcdf_rain_on_grid", "title": "MRMS NetCDF Rain-on-Grid Validation", "summary": "MRMS QPE workflows, including direct NetCDF rain-on-grid validation", "tags": [ "precipitation" ], "difficulty": "advanced", "est_runtime": "59 s", "runtime_seconds": 58.7, "data_project": null, "thumbnail": "assets/thumbs/924_mrms_netcdf_rain_on_grid.png", "url": "../notebooks/924_mrms_netcdf_rain_on_grid.md" }, { "id": "925_xs_interpolation_surface", "title": "Cross-Section Interpolation Surface", "summary": "Build cross-section TIN interpolation surfaces from real geometry, write spatial review layers and optional rasters, and compare channel-only and full-extent surfaces.", "tags": [ "terrain", "cross-sections", "interpolation" ], "difficulty": "advanced", "est_runtime": "6 s", "runtime_seconds": 6.4, "data_project": "Muncie", "thumbnail": "assets/thumbs/925_xs_interpolation_surface.png", "url": "../notebooks/925_xs_interpolation_surface.md" }, { "id": "926_wpc_qpf_precipitation_forecast", "title": "WPC QPF DSS-to-HEC-RAS Rain-on-Grid Qualification", "summary": "qualify a complete current WPC forecast through verified native-projection GRIB crops, 28 DSS grids, temporary and final HDF forcing, no-rain/event HEC-RAS 7.0 simulations, hydraulic response, mapped convergence exceptions, and explicit manual review", "tags": [ "dss", "forecast", "precipitation" ], "difficulty": "advanced", "est_runtime": "22 s", "runtime_seconds": 22.3, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/926_wpc_qpf_precipitation_forecast.png", "url": "../notebooks/926_wpc_qpf_precipitation_forecast.md" }, { "id": "930_terrain_modification_analysis", "title": "Terrain Modification Analysis", "summary": "write and verify a channel terrain modification in the Bald Eagle Creek example, then use the optional GDAL bridge to report terrain extent and sample the modified profile and polygon elevation-volume curve; no baseline or modified hydraulic plans are run", "tags": [ "terrain" ], "difficulty": "advanced", "est_runtime": "15 s", "runtime_seconds": 15.3, "data_project": "BaldEagleCrkMulti2D", "thumbnail": "assets/thumbs/930_terrain_modification_analysis.png", "url": "../notebooks/930_terrain_modification_analysis.md" }, { "id": "931_native_rasmapper_terrain_export", "title": "Native RAS Mapper Terrain Export", "summary": "export a registered, stitched RAS Mapper terrain to one bounded and semantically validated GeoTIFF, then inspect its typed result, source inventory, receipt, grid alignment, and visual evidence", "tags": [ "rasmapper", "terrain" ], "difficulty": "advanced", "est_runtime": "3 s", "runtime_seconds": 3.4, "data_project": "Muncie", "thumbnail": "assets/thumbs/931_native_rasmapper_terrain_export.png", "url": "../notebooks/931_native_rasmapper_terrain_export.md" } ] }, { "series": 950, "series_name": "eBFE Delivery Validation", "notebooks": [ { "id": "950_ebfe_spring_creek", "title": "Using eBFE Models: Spring Creek 2D Analysis", "summary": "FEMA eBFE/BLE organization and validation", "tags": [ "2d", "ebfe" ], "difficulty": "advanced", "est_runtime": "4 s", "runtime_seconds": 3.6, "data_project": null, "thumbnail": null, "url": "../notebooks/950_ebfe_spring_creek.md", "input_families": [ "FEMA eBFE/BLE archive and delivered model files" ], "operations": [ "Organize project files", "Inspect boundaries, geometry, and delivered results" ], "outputs": [ "Organized project inventory", "Data availability and model-review outputs" ], "runtime_requirements": [ "Archive download/cache and Python HDF/geospatial dependencies", "Installed HEC-RAS only for the optional geometry-preprocessor stage" ], "evidence_scope": "Delivered-result inspection is distinct from newly executed model verification; RUN_GEOMETRY_PREPROCESSOR defaults to False." }, { "id": "951_ebfe_north_galveston_bay", "title": "Using eBFE Models: North Galveston Bay HMS + RAS Integration", "summary": "Organize a compound North Galveston Bay HMS/RAS delivery and inspect its model paths; file discovery does not establish executable coupling.", "tags": [ "ebfe" ], "difficulty": "advanced", "est_runtime": "3 s", "runtime_seconds": 3.3, "data_project": null, "thumbnail": null, "url": "../notebooks/951_ebfe_north_galveston_bay.md" }, { "id": "952_ebfe_upper_guadalupe_cascade", "title": "Using eBFE Models: Upper Guadalupe Cascaded Watersheds", "summary": "This notebook demonstrates working with cascaded watershed models from FEMA eBFE/BLE database.", "tags": [ "ebfe" ], "difficulty": "advanced", "est_runtime": "12 s", "runtime_seconds": 11.7, "data_project": null, "thumbnail": null, "url": "../notebooks/952_ebfe_upper_guadalupe_cascade.md" }, { "id": "953_ebfe_rio_hondo_steady_collection", "title": "Using eBFE Models: Rio Hondo 1D Steady Collection", "summary": "This notebook demonstrates the Rio Hondo (`13060008`) eBFE/BLE 1D steady model collection. The delivery is different from the large 2D eBFE examples: it contains hundreds of small 1D steady HEC-RAS projects, and results HDF files are gen...", "tags": [ "1d", "ebfe", "steady" ], "difficulty": "advanced", "est_runtime": "9 s", "runtime_seconds": 8.9, "data_project": null, "thumbnail": null, "url": "../notebooks/953_ebfe_rio_hondo_steady_collection.md" }, { "id": "954_ebfe_lake_maurepas_validation", "title": "Using eBFE Models: Lake Maurepas Validation", "summary": "This notebook validates the organized Lake Maurepas eBFE delivery format. It is intentionally scoped to the delivery-readiness gate: organize the source archive, confirm ras-commander can initialize the local HEC-RAS project, review the...", "tags": [ "ebfe" ], "difficulty": "advanced", "est_runtime": "3 s", "runtime_seconds": 3.4, "data_project": null, "thumbnail": null, "url": "../notebooks/954_ebfe_lake_maurepas_validation.md" }, { "id": "955_ebfe_tickfaw_validation", "title": "Using eBFE Models: Tickfaw Results-Ready Validation", "summary": "This notebook validates the organized Tickfaw eBFE delivery as a full 2D example with source-provided result HDFs. It confirms local organization, reviews the saved ras-commander geometry-preprocessor evidence, and checks that plan resul...", "tags": [ "ebfe", "results" ], "difficulty": "advanced", "est_runtime": "3 s", "runtime_seconds": 3.3, "data_project": null, "thumbnail": null, "url": "../notebooks/955_ebfe_tickfaw_validation.md" }, { "id": "956_hydrofabric_conflation_visual_qa", "title": "NextGen Hydrofabric Conflation Visual QA — Texas eBFE Shiloh Branch", "summary": "Visually audits generic HEC-RAS-to-network conflation with the NextGen v2.2 adapter on the Texas Lower Colorado-Cummins SHILOH BRANCH model, including native flowpath and catchment IDs, candidate ranks, score components, explicit resolution states, HUC intersections, and cross-section measures.", "tags": [ "1d", "ebfe", "geometry", "hydrofabric", "nextgen", "qa" ], "difficulty": "advanced", "est_runtime": "5 min", "runtime_seconds": 5.0, "data_project": null, "thumbnail": "assets/thumbs/956_hydrofabric_conflation_visual_qa.png", "url": "../notebooks/956_hydrofabric_conflation_visual_qa.md" }, { "id": "957_ebfe_spring_river_validation", "title": "Using eBFE Models: Spring River Validation", "summary": "This notebook validates the organized Spring River eBFE delivery as a results-ready HEC-RAS 6.1 example. It uses the shared delivery workspace, reviews the saved audit evidence, optionally executes a fresh geometry-preprocessor validatio...", "tags": [ "ebfe" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/957_ebfe_spring_river_validation.md" }, { "id": "958_model_sources_showcase", "title": "Model Sources: Unified Discovery, Download & Visualization", "summary": "Discover and download representative models from several public catalogs, initialize each project, and optionally capture native RAS Mapper review images.", "tags": [ "model-sources", "catalog", "rasmapper" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/958_model_sources_showcase.md" }, { "id": "959_ebfe_2d_breakout_geometry_preparation", "title": "Austin Bayou SH 35 2D Breakout and NextGen Validation", "summary": "Inspect the Austin Bayou completed child, conflate a NextGen reach, author external boundaries, and review a parent-derived flow ladder and focused parent/child comparison.", "tags": [ "2d", "breakout", "ebfe", "geometry", "mesh", "nextgen", "boundary-conditions", "validation" ], "difficulty": "advanced", "est_runtime": "3.2 min", "runtime_seconds": 189.3, "data_project": "AustinBayouSH35Firehose", "thumbnail": "assets/thumbs/959_ebfe_2d_breakout_geometry_preparation.png", "url": "../notebooks/959_ebfe_2d_breakout_geometry_preparation.md", "input_families": [ "Public Austin Bayou SH35 completed child fixture", "Optional organized Austin–Oyster parent model and retained results", "NextGen v2.2 flowpaths" ], "operations": [ "Inspect native boundary-face ownership", "Conflate and screen the reach-derived domain", "Author external boundaries in isolated copies", "Build parent-derived flow plateaus and review diagnostics" ], "outputs": [ "Boundary and domain evidence", "Flow-ladder plans and retained hydraulic diagnostics", "Focused parent/child gauge-location comparison" ], "runtime_requirements": [ "Installed compatible HEC-RAS for native preprocessing and new solves", "Organized parent required for optional parent-derived checks; not downloaded automatically" ], "evidence_scope": "Retained child and focused hydraulic diagnostics demonstrate the stated example. Compact constant-flow domain omits tributary inflow and does not substitute for watershed-preserving rainfall modeling or complete engineering validation." } ] }, { "series": 960, "series_name": "Cloud-Native Export", "notebooks": [ { "id": "960_cloud_native_geometry_export", "title": "Cloud-Native Geometry Export with ras2cng", "summary": "cloud-native export with `ras2cng`", "tags": [ "cloud-native", "geometry" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/960_cloud_native_geometry_export.md" }, { "id": "961_cloud_native_results_export", "title": "Cloud-Native Results Export with ras2cng", "summary": "Export HEC-RAS simulation results to cloud-native GeoParquet, build interactive flood depth maps, and generate PMTiles for web deployment using [ras2cng](https://github.com/gpt-cmdr/ras2cng).", "tags": [ "cloud-native", "results" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": null, "url": "../notebooks/961_cloud_native_results_export.md" }, { "id": "962_cloud_native_cog_results_export", "title": "Cloud Optimized GeoTIFF Results Export with ras2cng", "summary": "cloud-native export with `ras2cng`", "tags": [ "cloud-native", "results" ], "difficulty": "advanced", "est_runtime": null, "runtime_seconds": null, "data_project": null, "thumbnail": "assets/thumbs/962_cloud_native_cog_results_export.png", "url": "../notebooks/962_cloud_native_cog_results_export.md", "input_families": [ "Computed 2D result HDF and geometry" ], "operations": [ "Prepare example results", "Export cloud-native raster results with ras2cng" ], "outputs": [ "COG result rasters and export metadata" ], "runtime_requirements": [ "ras2cng and raster dependencies", "Installed HEC-RAS for the example compute stage; configured version 6.6" ], "evidence_scope": "Exported products reflect the selected producer results and options; product generation alone does not establish hydraulic quality." }, { "id": "963_froude_shear_timestep_maps", "title": "Froude and shear-stress maps at selected timesteps", "summary": "Configure and compute a copied Muncie plan, export maximum and selected-timestep Froude and bed-shear-stress GeoTIFFs, verify their HDF sources and georeferencing, and visually review the real hydraulic outputs.", "tags": [ "2d", "results", "raster", "froude", "shear-stress", "qaqc" ], "difficulty": "advanced", "est_runtime": "2-3 minutes", "runtime_seconds": 104.5, "data_project": null, "thumbnail": "assets/thumbs/963_froude_shear_timestep_maps.png", "url": "../notebooks/963_froude_shear_timestep_maps.md" } ] } ] }