Page History

...

An October 2019 development has made parameter updating of elements in the *.basin and *.met files possible. See the paragraph on parameter updating 

Operating HEC-HMS Model and FEWS Adapter

The HEC-HMS model provides the compute engine for running a rainfall runoff model schematization for a basin or a system of basins. the modelling options include also routing. The HEC-HMS Adapter forms the interface between the FEWS Forecasting Shell and the HEC-HMS model.

The HEC-HMS compute engine is, as its name suggests, the component that actually performs the HEC-HMS simulation. This simulation is controlled from the FEWS Adapter, and all run time data such as initial and boundary conditions are passed through the adapter from and to the FEWS Forecasting Shell.

Applications

An earlier version of the HEC-HMS adapter has been implemented in various configurations (December 2010):

1. FEWS Po (Paolo Reggiani)
2. FEWS Georgia (Paolo Reggiani)
3. Sudan FEWS (Jan Verkade)
4. FEWS Trinidad (Matthijs Lemans)

An improved version of the adapter has been developed and is implemented in the following configurations:

. This adapter version is based on 32-bit binaries and Java 8 and was developed for HEC-HMS models with version 4.2.1.

In August 2021 the HEC-HMS adapter has been updated to work with HEC-HMS models of version 4.8. This adapter is based on 64-bit binaries and Java 11. This adapter version is not backwards compatible with 32-bit HEC-HMS models (v. 4.4.1 and earlier) and has not been tested with 64-bit HEC-HMS model before v. 4.8 (4.5/4.6/4.7).  

Operating HEC-HMS Model and FEWS Adapter

The HEC-HMS model provides the compute engine for running a rainfall runoff model schematization for a basin or a system of basins. the modelling options include also routing. The HEC-HMS Adapter forms the interface between the FEWS Forecasting Shell and the HEC-HMS model.

The HEC-HMS compute engine is, as its name suggests, the component that actually performs the HEC-HMS simulation. This simulation is controlled from the FEWS Adapter, and all run time data such as initial and boundary conditions are passed through the adapter from and to the FEWS Forecasting Shell.

Applications

An earlier version of the HEC-HMS adapter has been implemented in various configurations (December 2010):

1. FEWS Po (Paolo Reggiani)
2. FEWS Georgia (Paolo Reggiani)
3. Sudan FEWS (Jan Verkade)
4. FEWS Trinidad (Matthijs Lemans)

An improved version of the adapter has been developed and is implemented in the following configurations:

1. FEWS CEMIG (Jan Talsma, Dirk Schwanenberg)
2. FEWS Salto Grande (Jan Talsma, Otto de Keizer)
3. FEWS Colombia (
4. FEWS CEMIG (Jan Talsma, Dirk Schwanenberg)
5. FEWS Salto Grande (Jan Talsma, Otto de Keizer)
6. FEWS Colombia (Micha Werner, Otto de Keizer)
7. Bandon FFS (Jan Verkade, in co-operation with University College Cork)
8. Mura Drava FFS (Jan Verkade, in co-operation with the University of Zagreb)
9. FEWS Sava (Klaas-Jan van Heeringen, Daniel Tollenaar, Arjen Haag)

In October 2019 the HEC-HMS adapter was improved with Parameter Updating capabilities for the preAdapter and updated to work with HEC-HMS models of version 4.2.1. This adapter is implemented in the following configurations:

1. FEWS Manitoba Hydro (Ivo Miltenburg, Ben Balk)

Download

In August 2021 the HEC-HMS adapter was improved with Subbasin Snowmelt Parameter Updating capabilities for the preAdapter, to work with HEC-HMS models of version 4.8. This adapter is implemented in the following configurations:

1. FEWS Manitoba Hydro (Ivo Miltenburg, Ben Balk)

Download

Download Download of the model adapter is not available here: please e-mail to Delft-FEWS Product Management for more information.
A tutorial of how to add a HEC-HMS model as an adapter in FEWS is attached.

...

The hechms files (.basin, .contol, .gage, .hms, .pdata, .run, .script, .met, .dss etc.)are saved in the /Config/ModuleDataSet directory. These are copied to the /Model/hechms/<model> directory during the exportDataSet activity in the General Adapter file.

...

• Please note that running the pre/post adapter based on 32-bit binaries (for HEC-HMS model version 4.2.1, developed in October 2019) requires the definition of a <customJreDir>$CUSTOMJRE_32B_DIR$</customJreDir> element, as Delft-FEWS itself is 64-bit.
• Running the pre/post adapter based on 64-bit binaries (for HEC-HMS model version 4.8, developed in August 2021) does not require the definition of a custom java, as the Delft-FEWS java version can be used.

Anchor
HEC-HMS parameter updating HEC-HMS parameter updating

HEC-HMS Parameter updating

A development (October 2019) for the HEC-HMS adapter (for HEC-HMS models with version 4.2.1) has made it possible to update parameters. The following parameter updates are supported:

• All parameters for the Subbasin elements in the *.basin HEC-HMS file
• All parameters for the Reach elements in the *.basin HEC-HMS file
• All parameters for the (globally defined) Snow Method Parameter element in the *.met HEC-HMS file

An new (August 2021) 64-bit HEC-HMS adapter (for HEC-HMS models with version 4.8) retains the original parameter updating functionality, but has this extended withsupport for he following parameter updates:

• All parameters for the subbasin specific Snow Method Parameter elements in the *.met HEC-HMS file

To use this capability various FEWS configuration setup is required.

1. The correct HEC-HMS binAdapter needs to be placed in \Config\ModuleDataSetFiles\HEC-HMS_bin.zip (binAdapter directory) and the binaries need to be exported to the Modules.
2. The subbasins/reaches (from the model *.basin file) and the snowmelt method (in the model *.met file) from the (multiple) HEC-HMS models need to be defined as locations with their own unique (FEWS) locationId. The locationId's under which they are known in the HEC-HMS model need to extracted from the *.basin file and stored as an attribute, so they can be exported correctly. Note that the pre adapter is case insensitive: when a subbasin in the *.basin file has the id 'location a', the pre adapter will match it with a paramter defined as 'LOCATION A'.
3. For each of the locations where parameter updating is required, the parameter values need to configured as attributes (define a .csv file and create a suitable locationSet)
4. To be able to see the parameters for the various HEC-HMS models in the Delft-FEWS interface, the ModifierTypes.xml can be extended with a locationAttributeModifier section as can be seen below. The modifier can be linked with the relevant HEC-HMS model run Topology Nodes
   
   Image Added
   
   

5. A (template) ModuleParFile configuration is required, to allow for Parameter updating by the pre adapter. In the GA, under <exportParameterActivity> the modulePar template file is referenced, providing the 'model' and a 'locationSet'. For each of the locations in the locationSet, the '@attributes'@ need to be defined. An example f the configuration can be seen below
   
   

   Code Block
   xml xml
   <?xml version="1.0" encoding="UTF-8"?> <parameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews/PI" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_modelparameters.xsd" version="1.5"> <modifierType>HECHMS_Parameters</modifierType> <group id="HECHMS_Basin_Subbasin_Parameters" name="HEC-HMS Basin Subbasin Parameters"> <locationId>@hec_ext_subbasin_id@</locationId> <model>HECHMS_B_SB</model> <parameter id="Time of Concentration"> <intValue>@time_of_concentration@</intValue> </parameter> <parameter id="Storage Coefficient"> <intValue>@storage_coefficient@</intValue> </parameter> </group> <group id="HECHMS_Basin_Reach_Parameters" name="HEC-HMS Basin Reach Parameters"> <locationId>@hec_ext_reach_id@</locationId> <model>HECHMS_B_R</model> <parameter id="Muskingum K"> <intValue>@muskingum_k@</intValue> </parameter> </group>

A development (October 2019) for the HEC-HMS adapter has made it possible to update parameters. The following parameter updates are supported:

• All parameters for the Subbasin elements in the *.basin HEC-HMS file
• All parameters for the Reach elements in the *.basin HEC-HMS file
• All parameters for the Snow Method Parameter element in the *.met HEC-HMS file

To use this capability the various FEWS configuration is required.

1. The correct HEC-HMS binAdapter needs to be placed in \Config\ModuleDataSetFiles\HEC-HMS_bin.zip (binAdapter directory) and the binaries need to be exported to the Modules.
2. The subbasins/reaches (from the model *.basin file) and the snowmelt method (in the model *.met file) from the (multiple) HEC-HMS models need to be defined as locations with their own unique (FEWS) locationId. The locationId's under which they are known in the HEC-HMS model need to extracted from the *.basin file and stored as an attribute, so they can be exported correctly. Note that the pre adapter is case insensitive: when a subbasin in the *.basin file has the id 'location a', the pre adapter will match it with a paramter defined as 'LOCATION A'.
3. For each of the locations where parameter updating is required, the parameter values need to configured as attributes (define a .csv file and create a suitable locationSet)
4. To be able to see the parameters for the various HEC-HMS models in the Delft-FEWS interface, the ModifierTypes.xml can be extended with a locationAttributeModifier section as can be seen below. The modifier can be linked with the relevant HEC-HMS model run Topology Nodes
   Image Removed
   A (template) ModuleParFile configuration is required, to allow for Parameter updating by the pre adapter. In the GA, under <exportParameterActivity> the modulePar template file is referenced, providing the 'model' and a 'locationSet'. For each of the locations in the locationSet, the '@attributes'@ need to be defined. An example f the configuration can be seen below
   

   Code Block
   xml	xml	<?xml version="1.0" encoding="UTF-8"?> <parameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews/PI" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_modelparameters.xsd" version="1.5"> <modifierType>HECHMS_Parameters</modifierType> <group id="HECHMS_BasinMet_Subbasin_Parameters" name="HEC-HMS BasinMet Subbasin Parameters"> <locationId>@hec_ext_snowmelt_subbasinmethod_id@</locationId> <model>HECHMS_B_SB<M</model> <parameter id="TimeBase of ConcentrationTemperature"> <intValue>@time<dblValue>@base_of_concentration@<temperature@</intValue>dblValue> </parameter> <parameter id="Storage CoefficientSnow vs Rain Temperature"> <intValue>@storage_coefficient@</intValue><dblValue>@snow_vs_rain_temperature@</dblValue> </parameter> </group> <group<parameter id="HECHMS_Basin_Reach_Parameters" name="HEC-HMS Basin Reach ParametersDry Melt Rain Rate Limit"> <locationId>@hec <dblValue>@dry_extmelt_reachrain_id@<limit@</locationId>dblValue> <model>HECHMS_B_R</model></parameter> <parameter id="MuskingumRain Melt KRate"> <intValue>@muskingum<dblValue>@rain_melt_k@<rate@</intValue>dblValue> </parameter> </group> <group id="HECHMS_Met_Subbasin_Parameters" name="HEC-HMS Met Subbasin Parameters"> <locationId>@hec_ext_snowmelt_methodloc_id@</locationId> <model>HECHMS_M_M<SB</model> <parameter id="Base Temperature"> <dblValue>@base_temperature@</dblValue> </parameter> <parameter id="Snow vs Rain Temperature"> <dblValue>@snow_vs_rain_temperature@</dblValue> </parameter> <parameter id="Dry Melt Rain Rate Limit"> <dblValue>@dry_melt_rain_temperature@<limit@</dblValue> </parameter> <parameter id="DryRain Melt Rain Rate Limit"> <dblValue>@dry<dblValue>@rain_melt_rain_limit@<rate@</dblValue> </parameter> <parameter id="RainMelt Rate ATI-Melt Rate Table Name"> <dblValue>@rain<stringValue>@melt_rate ati_melt_rate_rate@<table_name@</dblValue>stringValue> </parameter> </group> </parameters>

   An example of the resulting parameter file for the Basin - Subbasin parameters that will be exported to the HEC-HMS modules directory:
   
   

5. To instruct the preAdapter to update parameters, some specific keys need to be provided to the runInfo file. In the exportRunFileActivity in the GA we require the following keys for parameter updating:

   
   

   1. hmsProjectFile
      reference the model *.hms file. This file contains the references to the filenames of the ‘Precipitation’ file (*.met) and the Basin file (*.basin)

   2. hmsScriptFile
      not required for the parameter updating, but it is required for the adapter in generalfor the adapter in general

   3. Basin_Subbasin_Params_File
      When we want to update subbasin parameters in the *.basin file, we need to define this Key and provide the reference to the params file that contains the location/parameter combinations to be updated

   4. Basin_ReachBasin_Subbasin_Params_File
      When we want to update subbasin reach parameters in the *.basin file, we need to define this Key and provide the reference to the params file that contains the location/parameter combinations to be updatedBasin

   5. Precipitation_ReachSnowMelt_Params_File
      When we want to update reach globally defined Snowmelt Method parameters in the *.basin met file, we need to define this Key and provide the reference to the params file that contains the location/parameter combinations to be updated
      Note that is is required that the locationId of the Snowmelt Method is equal to the method as defined in the HEC-HMS *.met file 

      Image Added

   6. Precipitation_SnowMelt_Subbasin_Params_File
      When we want to update subbasin specific defined Snowmelt Method parameters in the *.met file (available in HEC-HMS model version 4.8), we need to define this Key and provide the reference to the params file that contains the location/parameter combinations to be updated
      Note that is is required that the locationId of the Snowmelt Method Parameter group is equal to the method subbasin location as defined in the HEC-HMS *.met file 
      

   Image Removed

   1. Image Added

   
   

The pre adapter is instructed by the defined properties to update the parameters, using the exported params files. 

...