Download PDF
Download page NEW: Standard Reports and Hydrologic Tree Diagram - DRAFT.
NEW: Standard Reports and Hydrologic Tree Diagram - DRAFT
Reports
Report options are available from Tools > Reports. Use Standard Report to document model parameters, computed results, and shared data. Use Hydrologic Tree Diagram to review basin connectivity, drainage areas, and selected peak-flow results.
Standard Report
The Standard Report combines information about a selected compute into an HTML or PDF document. Its contents can include parameter tables, result summaries, time-series graphs, and shared-data information. Compute Specifications and Meteorologic Model information are included automatically when available.
Before generating a report that includes calculated results, compute the simulation or analysis you want to report.
Selecting a compute and template
Open Tools > Reports > Standard Report. Select the simulation or analysis from the Compute list. HEC-HMS populates the available elements, parameters, graphs, and shared data for that compute.
Next, select a Template:
| Template | Description |
|---|---|
| Standard | Uses predefined parameter selections and a standard set of result graphs. Shared-data plots are initially excluded. |
| Detailed | Selects all available parameter and time-series options, including shared-data tables, descriptions, and plots. |
| Summary | Uses predefined parameter and result-summary selections, with element time-series graphs and Shared Data excluded. |
| Custom | Starts with the current selections and allows you to change the report contents. |
When Standard, Detailed, or Summary is selected, content checkboxes are locked. Categories can still be expanded to review the selections. The Customizations panel remains editable with every template.
Choosing report contents
The content panels are initially collapsed. Click a panel heading to expand it, then use the arrows within each selection tree to view its categories. Scroll within a section when additional options extend beyond the visible area.
Select Custom to edit the content checkboxes.
| Panel | Available selections |
|---|---|
| Elements to Include | Select the hydrologic elements that appear in parameter tables, result summaries, and graphs. |
| Parameters | Choose the contents of the Global Parameter Summary Table and Element Parameter Summary Tables. |
| Results | Include the Global Summary Result Table and select additional Element Time-Series Graphs. |
| Shared Data | Include time-series, paired-data, and grid-data information used by the selected compute. |
| Customizations | Set the output format, formatting, volume units, logo, and report description. |
Elements to Include applies throughout the global and element-level parameter tables, result tables, and graphs. Shared Data selections are independent of this filter.
Global parameter tables organize parameters by method and element type, making it easier to compare elements. Element parameter tables organize the information separately for each selected element.
Element result tables are included by default for the selected elements when results are available. The graph selections control which additional time-series plots appear.
For Depth-Area Analyses, the global results table lists the analysis points together. Each analysis point also has a separate section containing the selected parameter information and results for that point and its upstream elements, subject to the report’s element and content selections. Reservoir results appear in a separate global summary table with Peak Storage and Peak Elevation/Stage.
When a Depth-Area Analysis is selected, a separate Analysis Points section lists the available analysis points. All points are selected by default. Choose the Custom template to select or deselect individual points.
Clearing an analysis point removes its separate detailed section, including element parameter tables, result summaries, and graphs. The Global Results Summary continues to include all analysis points. Elements upstream of a selected point remain included in that point’s section, even if their own analysis point is deselected.
Analysis point selections are saved when you save a custom report template.
Including Shared Data
The Shared Data panel contains three sections, in this order:
| Section | Available options |
|---|---|
| Time-Series Data | Include a description and/or plot for the selected data types. |
| Paired Data | Include a table and/or plot for the selected paired-data types. |
| Grid Data | Include descriptions for the selected grid-data types. |
The available selections reflect data referenced by the chosen compute. Expand a data type to select its supporting information. When a data type is selected, the report identifies its referenced components by name even when its description, table, or plot options are unchecked.
Customizing the report appearance
Expand Customizations to configure the output:
- Output: Select HTML for viewing in a web browser or PDF for a document with fixed pagination.
- Formatting: Click Formatting… to choose the font, font size, and page-margin preset. Click Apply to retain the changes.
- Volume Units: Choose AC-FT or INCHES for applicable volume figures.
- Logo: Click Browse… to select a report-header image. Click Remove to clear it.
- Description: Enter optional text to include in the report header.
PDF export requires a supported installed browser, such as Microsoft Edge, Google Chrome, or Chromium. Reports containing graphs also require access to the online chart library when those graphs are displayed or rendered.
Saving and loading custom templates
Custom templates allow the same report selections and formatting to be reused.
To save a template:
- Select Custom and configure the report.
- Click the gear button beside Template.
- Enter a Template name.
- Click Save… and choose a location for the JSON template file.
To load a template, open the gear dialog and click Browse and Load…. Select an existing JSON template file. The loaded template appears by name in the Template list and remains available for later use.
Templates store report settings. The compute and output destination are selected separately for each report.
Generating the report
Enter a filename and location in the required Destination field at the bottom of the dialog, or use the browse button to select one.
Review the selections, then click Generate Report. Open the resulting HTML or PDF file from the selected location.
Hydrologic Tree Diagram — Network Schematic
The Hydrologic Tree Diagram presents the basin’s flow network, including element connections, diversion paths, and drainage-area information. It can also include peak-flow results from a Simulation Run or a selected Depth-Area Analysis point.
A computed simulation is not required when exporting drainage-area information only.
Selecting a basin and results
Open Tools > Reports > Hydrologic Tree Diagram.
Configure the following fields:
| Field | Description |
|---|---|
| Basin Model | Select the basin whose network will be shown. |
| Results | Choose Area only, a Simulation, or a Depth-area analysis associated with the selected basin. |
| Analysis Point | Select the analysis point when using Depth-Area Analysis results. This field is disabled for the other result selections. |
| Format | Choose Web Page (HTML) or Text (ASCII). |
| Destination | Enter or browse to the output filename and location. |
Use Area only to review basin connectivity and drainage areas without including computed peak results.
To include peak results, select a Simulation Run or Depth-Area Analysis that has been computed. Simulation results must be current, and the selected Depth-Area Analysis point must have available, current results. Recompute if HEC-HMS identifies missing or out-of-date results.
For a Depth-Area Analysis, choose the desired Analysis Point before generating the report. The peak values shown in the schematic come from that analysis point’s results.
Choosing the output format
Web Page (HTML) creates a formatted, interactive diagram that opens in a web browser. The file includes the diagram’s styles and interactive features and can be shared as a single HTML file.
Text (ASCII) creates a plain-text version of the network for review in a text editor.
Choose the required Destination, then click Generate Report. Open the exported file from the selected location.
Navigating the HTML schematic
The HTML report arranges elements along flow paths from headwaters toward their outlets. The diagram legend identifies the element and connection symbols.
Use the toolbar to adjust the display:
| Control | Action |
|---|---|
| Find an element | Enter all or part of an element name, then choose a matching suggestion to locate it in the diagram. |
| Elements | Switch between element Icons and Type badges. |
| Lane markers | Show or hide markers that help distinguish flow lanes. |
| Area | Show or hide drainage-area information. |
| Peak flow | Show or hide peak-flow values when computed results were included. |
| Time of peak | Show or hide peak times when computed results were included. Times are expressed in hours from the start of the selected compute. |
| Prepare the diagram for printing and open the browser’s print dialog. |
Move the pointer over an element to highlight its upstream contributing network. Use the clear-search button to remove an element search.
The Peak flow and Time of peak controls are disabled when the report was generated using Area only.
To create a PDF of the schematic, generate the HTML report, click Print, and select a PDF destination in the browser’s print dialog.
