Software Version
HEC-HMS version 4.14-beta.2 was used to create this tutorial. This tutorial is intended to showcase capability related to the persistance of User Interface (UI) selections.
The Maricopa Clark and S-Graph transform tools and the Green-Ampt loss tool became available in HEC-HMS version 4.9. More recently, in version 4.12, routing parameter estimation tools were added for the Muskingum, Kinematic Wave, Normal Depth, and Musking-Cunge methods. Each of these tools can be accessed by clicking Tools | Data | Maricopa. The Maricopa tools were designed specifically to accompany a standard work flow followed by Maricopa County water professionals.
New functionality is available in HEC-HMS version 4.14 that tracks previous selections that users made when applying the various Maricopa tools. For example, when a user utilizes a Maricopa parameter estimation tool, all user-selected data files and user-selected data fields will be stored so that they are displayed the next time that the parameter estimation tool is launched. If previously selected data files or data fields are no longer available, they will be color-coded appropriately. This functionality facilitates the model review process.
User-selections are saved in a properties text file located in the project directory, i.e. <project>/.cache. An example of the properties text file is seen below.
The Maricopa wizard tools require several geo-spatial files and tabular CSV files as inputs. These include existing subbasin, reach, routing, longest flow path, soils, and land use shapefiles, as well as several landuse and soils tables in CSV format.
The first time that a Maricopa parameter estimation tool is applied to a given basin model, the wizard will behave as before. UI components related to data files will be blank and combobox components related to data fields will be blank as seen below. The user will need to make data selections and proceed through the various wizard steps. At the end of the wizard, the user selections are saved to a .properties text file.
However, if the same Maricopa parameter estimation tool (i.e. Normal Depth) is launched again and the same basin model is selected, the UI components will be displayed with their prior selections as seen below. Notice that tool tips now exist when the user hovers the mouse over the UI components. In this case, the previously user-selected data file and the previously user-selected channel fields are still valid selections (i.e. the file still exists and the selected field names are still contained in the data file) so they are displayed in the default font color (black).
If the user were to change a channel field to something different than the persisted selection, the color will change from default to modified (blue) and the tool tip will also change as seen below. In this case, the "Reach name field" selection was changed from the persisted selection (ID) to something different (BASINID).
Similarly, if the user were to change the routing shapefile to a data file that differs from the persisted selection, the color of the file path will change from default to modified (blue). If the modified data file does not contain data fields that match the previously selected fields, the data field components will change from default to invalid (red). In the below case, the modified shapefile path did not contain the previously selected field names of "ID" and "MAN" so those selections were displayed in the invalid color. If, for example, the previously selected data file no longer exists, the related data field UI components will always be displayed as invalid. This should serve as a flag to model reviewers that the data used to inform basin parameter estimates no longer exists or cannot be found.
