Docs/applications guide#116
Conversation
…ed editing the Dams chapter (05).
- Created citations - Updated figure and table references - Updated links
…C/RMC-Software-Documentation into docs/applications-guide
-added citations -added links to other sections of the app guide and other docs
- citation edits - links added
…C/RMC-Software-Documentation into docs/applications-guide
- text edits
-updated figures for better resolution
…o match Woody's QC of Validation Studies - Added HEC-RAS citation to Introduction mention in step 8 - Added NSI Documentation hyperlink - Capitilized titles in occ type table - Added three dots, checkbox, and unchecked inline images - Added comment regarding whether breach/non-breach should be updated to fail(ure)/non-fail(ure) MMC/RMC terminology
…C/RMC-Software-Documentation into docs/applications-guide
…C/RMC-Software-Documentation into docs/applications-guide
…C/RMC-Software-Documentation into docs/applications-guide
…C/RMC-Software-Documentation into docs/applications-guide
…ges and turn the page on
…-levees-and-floodwalls - Created and added acronym appendix - Italicized file names - Gave the MMC an hyperlink to their "About Us" page
…laude's findings.
…C/RMC-Software-Documentation into docs/applications-guide
github-actions
Bot
added
the
stage:needs-lane
|
Branch @usace-rmc/docs-admin please apply the correct |
AdamGohs
added
the
lane:new-doc
github-actions
Bot
removed
the
stage:needs-lane
|
📋 Assigned reviewers for this PR
The first approval from any assigned reviewer at the current stage advances the PR. Approvals from non-assigned reviewers are logged but do not advance the stage. |
|
📋 Lane set to new doc. Moving to peer review. @usace-rmc/docs-admin please assign the peer reviewer(s). |
|
📄 Preview deployed for commit https://usace-rmc.github.io/RMC-Software-Documentation-Previews/pr-116/ This preview updates automatically when new commits are pushed. Deleted when the PR closes. |
|
🔄 New commits pushed by @AdamGohs. @karenmai-usace — please backcheck the revisions for Peer reviewer(s). |
…/v1.0/figures/hisusie.png
|
🔄 New commits pushed by @AdamGohs. @karenmai-usace — please backcheck the revisions for Peer reviewer(s). |
|
🔄 New commits pushed by @AdamGohs. @karenmai-usace — please backcheck the revisions for Peer reviewer(s). |
github-actions
Bot
added
stage:lead-civil-review
|
✅ Peer review approved by @karenmai-usace. Advancing to RMC Lead Civil review. @usace-rmc/docs-admin please assign the Lead Civil reviewer(s) via the Reviewers sidebar. The Lead Civil reviews on the preview URL. |
Resolves a conflict in src/pages/desktop-applications/lifesim.js by adopting main's centralized docConfig pattern from PR #117. Flipped the LifeSim Applications Guide entry in src/docConfig.js to active:true so the doc renders on the PR-116 preview during review (previously encoded inline as active:true on this branch). Brings in the baseUrl fix from PR #120 so figures, captions, and references on the preview resolve against the preview baseUrl instead of production.
|
🔄 New commits pushed by @AdamGohs. @Gman-1789 — please backcheck the revisions for Lead Civil reviewer(s). |
Gman-1789
left a comment
Gman-1789
left a comment
There was a problem hiding this comment.
I reviewed in detail through section 4. A couple overarching thoughts got repeated in several places. 1) this guide should not reproduce the user's manual, technical reference manual or MMC guidance. Take out all the stuff that shows you how to do something and assume they have it figure out or provide a link/reference to the relevant section of the other manual. 2) The main purpose of the document should be to show "what to watch out for" and how you did a specific type of study. What makes it unique? how did you deviate from generic practices to meet the study needs? That is the most valuable addition. 3) I think we need some insight into developing the hydraulics for each case. -OR- if this manual is just for consequence modelers, at least show them how to recognize when the hydraulics are bad, missing critical scenarios, or pointless to run.
| @@ -17,33 +23,34 @@ | |||
|
|
|||
| # Preface | |||
There was a problem hiding this comment.
clicking the report button
It goes to the preface page even though there are two pages prior to the preface. Is that intended? Also, is there a cover page?
There was a problem hiding this comment.
- It is automatic for the whole site to jump to the Preface (i.e., does the same thing for the TotalRisk, BestFit, etc. pages). The first two pages are moreso for citation. The "Version History" is intended to be in regards to the website itself. If authors modify the website in the future, for example, version 2.0 of the App Guide would describe what changes occurred on the website.
- "Preface" is also a default first chapter name for all website pages.
- A cover page would be nice and will work with Adam on incorporating these.
| @@ -1,16 +1,16 @@ | |||
| --- | |||
| title: Document Info | |||
There was a problem hiding this comment.
Can I download a pdf of the whole document?
There was a problem hiding this comment.
Not currently. And since the Applications Guide is being published via this website and has been modified since its original PDF inception, the 2026 edits do not currently exist anywhere except this website. We should consider adding to the workflow for authors (including for this App Guide) to create copies of edits into PDF form and publish alongside the website launch...
| lethality for those people who are exposed to the hazard and the associated direct damages. By tracking individual people and their movements, LifeSim can help | ||
| identify where people are most at risk of losing their lives, whether it is on roads or in structures. | ||
|
|
||
| Three modes of evacuation are included in LifeSim: cars, sports utility vehicles (SUVs), and pedestrians. For vehicular evacuation, a dual regime |
| software used by the U.S. Army Corps of Engineers. LifeSim is designed to simulate the entire warning and evacuation process for estimating potential life loss | ||
| and direct economic damages resulting from floods. The following is a description of the major capabilities of LifeSim: | ||
|
|
||
| - Graphical User Interface |
There was a problem hiding this comment.
The GUI and graphics may have been significant 15 years ago, but they seem more like expectations at this point. Here's what I think makes it stand out in the industry.
- Agent-based model resolution
- Geographic context
- Modeled interactions between a dynamic flood hazard, buildings, and the evacuating population
- Adherence to research on warning delays
- Monte Carlo sampling of uncertainty
There was a problem hiding this comment.
Concur and revised. @suzbyrd94 please confirm my edit, then click "Resolve Conversation" if concurred.
| - Uncertainty | ||
| - Graphics and Reporting | ||
|
|
||
| The user interacts with LifeSim through a graphical user interface (GUI). The interface is designed to make it easy to use the software, while still |
There was a problem hiding this comment.
delete paragraph and replace. I don't think the GUI is relevant for the app guide.
revised text: "The LifeSim software is designed for ease of use while providing insight to the inputs and results through various plots, tables, and maps."
| segments are connected properly. | ||
|
|
||
| - Example 1: If there is significant life loss on a bridge, ensure the road segment has been assigned an appropriate vertical offset. | ||
| - Example 2: If there is a single road segment with abnormally high life loss, this may indicate that the road segment is not connected to the rest of the road network. |
There was a problem hiding this comment.
That's very unlikely because it can't find a shortest path to destination. the disconnected road will just be pointless in the model. Those high life loss segments are more likely one-ways on the edge of the flood zone. then you need to ask if cars can and would actually be trapped there. if water was rising, I expect cars will drive the wrong way on a one-way road that has come to a stop, unless the traffic is too thick to do that.
| @@ -1094,55 +1140,57 @@ | |||
|
|
|||
| The best ways to identify whether there are issues with the evacuation data are to (1) animate the simulated evacuation and observe if there are | |||
| the top scroller bar as in <FigReference figKey="appguide-toggle-animation"/>. The animation shows when structures are warned (yellow structures by default), when structures are inundated (red structures), | ||
| when vehicles evacuate (blue cars), and when vehicles are caught (red cars). | ||
|
|
||
| <Figure |
There was a problem hiding this comment.
Oh em gee thanks, I made it! :D
| @@ -1200,7 +1260,7 @@ | |||
|
|
|||
| <Figure | |||
There was a problem hiding this comment.
several figures including this one are missing from this section.
| /> | ||
|
|
||
| LifeSim then zooms to the selected structure, and you can confirm the point placement of the structure with the highest life loss. For Cache Creek | ||
| Levee, the highest life loss occurs in a commercial building as shown in the figure below. The structure placement is in the middle of the building |
There was a problem hiding this comment.
high life loss should be associated with high depth/velocity, and proximity to the breach. those patterns should be visible geographically. other correlations like high population and weak buildings, need tabular checks.
|
🔄 New commits pushed by @AdamGohs. @Gman-1789 — please backcheck the revisions for Lead Civil reviewer(s). |
4 participants
Description
This pull request merges the LifeSim Applications Guide into the RMC Software Documentation website.
Affected documents
Related issue(s)
Pre-submission checklist
docs/new/,docs/major/,docs/minor/, ordocs/fix/00-version-history.mdxif this change warrants a version entryTechnical edit (Lanes 1, 2, and 3)
Notes for reviewers