Skip to content

Commit 967d86e

Browse files
committed
Address technical edit comments and fix rendering issues
Content fixes from the in-PR technical edit (54 threads): - Grammar and agreement: subject-verb, comma splices, non-parallel lists, missing prepositions and articles, criteria/criterion - Section 508: replaced non-descriptive "here" link text (2 sites) - Terminology sweeps per reviewer direction: 2 AM / 2 PM time format, "time step", "break point density", "Hazus" - Corrected LOADS to LODES, General Quarters to Group Quarters, and the CFCC expansion to census feature class code - Added Citation components for FEMA 2009 and RESCDAM where bib entries exist - Retitled Terms and Conditions for Use to match body text and the User's Guide - Added target/rel to 5 external links; en dashes in numeric ranges; kg for kgs Cross-reference readability: - Removed "Chapter"/"Section" prefixes from 41 cross-reference links - Trimmed "- Chapter:"/"- Section:" from 14 cross-document link labels Component and rendering fixes: - Button: zero margins on block children so multi-line usage keeps its height - Figure, Equation, TableVertical, TableHorizontal: register anchors via useBrokenLinks so component-generated ids are visible to the broken-anchor check, clearing a false positive on #table-14 - Re-inlined <Link> elements that Prettier had escalated to block JSX, which was splitting paragraphs in Computational Procedure and Consequences - Restored <br/> breaks in the equation 13 variable list
1 parent 5cbe965 commit 967d86e

31 files changed

Lines changed: 2735 additions & 1925 deletions

‎docs/desktop-applications/lifesim/technical-reference-manual/v1.0/00-document-info.mdx‎

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,59 @@ reportDate: July 2020
44
reportType: Computer Program Document
55
reportTitle: LifeSim
66
reportSubTitle: Technical Reference Manual
7-
reportAuthors: ["U.S. Army Corps of Engineers, Risk Management Center"]
8-
reportAbstract:
9-
reportAcknowledgments: xx
7+
reportAuthors: ['U.S. Army Corps of Engineers, Risk Management Center']
8+
reportAbstract: "The US Army Corps of Engineers (USACE) Hydrologic Engineering Center's (HEC) Life Loss Estimation (HEC-LifeSim) software is a spatially-distributed dynamic simulation modeling system for estimating potential life loss and economic damages from natural and dam and levee failure floods. The main purpose of the HEC-LifeSim software is to help USACE study teams better understand the consequences of a flood event. Although flooding can lead to many types of severe consequences, the primary objective of the USACE Dam and Levee Safety Program is to manage risk to the public who rely on those structures to keep them reasonably safe from flooding."
109
reportSubjectTerms:
10+
[
11+
'HEC-LifeSim',
12+
'USACE',
13+
'life loss',
14+
'spatially',
15+
'dynamic',
16+
'simulation',
17+
'modeling',
18+
'economic',
19+
'damages',
20+
'levee safety',
21+
'analysis',
22+
'hazard',
23+
'emergency',
24+
'hydraulic data',
25+
'HEC-RAS',
26+
'grid set',
27+
'structure inventories',
28+
'damage category',
29+
'occupancy type',
30+
'construction type',
31+
'stability criteria',
32+
'submergence criteria',
33+
'emergency planning zone',
34+
'EPZ',
35+
'road network data',
36+
'shapefile',
37+
'destination data',
38+
'alternatives',
39+
'simulations',
40+
'results',
41+
'animation',
42+
'uncertainty',
43+
'arrival',
44+
'attribute',
45+
'feature',
46+
'properties',
47+
'gridded map',
48+
'vertex',
49+
]
1150
responsiblePersonName: Woodrow Fields
12-
responsiblePersonNumber: ###-###-####
13-
citationGuide: "Risk Management Center, <i>LifeSim Technical Reference Manual</i>, Davis, CA: U.S. Army Corps of Engineers, Institute for Water Resources, 2020. Accessed on <i>{enter current date here}</i>."
51+
citationGuide: 'Risk Management Center, <i>LifeSim Technical Reference Manual</i>, Davis, CA: U.S. Army Corps of Engineers, Institute for Water Resources, 2020. Accessed on <i>{enter current date here}</i>.'
1452
---
1553

16-
import Link from "@docusaurus/Link";
17-
import addBaseUrl from "@docusaurus/useBaseUrl";
18-
import DocumentMetadata from "@site/src/components/DocumentMetadata";
19-
import NavContainer from "@site/src/components/NavContainer";
54+
import Link from '@docusaurus/Link';
55+
import addBaseUrl from '@docusaurus/useBaseUrl';
56+
import DocumentMetadata from '@site/src/components/DocumentMetadata';
57+
import NavContainer from '@site/src/components/NavContainer';
2058

21-
<NavContainer
59+
<NavContainer
2260
link="/desktop-applications/lifesim"
2361
linkTitle="LifeSim"
2462
document="desktop-applications/lifesim/technical-reference-manual"

‎docs/desktop-applications/lifesim/technical-reference-manual/v1.0/00-version-history.mdx‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,25 @@
22
title: Version History
33
---
44

5-
import Link from "@docusaurus/Link";
6-
import NavContainer from "@site/src/components/NavContainer";
7-
import TableVersionHistory from "@site/src/components/TableVersionHistory";
5+
import Link from '@docusaurus/Link';
6+
import NavContainer from '@site/src/components/NavContainer';
7+
import TableVersionHistory from '@site/src/components/TableVersionHistory';
88

9-
<NavContainer
9+
<NavContainer
1010
link="/desktop-applications/lifesim"
1111
linkTitle="LifeSim"
1212
document="desktop-applications/lifesim/technical-reference-manual"
1313
></NavContainer>
1414

1515
# Version History
1616

17-
<TableVersionHistory
18-
versions={["1.0"]}
19-
dates={["July 2026"]}
20-
descriptions={["Initial release of LifeSim Technical Reference Manual as a web document. Source is the LifeSim Technical Reference Manual CPD-97a."]}
21-
modifiedBy={['Karen Mai']}
22-
reviewedBy={['Woodrow Fields']}
23-
approvedBy={['Adam Gohs']}
17+
<TableVersionHistory
18+
versions={['1.0']}
19+
dates={['August 2026']}
20+
descriptions={[
21+
'Initial release of LifeSim Technical Reference Manual as a web document. Source is the LifeSim Technical Reference Manual CPD-97a.',
22+
]}
23+
modifiedBy={['Susie Byrd, Karen Mai']}
24+
reviewedBy={['Paul Risher']}
25+
approvedBy={['Woodrow Fields']}
2426
/>
Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,51 @@
11
---
2-
title: "Preface"
2+
title: 'Preface'
33
---
44

5-
import Link from "@docusaurus/Link";
6-
import addBaseUrl from "@docusaurus/useBaseUrl";
5+
import Link from '@docusaurus/Link';
6+
import addBaseUrl from '@docusaurus/useBaseUrl';
77
import Button from '@site/src/components/Button';
8-
import Citation from "@site/src/components/Citation";
9-
import CitationFootnote from "@site/src/components/CitationFootnote";
10-
import Figure from "@site/src/components/Figure";
11-
import FigureInline from "@site/src/components/FigureInline";
12-
import FigReference from "@site/src/components/FigureReference";
13-
import NavContainer from "@site/src/components/NavContainer";
14-
import ProcessList from "@site/src/components/ProcessList";
15-
import TableReference from "@site/src/components/TableReference";
16-
import TableVertical from "@site/src/components/TableVertical";
17-
import VersionSelector from "@site/src/components/VersionSelector";
18-
19-
<NavContainer
8+
import Citation from '@site/src/components/Citation';
9+
import CitationFootnote from '@site/src/components/CitationFootnote';
10+
import Figure from '@site/src/components/Figure';
11+
import FigureInline from '@site/src/components/FigureInline';
12+
import FigReference from '@site/src/components/FigureReference';
13+
import NavContainer from '@site/src/components/NavContainer';
14+
import ProcessList from '@site/src/components/ProcessList';
15+
import TableReference from '@site/src/components/TableReference';
16+
import TableVertical from '@site/src/components/TableVertical';
17+
import VersionSelector from '@site/src/components/VersionSelector';
18+
19+
<NavContainer
2020
link="/desktop-applications/lifesim"
2121
linkTitle="LifeSim"
2222
document="desktop-applications/lifesim/technical-reference-manual"
2323
></NavContainer>
2424

2525
# Preface
2626

27-
The U.S. Army Corps of Engineers (USACE) Life Loss Estimation (LifeSim) software allows you to evaluate the life loss and economic damages
28-
resulting from a single flood scenario.
27+
The U.S. Army Corps of Engineers (USACE) Life Loss Estimation (LifeSim) software allows you to evaluate the life loss and economic damages
28+
resulting from a single flood scenario.
2929

30-
The LifeSim software is developed at RMC, which is a division of the USACE Institute for Water Resources (IWR). The first version of LifeSim (Version 1.0) was
30+
The LifeSim software is developed at RMC, which is a division of the USACE Institute for Water Resources (IWR). The first version of LifeSim (Version 1.0) was
3131
released in 2017. This Technical Reference Manual was tailored for Version 2.0 of the LifeSim software.
3232

3333
Woodrow Fields leads the LifeSim development team. Stephanie Owen and Brennan Beam provided review and support throughout the development of this
34-
manual in 2020. Jason Needham and William Lehman contributed significantly to all versions of LifeSim. Lea Adams was the Chief of the Water Resources Systems Division,
34+
manual in 2020. Jason Needham and William Lehman contributed significantly to all versions of LifeSim. Lea Adams was the Chief of the Water Resources Systems Division,
3535
and Chris Dunn was the director during the development of Version 2.0 of the
3636
software.
3737

3838
This Technical Reference Manual was originally prepared for the USACE Hydrologic Engineering Center (HEC) by HDR Engineering, Inc. Additional
39-
information can be found in the <Link to="/docs/desktop-applications/lifesim/users-guide/v1.0/welcome-to-lifesim">LifeSim User's Guide</Link>. LifeSim manuals
40-
are available on this RMC Software Documentation website and
39+
information can be found in the <Link to="/docs/desktop-applications/lifesim/users-guide/v1.0/welcome-to-lifesim">LifeSim User's Guide</Link>. LifeSim manuals
40+
are available on this RMC Software Documentation website and
4141
the <a href="https://www.rmc.usace.army.mil/Software/LifeSim/" target="_blank" rel="noopener noreferrer">RMC website</a>.
4242

43-
#### Software
43+
## Software
4444

45-
<Button href="https://github.com/USACE-RMC/LifeSim/releases/download/v2.2/LifeSim_2.2.7z"><u>🡇</u> LifeSim v2.2</Button>
45+
<Button href="https://github.com/USACE-RMC/LifeSim/releases/download/v2.2/LifeSim_2.2.7z">
46+
<u>🡇</u> LifeSim v2.2
47+
</Button>
4648

4749
LifeSim Version 2.2 is available for download as a self-extracting setup package.
4850

49-
<CitationFootnote />
51+
<CitationFootnote />

‎docs/desktop-applications/lifesim/technical-reference-manual/v1.0/03-introduction-and-overview-of-lifesim.mdx‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ technical reference manual reflects the initial release of LifeSim Version 2.0 a
5252

5353
## Purpose of this Technical Reference Manual
5454

55-
This technical reference manual describes the methods, procedural steps and computations that LifeSim uses to calculate fatalities and damages
55+
This technical reference manual describes the methods, procedural steps, and computations that LifeSim uses to calculate fatalities and damages
5656
resulting from floods or other hazards. A strong understanding of these internal processes will increase the user's ability to identify model
5757
limitations, provide suitable inputs, communicate the importance of results, and help validate decisions that LifeSim supports.
5858

@@ -163,11 +163,11 @@ in a hydraulic model and imported into LifeSim as hydraulic events.
163163
- Sources and magnitudes of uncertainty.
164164

165165
For analyses that include life loss, LifeSim is organized to follow a warning-evacuation
166-
(Chapter <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/warning-and-protective-action-parameters">Warning and Protective Action Parameters</Link>) timeline
166+
(<Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/warning-and-protective-action-parameters">Warning and Protective Action Parameters</Link>) timeline
167167
that is enacted by dam or levee owners,
168168
emergency managers, and citizens, as shown in <FigReference figKey="figure-2" />. Each component of the warning-evacuation timeline
169169
is discussed in other parts of this
170-
manual (Chapters <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/warning-and-protective-action-parameters">Warning and Protective Action Parameters</Link> and <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/road-networks-destinations-and-evacuation-parameters">Road Networks, Destinations, and Evacuation Parameters</Link>).
170+
manual (<Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/warning-and-protective-action-parameters">Warning and Protective Action Parameters</Link> and <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/road-networks-destinations-and-evacuation-parameters">Road Networks, Destinations, and Evacuation Parameters</Link>).
171171

172172
<Figure
173173
figKey="figure-2"
@@ -179,7 +179,7 @@ manual (Chapters <Link to="/docs/desktop-applications/lifesim/technical-referenc
179179
## LifeSim's Procedural Steps
180180

181181
LifeSim runs multiple iterations, or potential outcomes, through a Monte Carlo engine. The simulation period for each LifeSim iteration run commences
182-
with the earlier of the first evacuation warning or first hydraulic timestep and continues until either the hydraulic time-series data has stopped or
182+
with the earlier of the first evacuation warning or first hydraulic time step and continues until either the hydraulic time-series data has stopped or
183183
each evacuating group has finished their actions.
184184

185185
Given information about the hazard, PAR, structures, and road network, LifeSim does the following:
@@ -316,11 +316,9 @@ Given information about the hazard, PAR, structures, and road network, LifeSim d
316316
]}
317317
/>
318318

319-
The flow logic for determining hazard zone for people exposed to the hazard (Steps 6-10) is shown in <FigReference figKey="figure-3" />.
319+
The flow logic for determining hazard zone for people exposed to the hazard (Steps 6–10) is shown in <FigReference figKey="figure-3" />.
320320

321-
For Steps 1-10, see Chapters <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/computational-procedure">Computational Procedure</Link>,
322-
<Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/consequences">Consequences</Link>, and
323-
<Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/uncertainty-and-sampling-methods">Uncertainty and Sampling Methods</Link> for additional information.
321+
For Steps 1–11, see <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/computational-procedure">Computational Procedure</Link>, <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/consequences">Consequences</Link>, and <Link to="/docs/desktop-applications/lifesim/technical-reference-manual/v1.0/uncertainty-and-sampling-methods">Uncertainty and Sampling Methods</Link> for additional information.
324322

325323
<Figure
326324
figKey="figure-3"
@@ -353,6 +351,6 @@ The validation efforts include the following events:
353351
- <Link to="/docs/desktop-applications/lifesim/validation-studies/v1.0/teton">Teton Dam</Link> failure in Madison County, Idaho, United States (1976).
354352

355353
The validation efforts show that the LifeSim methodology, including its assumptions on various inputs, provides results
356-
reasonably close to what happened (Needham et al., 2020 and Risher et al., 2017) <Citation citationKey="Needham2020" /> <Citation citationKey="Risher2017" />.
354+
reasonably close to what happened (Needham et al., 2020; Risher et al., 2017) <Citation citationKey="Needham2020" /> <Citation citationKey="Risher2017" />.
357355

358356
<CitationFootnote />

0 commit comments

Comments
 (0)