HEC-HMS Release Notes 4.3
HEC-HMS Release Notes 4.3
Release Notes
Version 4.3
September 2018
ii
HEC-HMS Version 4.3 Release Notes
Introduction
Version 4.2 of the Hydrologic Modeling System (HEC-HMS) was
completed in August 2016 and released for general use shortly
thereafter. An interim release called Version 4.2.1 was completed
in March 2017 primarily to correct a number of errors.
A number of new capabilities have been under development since
2016. The most significant is the redesign of the optimization trial
to support maximization and minimization problems. A new search
method has also been added to the trial; Markov Chain Monte
Carlo. This new search method provides probabilistic parameter
estimates. There is a new reach routing method, enhancements to
another, plus a new initial condition option for all routing methods.
The Clark and ModClark transform methods offer new capabilities
and it is now easier to work with gridded methods. There is a new
shortwave radiation method in the meteorologic model and the
Penman Monteith evapotranspiration method has been enhanced.
Users have reported some difficulties with several features. The
development team has also continued careful and systematic
testing of the program. The results of that testing in combination
with reports from users have allowed the identification and repair of
various problems. Some of these problems affected simulation
results and are described in detail later in this document.
The combination of new capabilities and error corrections is this
Version 4.3 release. It is currently available for the Microsoft
Windows® operating system and the Linux® operating system.
The program has been designed to be easy to use. However, an
understanding of how the program works is critical to producing
accurate results. It is suggested that a new user read the HEC-
HMS Quick Start Guide (Version 4.3 January 2018). The guide
briefly describes the basic features of the program in enough detail
to begin using it. The guide also includes a step-by-step tutorial.
Installation
The installation package and all documentation are available on the
HEC website at http://www.hec.usace.army.mil/. This new release
is installed independently of any previous versions of the program
so you will need to uninstall the previous versions if you do not wish
to use them anymore. However, you may keep different versions of
the program installed for parallel use or testing if you choose. This
new version will automatically open projects developed with any
previous version of the program. However, once a project has
1
HEC-HMS Version 4.3 Release Notes
Windows
The new installation package is designed to be easy to use. It will
take you through the steps of selecting a directory for the program
files and making other settings. Use the following steps to install
the program on the Microsoft Windows® operating system:
1. Download the installation package from the HEC website to a
temporary folder on the computer.
2. Run the installation program. In Windows Explorer, double-click
the icon for the installation program. You must have
administrator privileges to run the installer.
3. Follow the on-screen prompts to install the program.
Linux
The installation package is delivered as a compressed TAR file. It
has several dependencies that must be installed before extracting
the installation package. The following commands can be used to
configure the dependencies prior to extraction of the installation
package.
Red Hat Enterprise Linux 7
yum install libldb.i686 libXext.i686
libXrender.i686 libXtst.i686 libgcc.i686
libstdc++.i686
Ubuntu 14.04
sudo apt-get install libc6-i386 libstdc++6:i386
libxtst6:i386 libxrender1:i386 libgcc1:i386
libxi6:i386
New Capabilities
A total of eighteen notable new capabilities have been added to the
program. Summary descriptions are given below.
2
HEC-HMS Version 4.3 Release Notes
Clark methods. The parameters have exactly the same meaning in
both methods. The parameter values are now automatically
preserved when switching between these methods.
3
HEC-HMS Version 4.3 Release Notes
4
HEC-HMS Version 4.3 Release Notes
conditions in the reach. An override option can be used at the
discretion of the user if automatic processing does not produce
good results.
Hargreaves Evapotranspiration
A new evapotranspiration method has been added to the
meteorologic model. The method uses average daily temperature
data combined with solar radiation to compute evapotranspiration
according to the methodology of Hargreaves and Samani, 1985,
Eq. 1. The coefficient is set to a default value of 0.0135 and can be
adjusted by the user. When the Hargreaves evapotranspiration
method is combined with the Hargreaves radiation method the
evapotranspiration calculation takes the form of Hargreaves and
Samani, 1985, Eq. 8. The user can control the coefficient through
the Hargreaves shortwave and evapotranspiration methods. The
new method can be used with gridded and non-gridded subbasins.
Hamon Evapotranspiration
A new evapotranspiration method has been added to the
meteorologic model. The method uses average daily temperature
data combined with latitude and longitude to compute
evapotranspiration according to the methodology of Hamon, 1963,
Eq. 2. The Hamon coefficient is set to a default value of 0.0065
and can be adjusted by the user. If the simulation time interval is
sub-daily the daily evapotranspiration amount is distributed
between sunrise and sunset according to a sinusoidal pattern. The
new method can be used with gridded and non-gridded subbasins.
Optimization Trial
The optimization trial is a flexible tool for automatically estimating
model parameters when observed flow is available. An objective
function is used to compute model performance by comparing the
simulated and observed flow. A search method is used to
automatically adjust model parameters in order to minimize the
5
HEC-HMS Version 4.3 Release Notes
6
HEC-HMS Version 4.3 Release Notes
and effectively converts the deterministic modeling components into
a probabilistic flow simulation system. The search process begins
with a Latin Hypercube Sample (LHS) which generates an initial
number of parameter sets that cover the entire parameter space
box as defined by user-specified lower and upper bounds for each
adjustable model parameter. The LHS initialization serves as the
basis for a population of Markov Chain directed random walks
which run in parallel and characterize the flow simulation. A data
likelihood function is associated with each evaluated parameter set.
Currently, the squared deviation likelihood is the only option
available. The definition for this classical likelihood includes the
simple root mean square error (RMSE) function from traditional
optimization. During the Markov Chain directed random walks,
proposed jumps are evaluated for acceptance or rejection using the
Metropolis acceptance probability rule. Given that a quantitative
convergence diagnostic can prematurely assess equilibrium, we
recommend assessing equilibrium using a weight-of-evidence
approach that involves user interaction. To support this approach,
plots are provided for (1) the likelihood function (RMSE), (2) the
quantitative convergence diagnostic (Gelman and Rubin) for each
parameter, and (3) traces of all chains for each parameter. When
all of these point to convergence, then most likely a thinned history
of subsequent draws will be from the equilibrium target distribution
and can be used for inference. The post burn-in monitoring period
draws empirically estimate the target posterior distribution and
provide the basis to estimate the probability of simulated output for
model design alternatives. For example, a robust estimate of the
peak flow with only a 1% chance of being exceeded.
7
HEC-HMS Version 4.3 Release Notes
8
HEC-HMS Version 4.3 Release Notes
now included in results summary table when observed stage or
observed pool elevation are selected.
9
HEC-HMS Version 4.3 Release Notes
10
HEC-HMS Version 4.3 Release Notes
file formats for storing polygons and polylines. In this way,
geospatial data can be added to existing elements in the basin
model. There is no upgrade of spatial data stored according to the
old conventions. Users should use the new georeferencing feature
to transfer spatial data from the Esri shapefiles to the new Spatial
Lite file.
Geospatial data continues to be required for subbasins when the
HMR52 precipitation method is used. The old spatial data must be
imported before the simulations using the HMR52 precipitation
method can be computed successfully.
11
HEC-HMS Version 4.3 Release Notes
use in coastal watersheds that otherwise met the usage criteria for
Muskingum Cunge routing. Negative elevations are now allowed.
However, a warning message is issued because in most
circumstances a negative elevation is incorrect.
12
HEC-HMS Version 4.3 Release Notes
13
HEC-HMS Version 4.3 Release Notes
FAO56 Radiation
It was discovered that the FAO56 shortwave and longwave
radiation methods were not correctly using the specified longitude.
The methods are intended to internally calculate the number of
degrees west of the zero longitude line. This difference in degrees
should be used in calculations. It was found that the longitude of
the subbasin was used in error instead of calculating the difference.
The calculations have now been corrected to use the difference in
degrees between the subbasin and zero longitude. This correction
may change computed results for previous projects.
14
HEC-HMS Version 4.3 Release Notes
Frequency Storm
The frequency storm precipitation method no longer allows an
unspecified or blank storm area. The storm area is used to
compute the correct depth-area reduction factor for the storm.
Previous versions allowed the storm area to be left blank, and then
automatically recomputed the storm for each subbasin using the
subbasin area as the storm area. This automatic behavior during a
simulation run is no longer allowed. A storm area must be specified
as part of the storm properties. There are still many applications
where it is necessary to compute results for various size storms
over the watershed. This application can be satisfied using the
depth-area analysis. The depth-area analysis allows the user to
select one or many locations in the basin model (potentially every
subbasin) and then the area in the frequency storm is automatically
adjusted to compute the correct storm at each selected location.
The conversion between annual duration and partial duration has
also been simplified. Choices are now provided for converting
annual duration input precipitation depths to partial duration output,
and for converting partial duration input to annual duration output.
These choices are provided for specific exceedance probabilities.
No conversion should be selected if the input data is annual
duration and an annual duration output is required. Additionally, no
conversion should be selected if the input data is partial duration
and a partial duration output is required. Finally, conversion is
never used for exceedance probabilities less frequent than 10%.
15
HEC-HMS Version 4.3 Release Notes
16
HEC-HMS Version 4.3 Release Notes
precipitation in the process of moving over the land surface. Save
states could be created at the end of simulation run or at the end of
any time interval during the run. The save states could be used
later to initialize a new simulation run. It was required that the
basin model be the same in both runs. It was also required that the
simulation time of the save states exactly match the start time of
the run using them for initialization.
Save states can now be used with both simulation runs and
forecast alternatives, and are also much more flexible. Save states
can now be created by both runs and forecasts. The save states
can be created at the end of a run or forecast, at the forecast time
during a forecast, or at the end of any time interval during the run or
forecast. Once a save state has been created, it can be used with
any other simulation run or forecast alternative regardless of how it
was created. There are no limits due to the basin model used or
the simulation time represented by the information in the save
states. If the basin model used to create the save states does not
match the basin model in the simulation using the states, a warning
message will be shown and the data in the states still used. If the
simulation time used to create the save states does not match the
start time of the simulation using the states, a warning message will
be shown and the data in the states still used. If a basin model
element cannot be found in the save states, then the values from
the basin model will be used.
In summary, save states can still be used to take a very long
simulation and break it into a sequence of simulation runs. For this
use, the saves states are created at the end of a run and used to
start the next run. It is now also possible to treat the save states
like an optional replacement for the initial conditions specified in the
basin model either for simulation runs or forecast alternatives.
Problems Repaired
Several errors were found in the program and repaired. Complete
descriptions of each error are given below.
17
HEC-HMS Version 4.3 Release Notes
Reservoir Evaporation
The outlet structures routing method in the reservoir allows various
ways of specifying how water leaves the storage. One of those
ways is by evaporation. The amount of evaporation can be
specified as a depth for each month of the year. It was discovered
that the evaporation for each time interval was calculated correctly,
but there was a unit conversion error when storing the time-series
of calculated evaporation. This means that the mass balance for
the reservoir storage was correct, but appeared wrong when
reviewing the stored time-series of evaporation. The unit
conversion error has been corrected and the stored time-series of
evaporation is now correct.
18
HEC-HMS Version 4.3 Release Notes
HMR52 Precipitation
It was discovered that under some circumstances the calculated
precipitation was displayed with values in millimeters but labels in
inches. However, the calculated values were correctly used in
subsequent calculations for infiltration and surface runoff. This
error was limited to basin models using the ModClark transform
method, and limited to the incorrect units label. All other transform
methods produced a precipitation display with values and labels
19
HEC-HMS Version 4.3 Release Notes
Copy Project
It was discovered that some project components were “lost” when
making a copy of a project. All components of the project were
reviewed to be sure they are included during the copy process.
The copy now correctly includes all components of the original
project.
XML Reports
It was discovered that subbasin components (canopy, surface, loss
rate, transform, and baseflow) were not placed below the subbasin
at the correct nesting level in the basin model XML file. It was also
discovered that the reservoir peak storage was not labeled correctly
in the simulation run XML file. For both reports, it was found that
the decimal separator used inside the XML files was not correct if
the program settings were configured to use a comma as the
decimal separator. Both XML reports have been corrected of all
three issues.
20
HEC-HMS Version 4.3 Release Notes
Documentation
The Hydrologic Modeling System HEC-HMS: Quick Start Guide
(Version 4.3 August 2018) provides a brief description of the
program for new users. It describes the different parts of the
interface and the basic steps necessary to obtain simulation results.
A tutorial takes the user through the creation of a new project and
shows how to obtain results. The guide has been updated to reflect
changes in the interface.
The Hydrologic Modeling System HEC-HMS: User's Manual
(Version 4.3 August 2018) contains extensive information on
installing and using the program. Details on the use of each of the
features and capabilities in the program are included. The manual
21
HEC-HMS Version 4.3 Release Notes
Support Policy
Technical support for program users within the U.S. Army Corps of
Engineers is provided through an annual subscription service.
Subscribing offices can expect full support from HEC staff in the
routine application of the program. Users are strongly urged to
consult with HEC staff on the technical feasibility of using the
program before beginning a project with unique requirements such
as grid cell hydrology, snow melt, continuous simulation, sediment
transport, or water quality. Special guidance is also available for
the development of models for flow forecasting. Extended support
for large or complex projects can be arranged under a separate
reimbursable project agreement.
Support cannot be provided to users outside the U.S. Army Corps
of Engineers. Several companies and organizations offer varying
levels of support, some through a fee-for-service support similar to
the support provided to subscribing Corps offices. Such service
agreements are between the user and the vendor and do not
include HEC staff. Vendors can be located through internet
searches.
22
HEC-HMS Version 4.3 Release Notes
Reporting of suspected program errors is unrestricted and we will
reply to all correspondence concerning such errors. We are
continuously working to improve the program and possible bugs
should always be reported. Reports should include a written
description of the steps that lead to the problem and the effects that
result from it. If we cannot reproduce the reported problem, we
may ask you to send a copy of your project.
Request support or report program errors through the following
channels:
23