CWMS comes pre-packaged with the latest model builds at the time of release. Sometimes, you might want to upgrade the HEC-HMS version before the next build of CWMS is released. HEC-HMS can be downloaded here.

This tutorial is arranged by the CWMS version you are using and which HEC-HMS version you want to upgrade to.

If the HEC-HMS model (both the HEC-HMS build currently in CWMS and the build you are upgrading to) fall within in the same range listed below, modifications to the CAVI.config are not needed. You only need to complete steps 1 through 3.

In-depth CWMS testing by HEC is only performed using HEC-HMS builds between released CWMS builds. Example: CWMS 3.1.1 was only tested by HEC with HMS versions 4.2.1 through 4.5. Anything after HEC-HMS 4.5 was likely not tested by HEC within CWMS 3.1.1.

It is always recommended to use the latest version of the software (whether it is CWMS or HEC-HMS in this case). We included older versions for completion purposes but do not encourage the use of outdated software.

CWMS 3.4/3.4.1

Originally packaged with HEC-HMS 4.12

HEC-HMS 4.13 Beta

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/ directory.

CWMS 3.3.0/3.3.1

Originally packaged with HEC-HMS 4.10

HEC-HMS 4.11 - 4.13 Beta

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/ directory.


CWMS 3.2.2/3.2.3

Originally packaged with HEC-HMS 4.8

HEC-HMS 4.9 - 4.13 Beta

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/ directory.

CWMS 3.2.1

Originally packaged with HEC-HMS 4.5

HEC-HMS 4.8 - 4.12

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/ directory.
  4. Open the ../CAVI/CAVI.config file.
  5. Scroll to the bottom of the config file.
  6. Replace the addjar ../HEC-HMS/lib/hms-command-1.0.jar statement with addjar ../HEC-HMS/lib/hms-command-1.1.jar
    1. Be sure to use only two periods when referencing the hms-command-1.1.jar

HMS 4.6-4.7.1

  1. Remove the previous HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HMS build.
  3. Paste the contents of the HMS build in to the ../HEC-HMS/ directory.

CWMS 3.1.1

Originally packaged with HEC-HMS 4.2.1

HEC-HMS 4.8 - 4.11 Beta

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/ directory.
  4. Open the .../CAVI/CAVI.config file.
  5. Scroll to the bottom of the config file.
  6. If upgrading from HEC-HMS 4.2.1: Replace the addjar ../HEC-HMS/hms.jar statement with addjar ../HEC-HMS/lib/hms-command-1.1.jar
    1. Be sure to use only two periods when referencing the hms-command-1.1.jar
  7. If upgrading from HEC-HMS 4.3 through 4.7.1: Replace the addjar ../HEC-HMS/lib/hms-command-1.0.jar statement with addjar ../HEC-HMS/lib/hms-command-1.1.jar

HEC-HMS 4.5-4.7.1

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/directory.
  4. Copy hms-command-1.0.jar from <HMS root>/lib directory into <CWMS root>/CAVI/jar directory.
  5. Open the /CAVI/CAVI.config file.
  6. Scroll to the bottom of the .config file.
  7. Replace the addjar ../HEC-HMS/hms.jar statement with addjar ../HEC-HMS/lib/hms-command-1.0.jar
    1. Be sure to use only two periods when referencing the hms-command-1.1.jar

HEC-HMS 4.3-4.4

  1. Remove the previous HEC-HMS build from the ../HEC-HMS/ directory.
  2. Copy the contents of the new HEC-HMS build.
  3. Paste the contents of the HEC-HMS build in to the ../HEC-HMS/directory.
  4. Open the hmsServer.template file.
  5. Scroll to the bottom of the .template file.
  6. Add setenv $SETEN" at the bottom.