|
| 1 | +--- |
| 2 | +title: General Overview |
| 3 | +--- |
| 4 | + |
| 5 | +import Link from '@docusaurus/Link'; |
| 6 | +import addBaseUrl from '@docusaurus/useBaseUrl'; |
| 7 | +import Citation from '@site/src/components/Citation'; |
| 8 | +import CitationFootnote from '@site/src/components/CitationFootnote'; |
| 9 | +import Figure from '@site/src/components/Figure'; |
| 10 | +import FigReference from '@site/src/components/FigureReference'; |
| 11 | +import NavContainer from '@site/src/components/NavContainer'; |
| 12 | + |
| 13 | +<NavContainer |
| 14 | + link="/toolboxes/internal-erosion-suite" |
| 15 | + linkTitle="Internal Erosion Suite" |
| 16 | + document="toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression" |
| 17 | +></NavContainer> |
| 18 | + |
| 19 | +# General Overview |
| 20 | + |
| 21 | +## Getting Started |
| 22 | + |
| 23 | +Copy or download the toolbox file to the computer. To open the toolbox file, either: |
| 24 | + |
| 25 | +- Find the file on the computer and double-click it. This opens the file in Microsoft Excel. |
| 26 | +- Open Microsoft Excel and use the application to open the file: Once Microsoft Excel is open, go to the File menu at the top of the window and select Open. |
| 27 | + |
| 28 | +The toolbox is an Excel binary workbook (.xlsb) that uses macros. You may need to enable the macros, either before opening the file or by clicking |
| 29 | +“Enable Content” in the yellow Security Warning message bar with a shield icon that appears after the file is opened. The actual message in the |
| 30 | +message bar will vary depending on the computer’s settings and installed add-ins. <FigReference figKey="figure-1"/> displays examples of different wordings that may appear in the message bar. |
| 31 | + |
| 32 | +<Figure |
| 33 | + docId="03-general-overview.mdx" |
| 34 | + figKey="figure-1" |
| 35 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure1.png" |
| 36 | + alt="Security warning message bars with the 'Enable Content' option to enable macros" |
| 37 | + caption="Security warning message bars with the 'Enable Content' option to enable macros." |
| 38 | + background="transparent" |
| 39 | +></Figure> |
| 40 | + |
| 41 | +## Organization |
| 42 | + |
| 43 | +Although the toolbox does not provide a calculation cover sheet, adding one is strongly recommended. A calculation cover sheet captures project |
| 44 | +information, a description and purpose of the calculation, the assumptions for critical input parameters, a summary of the major conclusion and |
| 45 | +results, and a revision history. |
| 46 | + |
| 47 | +Each toolbox has a similar appearance and organizational structure: |
| 48 | + |
| 49 | +- The first worksheet, About, summarizes the purpose of the toolbox and gives contact information for the RMC software development team. |
| 50 | +- The second worksheet, Terms and Conditions, contains the terms and conditions for use of the toolbox (IWR software). |
| 51 | +- The third worksheet, Version History, contains the revision history. Semantic versioning is used in the format of MAJOR.MINOR.PATCH: |
| 52 | + - MAJOR - significant worksheet changes not compatible with previous versions. |
| 53 | + - MINOR - additional features or enhancements that do not fundamentally change the calculations. |
| 54 | + - PATCH - backward-compatible bug fixes. |
| 55 | +- The fourth worksheet, References, lists the references cited for each calculation worksheet. |
| 56 | + |
| 57 | +The workbook and worksheets are not protected to prevent unwanted changes. However, because the toolbox has user-defined functions (UDFs) and |
| 58 | +subroutines in Visual Basic, you cannot directly copy worksheets to another workbook without potentially losing functionality. A note in a bold |
| 59 | +red font at the upper right margin indicates if the selected worksheet includes such features. |
| 60 | + |
| 61 | +At the top of each calculation worksheet, input information for the preparer and checker for quality control (QC) documentation and the calculation |
| 62 | +title in case multiple copies of the worksheet are created for different analysis scenarios (<FigReference figKey="figure-2"/>). |
| 63 | +The footer of each calculation worksheet contains the version number, which can be cross-referenced with the revision history on the third worksheet. |
| 64 | + |
| 65 | +<Figure |
| 66 | + docId="03-general-overview.mdx" |
| 67 | + figKey="figure-2" |
| 68 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure2.png" |
| 69 | + alt="Calculation worksheet heading" |
| 70 | + caption="Calculation worksheet heading." |
| 71 | +></Figure> |
| 72 | + |
| 73 | +User-specified input includes values and selections from drop-down lists. User input cells are light yellow, and these cells are unprotected. |
| 74 | +When cells use drop-down lists, a note in blue font in the right margin of the row alerts the user to use the drop-down list. Conditional formatting |
| 75 | +applies a gray background to cells that are not based on a user selection. When a user-specified value or calculated value is outside of acceptable |
| 76 | +ranges, the cell is orange to indicate caution to the user. |
| 77 | + |
| 78 | +All units for user-specified input values are clearly labeled. Most user-specified input values use English units. However, values may be in metric |
| 79 | +where metric units are more common in practice (e.g., particle size in millimeters or permeability in centimeters per second). The toolbox may convert |
| 80 | +English units to metric units to perform some calculations or if required for a specific formula based on the reference material for the equation. |
| 81 | + |
| 82 | +If the calculation worksheet is a function of headwater level, up to seven headwater and tailwater levels may be specified at the top of the worksheet. |
| 83 | +Tailwater may be required to calculate the net hydraulic head and hydraulic gradient. Specify the elevation datum by selecting one of three options |
| 84 | +from the drop-down list: ft-NAVD88, ft-NGVD29, and Other. The two datum selections include English units of length (feet). If Other is selected, provide |
| 85 | +a user-specified datum along with feet (e.g., ft-MSL [Mean Sea Level]). <FigReference figKey="figure-3"/>, <FigReference figKey="figure-4"/>, and <FigReference figKey="figure-5"/> illustrate |
| 86 | +the three possible scenarios. |
| 87 | + |
| 88 | +<Figure |
| 89 | + docId="03-general-overview.mdx" |
| 90 | + figKey="figure-3" |
| 91 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure3.png" |
| 92 | + alt="Headwater and tailwater input: NAVD88" |
| 93 | + caption="Headwater and tailwater input: NAVD88." |
| 94 | +></Figure> |
| 95 | + |
| 96 | +<Figure |
| 97 | + docId="03-general-overview.mdx" |
| 98 | + figKey="figure-4" |
| 99 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure4.png" |
| 100 | + alt="Headwater and tailwater input: NGVD29" |
| 101 | + caption="Headwater and tailwater input: NGVD29." |
| 102 | +></Figure> |
| 103 | + |
| 104 | +<Figure |
| 105 | + docId="03-general-overview.mdx" |
| 106 | + figKey="figure-5" |
| 107 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure5.png" |
| 108 | + alt="Headwater and tailwater input: User-specified datum" |
| 109 | + caption="Headwater and tailwater input: User-specified datum." |
| 110 | +></Figure> |
| 111 | + |
| 112 | +Most calculation worksheets break down complex analysis into computational steps following a logical sequence (<FigReference figKey="figure-6"/>). Some simpler |
| 113 | +worksheets do not have steps. Generally, different methodologies are unique worksheets. Some worksheets may include multiple methodologies, which |
| 114 | +are labeled as options (<FigReference figKey="figure-7"/>). |
| 115 | + |
| 116 | +<Figure |
| 117 | + docId="03-general-overview.mdx" |
| 118 | + figKey="figure-6" |
| 119 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure6.png" |
| 120 | + alt="Example of step banner" |
| 121 | + caption="Example of step banner." |
| 122 | +></Figure> |
| 123 | + |
| 124 | +<Figure |
| 125 | + docId="03-general-overview.mdx" |
| 126 | + figKey="figure-7" |
| 127 | + src="/figures/toolbox-technical-manuals/internal-erosion-suite/backward-erosion-piping-progression/v1.1/figure7.png" |
| 128 | + alt="Example of option banner" |
| 129 | + caption="Example of option banner." |
| 130 | +></Figure> |
| 131 | + |
| 132 | +Some calculation worksheets can perform either a deterministic or probabilistic analysis. Although not required to perform a probabilistic |
| 133 | +analysis, Palisade @RISK software (standalone version or as part of the Palisade DecisionTools Suite) can customize the probabilistic analysis. |
| 134 | +A note appears in a bold red font at the upper right-hand margin of a calculation worksheet indicating if this feature is included with the toolbox. |
| 135 | + |
| 136 | +User notes generally appear in the right margin of each calculation worksheet. Some notes are in blue or red font for heightened awareness. These |
| 137 | +notes include references to source materials for equations, figures, tables, pages, etc. If the RMC modified the source material, the reference |
| 138 | +citation says “adapted from” instead of “from.” |
| 139 | + |
| 140 | +Tabular and/or graphical summaries are generally the primary output of the toolbox. The UDFs in the PlotScale module change the minimum and maximum |
| 141 | +values of the x-axis and y-axis for charts. If the calculation worksheet is a function of headwater level, you can define up to five headwater levels |
| 142 | +of interest and plot them as vertical reference lines. By selecting the chart and then selecting the Filter icon to display the filter pane, you can |
| 143 | +choose which data series to display. This is useful when computing the results from multiple methodologies, but not all are applicable or desired to display. |
0 commit comments