Template:SRH Review Results Workflow: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(14 intermediate revisions by one other user not shown)
Line 32: Line 32:
:# Select the [[SMS:Mesh Data Menu#Dataset Toolbox|''Data'' | '''Dataset Toolbox''']] menu command.
:# Select the [[SMS:Mesh Data Menu#Dataset Toolbox|''Data'' | '''Dataset Toolbox''']] menu command.
:# In the ''Dataset Toolbox'', [[SMS:Dataset_Toolbox#Compare|compare datasets]] by subtracting the alternate dataset from the base dataset.
:# In the ''Dataset Toolbox'', [[SMS:Dataset_Toolbox#Compare|compare datasets]] by subtracting the alternate dataset from the base dataset.
:# New dataset can be generated in the ''Dataset Toolbox'' using the [[Data Calculator|''Data Calculator'']].
:# New dataset can be generated in the ''Dataset Toolbox'' using the [[SMS:Data Calculator|''Data Calculator'']].
|}
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|5. Create a functional surface view.
|-
|
<blockquote>
{{Functional Surface Workflow}}
</blockquote>
|}
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|6. Turn on vector display options.
|-
|
:# Select the [[SMS:Macros#Display_Toolbar|'''Display Options''']] [[File:Display Options Macro.svg|16 px]] macro.
:# In the ''Display Options'' dialog, turn on the [[SMS:Mesh Module Display Options|''Vectors'']] option under the ''2D Mesh'' tab.
:# Select the [[SMS:Vector Display Options|''Vectors'']] tab and set vector display options.
|}
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|7. Use a Plot Data coverage.
|-
|
:A Plot Data coverage is used to show the location of a bridge or culvert on an observation profile plot.
<blockquote>
{{Plot Data Coverage Workflow}}
</blockquote>
|}
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|8. Generate and review the [[SMS:SRH-2D Summary Report|SRH-2D summary report]].
|-
|
:The summary report allows many reports to be generated at once and viewed in an internet browser. To do so, follow these steps:
<blockquote>
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|1. Generate the SRH-2D summary report.
|-
|
:#Right-click on an existing [[SMS:SRH-2D Simulation|SRH-2D simulation]] and use the [[SMS:SRH-2D Summary Report|''Tools''|'''Summary Report''']] command.
:#Enter relevant notes in the [[SMS:SRH-2D Summary Report#SRH-2D_Project_Summary_Report_Dialog|''SRH-2D Project Summary Report'']] dialog.
:#Click '''OK''' to run the Summary Report tool.
|}
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|2. Review the [[SMS:SRH-2D Summary Report#Summary_Report_Output|summary report]].
|-
|
<blockquote>
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|1. Open the summary report.
|-
|
:The summary report should automatically appear in a web browser when the Summary Report tool is finished running. If it does not, please follow the steps below:
:#Navigate to where the project file is saved and open the ''reports'' folder then the ''srh-2d_summary_reports'' folder.
:#Select the "index.html" file and open it in a web browser.
|}
{|class="mw-collapsible mw-collapsed" style="width:100%; border:1px solid #D0E0FF; margin-bottom:0.4em;"
|-
!style="text-align:left;"|2. Review Data.
|-
|
:The summary report includes much numerical and model data. It also includes three interactive features for reviewing data:
:#Use the links in the table of contents to quickly navigate to a desired section.
:#Use the maps to visually review coverages, mesh, and scatter set data by zooming and panning.
:#Use the plots to visually review data by using the toolbar on top of the plot.
|}
|}
</blockquote>
|}<noinclude>[[Category:SRH Workflow Templates|Review]]</noinclude>
|}<noinclude>[[Category:SRH Workflow Templates|Review]]</noinclude>

Latest revision as of 23:48, 1 March 2022

1. Load solution files.
The solution file should load after running SRH-2D assuming the Load Solution option was checked in the model wrapper before exiting the model run. If loading the solution file separately from the model run, do the following:
  1. Open the *_XMDF.h5 output file generated from the model run.
2. Review results datasets and data visualization.
1. Manually review dataset solutions.
  1. In the Project Explorer, click on solution dataset created from the simulation run and view results in the Graphics Window.
  2. Click through the time steps for each dataset to see changes over time in the Graphics Window.
2. Adjust the display options.
1. Set display options.
  1. Open the Display Options Display Options Macro.svg dialog.
  2. Set the general display options.
  3. Set general lighting options.
  4. Set display options for each module that is being used.
  5. Set contour options.
  6. Set vector options.
2. View display.
  1. Use the Rotate Rotate Tool.svg, Pan Pan Tool.svg, and Zoom Zoom Tool Icon.svg tools.
  2. Use the View menu commands found in the Display menu.
  3. Use the Frame Frame Macro.svg command to center and resize the display as needed.
3. Adjust display.
Display may need to be adjusted during the remainder of the project.
  1. Use the Display Options dialog and viewing tools as needed.
  2. Use the Frame Frame Macro.svg command to center and resize the display as needed.
3. Create a film loop visualization.
  1. Select a solution dataset and use the Data | Film Loop menu command.
  2. Use the Film Loop Setup wizard to specify the animation parameters.
  3. Save and view the animation file.
4. Create a plot.
1. Load solution files if not already in the project.
  1. The solution should load automatically assuming the Load Solution option was checked in the model wrapper before exiting the model run.
  2. If loading the solution separately from the model run, open the solution file generated from model run.
2. Create an observation coverage.
Create a new coverage with the "Observation" type.
  1. Select Map Data in the Project Explorer and use the New Coverage right-click command.
  2. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage.
3. Create observation points in the observation coverage.
1. Create feature arcs, nodes and vertices.
In the Map module, create feature objects in the active coverage.
  1. Use the Create Feature Arc SMS Create Arc Tool.svg tool to create arcs in the map coverage.
  2. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object.
  3. Double-click or press the Enter key to terminate the arc.
  4. Use the Create Feature Node Create Points Tool.svg tool to create additional nodes alone or to split arcs.
2. Modify arcs.
Feature arcs often need to be edited after initial creation.
1. Create additional vertices on arcs.
  1. Use the Create Feature Vertex SMS Create Vertex Tool.svg tool to add vertices along arcs.
2. Refine the arc shape.
  1. Use the Select Feature Vertex SMS Select Vertex Tool.svg tool and the Select Feature Node SMS Select Node Tool.svg tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices.
  2. Use the Select Feature Arc SMS Select Arc Tool.svg tool to move entire arcs .
3. Split arcs.
An existing arc can be split by:
1. Converting a vertex to a node.
  1. Use the Select Feature Vertex SMS Select Vertex Tool.svg tool and right-click on a vertex along an arc.
  2. Select the Convert to Node command to split the arc into two arcs.
2. Add a node the arc.
  1. Use the Create Feature Node Create Points Tool.svg tool to add a node on an arc in order to split it into two arcs.
3. Add a new connecting arc.
  1. Use the Create Feature Arc SMS Create Arc Tool.svg tool to start or end a new arc on an existing arc to split the existing arc into two arcs.
4. Use the Split Arcs Tool.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Split Arc(s)... command.
  2. Use the Split Arcs Tool to divide arcs.
5. Split overlapping arcs using the Clean Options dialog.
  1. Select overlapping arcs using the Select Feature Arc SMS Select Arc Tool.svg tool.
  2. Use the Feature Objects | Clean command to bring up the Clean Options dialog.
  3. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs.
4. Merge arcs.
Two arcs that share an end node can be merged together.
  1. Select the shared node using the Select Feature Node SMS Select Node Tool.svg tool.
  2. Right-click on the node and select the Convert to Vertex command to merge the arcs.
  3. If desired, the Select Feature Vertex SMS Select Vertex Tool.svg tool can be used to select and delete the new vertex.
5. Smooth arcs.
The variability or roughness of an arc can be reduced.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Smooth Arc(s)... command.
  2. Use the Smooth Arcs Tool to reduce the variability of the arc.
6. Prune arcs.
Concave sections of the arc can be removed.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Prune Arc(s)... command.
  2. Use the Prune Arcs dialog to remove concave sections.
7. Extend/trim arcs.
Extend or shorten an arc to match an existing arc's length.
  1. Using the Select Feature Arc SMS Select Arc Tool.svg tool, select two intersecting arcs.
  2. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Extend/Trim Arc... command.
  3. Use the Trim/Extend Arc dialog to select the target arc and source arc.
4. Add observation point attributes.
  1. With the Select Feature Point SMS Select Node Tool.svg tool, right-click on the observation point and select the Node Attributes command.
  2. Set the observation attributes in the Observation Coverage dialog.
5. Use the Plot Wizard to generate plot type.
The Plot Wizard can generate any of the following plot types:
1. Computed vs. Observed Data plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Computed vs. Observed Data" option on the left and click Next.
  3. Review measurements to be plotted in step 2 of the Plot Wizard then click Finish.
  4. Review plot window.
2. Residual vs. Observed Data plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Residual vs. Observed Data" option on the left and click Next.
  3. Review measurements to be plotted in step 2 of the Plot Wizard then click Finish.
  4. Review plot window.
3. Error vs. Simulation plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Error vs. Simulation" option on the left and click Next.
  3. Specify plot options in step 2 of the Plot Wizard then click Finish.
  4. Review plot window.
4. Error vs. Time Step plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Error vs. Time Step" option on the left and click Next.
  3. Specify plot options in step 2 of the Plot Wizard then click Finish.
  4. Review plot window.
5. Error Summary plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Error Summary" option on the left and click Next.
  3. Specify measurements to be plotted in step 2 of the Plot Wizard then click Finish.
  4. Review plot window.
6. Time Series plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Time Series" option on the left and click Next.
  3. Specify plot options in step 2 of the Plot Wizard then click Finish.
  4. Review plot window.
3. Use an observation profile plot.
1. Create an observation coverage.
Create a new coverage with the "Observation" type.
  1. Select Map Data in the Project Explorer and use the New Coverage right-click command.
  2. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage.
2. Create observation arcs in the observation coverage.
1. Create feature arcs, nodes and vertices.
In the Map module, create feature objects in the active coverage.
  1. Use the Create Feature Arc SMS Create Arc Tool.svg tool to create arcs in the map coverage.
  2. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object.
  3. Double-click or press the Enter key to terminate the arc.
  4. Use the Create Feature Node Create Points Tool.svg tool to create additional nodes alone or to split arcs.
2. Modify arcs.
Feature arcs often need to be edited after initial creation.
1. Create additional vertices on arcs.
  1. Use the Create Feature Vertex SMS Create Vertex Tool.svg tool to add vertices along arcs.
2. Refine the arc shape.
  1. Use the Select Feature Vertex SMS Select Vertex Tool.svg tool and the Select Feature Node SMS Select Node Tool.svg tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices.
  2. Use the Select Feature Arc SMS Select Arc Tool.svg tool to move entire arcs .
3. Split arcs.
An existing arc can be split by:
1. Converting a vertex to a node.
  1. Use the Select Feature Vertex SMS Select Vertex Tool.svg tool and right-click on a vertex along an arc.
  2. Select the Convert to Node command to split the arc into two arcs.
2. Add a node the arc.
  1. Use the Create Feature Node Create Points Tool.svg tool to add a node on an arc in order to split it into two arcs.
3. Add a new connecting arc.
  1. Use the Create Feature Arc SMS Create Arc Tool.svg tool to start or end a new arc on an existing arc to split the existing arc into two arcs.
4. Use the Split Arcs Tool.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Split Arc(s)... command.
  2. Use the Split Arcs Tool to divide arcs.
5. Split overlapping arcs using the Clean Options dialog.
  1. Select overlapping arcs using the Select Feature Arc SMS Select Arc Tool.svg tool.
  2. Use the Feature Objects | Clean command to bring up the Clean Options dialog.
  3. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs.
4. Merge arcs.
Two arcs that share an end node can be merged together.
  1. Select the shared node using the Select Feature Node SMS Select Node Tool.svg tool.
  2. Right-click on the node and select the Convert to Vertex command to merge the arcs.
  3. If desired, the Select Feature Vertex SMS Select Vertex Tool.svg tool can be used to select and delete the new vertex.
5. Smooth arcs.
The variability or roughness of an arc can be reduced.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Smooth Arc(s)... command.
  2. Use the Smooth Arcs Tool to reduce the variability of the arc.
6. Prune arcs.
Concave sections of the arc can be removed.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Prune Arc(s)... command.
  2. Use the Prune Arcs dialog to remove concave sections.
7. Extend/trim arcs.
Extend or shorten an arc to match an existing arc's length.
  1. Using the Select Feature Arc SMS Select Arc Tool.svg tool, select two intersecting arcs.
  2. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Extend/Trim Arc... command.
  3. Use the Trim/Extend Arc dialog to select the target arc and source arc.
3. Create an observation plot.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Observation Profile" option on the left and click Next.
  3. Select arcs, datasets, and time steps to be plotted.
  4. Review plot window.
4. Create and compare datasets.
  1. Select the Data | Dataset Toolbox menu command.
  2. In the Dataset Toolbox, compare datasets by subtracting the alternate dataset from the base dataset.
  3. New dataset can be generated in the Dataset Toolbox using the Data Calculator.
5. Create a functional surface view.
1. Turn on functional surface display options.
  1. Select the Display Options Display Options Macro.svg macro.
  2. In the Display Options dialog, under the 2D Mesh tab, turn on the Functional Surface option and click the Options button next to it.
  3. Set options in the Functional Surface Options dialog.
2. View the functional surface.
  1. Use the Rotate Rotate Tool.svg tool to view the functional surface.
6. Turn on vector display options.
  1. Select the Display Options Display Options Macro.svg macro.
  2. In the Display Options dialog, turn on the Vectors option under the 2D Mesh tab.
  3. Select the Vectors tab and set vector display options.
7. Use a Plot Data coverage.
A Plot Data coverage is used to show the location of a bridge or culvert on an observation profile plot.
1. Create a Plot Data coverage.
Create a new coverage with the "Plot Data" type.
  1. Select Map Data in the Project Explorer and use the New Coverage right-click command.
  2. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage.
2. Create polygons in the Plot Data coverage to represent the bridge or culvert.
1. Create enclosed arcs for polygons.
1. Create feature arcs, nodes and vertices.
In the Map module, create feature objects in the active coverage.
  1. Use the Create Feature Arc SMS Create Arc Tool.svg tool to create arcs in the map coverage.
  2. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object.
  3. Double-click or press the Enter key to terminate the arc.
  4. Use the Create Feature Node Create Points Tool.svg tool to create additional nodes alone or to split arcs.
2. Modify arcs.
Feature arcs often need to be edited after initial creation.
1. Create additional vertices on arcs.
  1. Use the Create Feature Vertex SMS Create Vertex Tool.svg tool to add vertices along arcs.
2. Refine the arc shape.
  1. Use the Select Feature Vertex SMS Select Vertex Tool.svg tool and the Select Feature Node SMS Select Node Tool.svg tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices.
  2. Use the Select Feature Arc SMS Select Arc Tool.svg tool to move entire arcs .
3. Split arcs.
An existing arc can be split by:
1. Converting a vertex to a node.
  1. Use the Select Feature Vertex SMS Select Vertex Tool.svg tool and right-click on a vertex along an arc.
  2. Select the Convert to Node command to split the arc into two arcs.
2. Add a node the arc.
  1. Use the Create Feature Node Create Points Tool.svg tool to add a node on an arc in order to split it into two arcs.
3. Add a new connecting arc.
  1. Use the Create Feature Arc SMS Create Arc Tool.svg tool to start or end a new arc on an existing arc to split the existing arc into two arcs.
4. Use the Split Arcs Tool.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Split Arc(s)... command.
  2. Use the Split Arcs Tool to divide arcs.
5. Split overlapping arcs using the Clean Options dialog.
  1. Select overlapping arcs using the Select Feature Arc SMS Select Arc Tool.svg tool.
  2. Use the Feature Objects | Clean command to bring up the Clean Options dialog.
  3. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs.
4. Merge arcs.
Two arcs that share an end node can be merged together.
  1. Select the shared node using the Select Feature Node SMS Select Node Tool.svg tool.
  2. Right-click on the node and select the Convert to Vertex command to merge the arcs.
  3. If desired, the Select Feature Vertex SMS Select Vertex Tool.svg tool can be used to select and delete the new vertex.
5. Smooth arcs.
The variability or roughness of an arc can be reduced.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Smooth Arc(s)... command.
  2. Use the Smooth Arcs Tool to reduce the variability of the arc.
6. Prune arcs.
Concave sections of the arc can be removed.
  1. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Prune Arc(s)... command.
  2. Use the Prune Arcs dialog to remove concave sections.
7. Extend/trim arcs.
Extend or shorten an arc to match an existing arc's length.
  1. Using the Select Feature Arc SMS Select Arc Tool.svg tool, select two intersecting arcs.
  2. Right-click on an arc using the Select Feature Arc SMS Select Arc Tool.svg tool and select the Extend/Trim Arc... command.
  3. Use the Trim/Extend Arc dialog to select the target arc and source arc.
2. Build polygons.
Polygons are not created automatically when arcs are enclosed. To create polygons:
  1. Use the Feature Objects | Build Polygons command.
3. Assign plot data attributes.
  1. Using the Select Feature Polygon SMS Select Polygon Tool.svg tool, right-click on polygons and select the Attributes command.
  2. Enter attributes in the Plot Data dialog.
4. Create an observation plot using the Plot Data coverage.
  1. Select Display | Plot Wizard to start the Plot Wizard.
  2. Select the "Observation Profile" option on the left and click Next.
  3. Select arcs, plot data coverage, datasets, and time steps to be plotted.
  4. Review plot window.
8. Generate and review the SRH-2D summary report.
The summary report allows many reports to be generated at once and viewed in an internet browser. To do so, follow these steps:
1. Generate the SRH-2D summary report.
  1. Right-click on an existing SRH-2D simulation and use the Tools|Summary Report command.
  2. Enter relevant notes in the SRH-2D Project Summary Report dialog.
  3. Click OK to run the Summary Report tool.
2. Review the summary report.
1. Open the summary report.
The summary report should automatically appear in a web browser when the Summary Report tool is finished running. If it does not, please follow the steps below:
  1. Navigate to where the project file is saved and open the reports folder then the srh-2d_summary_reports folder.
  2. Select the "index.html" file and open it in a web browser.
2. Review Data.
The summary report includes much numerical and model data. It also includes three interactive features for reviewing data:
  1. Use the links in the table of contents to quickly navigate to a desired section.
  2. Use the maps to visually review coverages, mesh, and scatter set data by zooming and panning.
  3. Use the plots to visually review data by using the toolbar on top of the plot.