Skip to content

Commit 7ae2022

Browse files
committed
Update preface, installation, GUI, and acronyms for v1.1
- 01-preface: note v1.1 scope at end of preface - 04-installation: bump version string to 1.1; raise minimum RAM (512 MB → 2 GB) and disk (2 GB → 4 GB); add Windows 11 recommendation - 05-gui: add paragraph describing Project Explorer contents and validation indicators - 15-appendix-acronyms: add CDF (Cumulative Distribution Function) and MCS (Monte Carlo Simulation)
1 parent 85e53a4 commit 7ae2022

4 files changed

Lines changed: 16 additions & 8 deletions

File tree

docs/desktop-applications/rmc-totalrisk/users-guide/v1.1/01-preface.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,6 @@ transform, system response, and consequence functions. RMC-TotalRisk is part of
2020
The software features a fully integrated modeling platform, including a modern graphical user interface, data entry, report quality charts, and
2121
diagnostic tools. RMC-TotalRisk can evaluate risk for a single component with multiple failure modes and a complex system comprised of multiple
2222
components. This document is a guide for developing a quantitative risk analysis with RMC-TotalRisk.
23+
24+
Version 1.1 of this Users Guide reflects refinements introduced in the v1.1 release of RMC-TotalRisk, including updated system requirements, an
25+
expanded description of the Project Explorer pane, and additional acronyms commonly encountered when configuring multi-component analyses.

docs/desktop-applications/rmc-totalrisk/users-guide/v1.1/04-installation.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CitationFootnote from "@site/src/components/CitationFootnote";
1818

1919
# Installing RMC-TotalRisk
2020

21-
RMC-TotalRisk version 1.0 is available as a portable package (.zip). Installing a portable package does not require administrative rights. Simply extract all
21+
RMC-TotalRisk version 1.1 is available as a portable package (.zip). Installing a portable package does not require administrative rights. Simply extract all
2222
contents of the portable package to the desired computer location. <FigReference figKey="figure-2" /> shows an example of the package contents after
2323
extraction. Double-click the executable **RMC-TotalRisk.exe** to get started. For easy access to the program, create a desktop shortcut and pin the program to
2424
the Windows task bar.
@@ -62,9 +62,9 @@ automatically open it with RMC-TotalRisk.
6262
The RMC-TotalRisk program and all dependent libraries were developed using the .NET Framework 4.8.1. As such, the program is currently only available for the
6363
Microsoft Windows operating system. The recommended system configuration for RMC-TotalRisk includes:
6464

65-
- 64-bit Windows Operating System (Windows 10 or newer).
66-
- 512 MB of RAM at a minimum.
67-
- 2 GB of free disk space at a minimum.
65+
- 64-bit Windows Operating System (Windows 10 or newer; Windows 11 recommended).
66+
- 2 GB of RAM at a minimum (8 GB recommended for multi-component analyses).
67+
- 4 GB of free disk space at a minimum.
6868
- Quad-Core CPU with 2.7 GHz (or faster) clock speed.
6969
- 1280 x 1024 screen resolution or higher (and at least a 17" monitor).
7070

docs/desktop-applications/rmc-totalrisk/users-guide/v1.1/05-gui.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ data entry capabilities, multi-failure risk analysis, and report-quality charts.
2626
The graphical user interface consists of a menu bar, tool bar, and four window panes (<FigReference figKey="figure-5" />): the Project Explorer, Tabbed Documents, Properties,
2727
and the Message window. You may move, dock, hide, or close the panes as desired.
2828

29+
The Project Explorer pane on the left side of the workspace organizes all project elements hierarchically. Components, failure modes, hazard functions, transform functions,
30+
response functions, and consequence functions appear as nested nodes under the active project. Right-clicking any node reveals a context menu of actions appropriate to that
31+
element type (for example, **Add Failure Mode** under a component, or **Edit Function** under a hazard function). The Project Explorer also displays validation indicators —
32+
a red icon next to a node signals an incomplete or inconsistent configuration that must be resolved before risk analyses can run.
33+
2934
<Figure
3035
figKey="figure-5"
3136
src="figures/desktop-applications/rmc-totalrisk/users-guide/v1.0/figure4.png"

docs/desktop-applications/rmc-totalrisk/users-guide/v1.1/15-appendix-acronyms.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ import addBaseUrl from "@docusaurus/useBaseUrl";
1919
headers={["Acronym", "Full Form"]}
2020
columns={[
2121
[
22-
"AALL", "AEP", "ANCOLD", "API", "ASR", "CCA", "CHL", "CI", "CPD", "CPU",
22+
"AALL", "AEP", "ANCOLD", "API", "ASR", "CCA", "CDF", "CHL", "CI", "CPD", "CPU",
2323
"DAG", "EAD", "ECB", "EM", "ER", "EqAC", "ERDC", "ERL", "FWOP", "HEC",
24-
"HEC-FDA", "HEC-RAS", "HEC-SSP", "LEC", "NED", "NFIP", "OT", "PFM", "PRNG",
24+
"HEC-FDA", "HEC-RAS", "HEC-SSP", "LEC", "MCS", "NED", "NFIP", "OT", "PFM", "PRNG",
2525
"RMC", "RMC-BestFit", "RMC-RFA", "SRP", "TD", "TR", "TRL", "U.S.", "USACE", "USBR", "WSE"
2626
],
2727
[
2828
"Average Annual Life Loss", "Annual Exceedance Probability", "Australian National Committee on Large Dams",
2929
"Annual Probability of Inundation", "Adaptive Simpson’s Rule", "Common Cause Adjustment",
30-
"Coastal and Hydraulics Laboratory", "Confidence Interval", "Computer Program Document",
30+
"Cumulative Distribution Function", "Coastal and Hydraulics Laboratory", "Confidence Interval", "Computer Program Document",
3131
"Central Processing Unit", "Directed Acyclic Graph", "Expected Annual Damage",
3232
"Engineering and Construction Bulletin", "Engineer Manual", "Engineer Regulation",
3333
"Equivalent Annual Consequences", "Engineer Research and Development Center",
3434
"Effective Record Length", "Future Without Project", "Hydrologic Engineering Center",
3535
"Flood Damage Reduction Analysis Software", "River Analysis System Software",
36-
"Statistical Software Package Software", "Loss Exceedance Curve", "National Economic Development",
36+
"Statistical Software Package Software", "Loss Exceedance Curve", "Monte Carlo Simulation", "National Economic Development",
3737
"National Flood Insurance Program", "Overtopping", "Potential Failure Mode",
3838
"Pseudo Random Number Generator", "Risk Management Center",
3939
"Bayesian Estimation and Fitting Software", "Reservoir Frequency Analysis Software",

0 commit comments

Comments
 (0)