This manual originated from a MS Word document with careful formatting.  Much of that formatting has changed with the shift to online documentation.  To some extent, these formatting standards still exist, but our contributors are attempting to adapt this to the current platform.  

"ResSim"

HEC-ResSim is the software's full name but it is easier to say and type just ResSim, so we do.

Bold Text

Words or phrases shown in Bold Text in Title Case indicate that the word or phrase refers to something you will see somewhere in the ResSim user interface. It may be the name of a menu, an option in a menu, the name of a dialog or editor, or the name of a data entry field or region.

Italic Text

Italic text is used to emphasize a word or phrase in a sentence.

Italic text is also used identify the name of a document or file.

A word or phrase shown in ItalicText in camelCase is a placeholder for something you should enter in its place. For example:
WatershedName.wksp
is a reference to a file that has the name of your watershed and the extension .wksp.

Underlined Text

Words or phrases that have been underlined represent the definition for a word or phrase in ResSim's terminology.

Menu → Menu Item

The → (arrow symbol) is used between menu selections in a sequence of selections or steps in sequence of steps. For example: Edit→Reservoir can be read as "from the Edit menu, select Reservoirs".

New icon image


New Features or program enhancements were previously marked with this image.

Now you can find lists of new features using each version's New or Updated Content pages under the Release Notes or see links on righthand sidebar.

Also look for NEW IN RESSIM VERSION or UPDATED IN RESSIM VERSION

Cloud with Rain image to mark disabled or malfunctioning feature in the user's manual

In previous versions of the user documentation, this storm cloud icon was used to mark a disabled or malfunctioning feature. Like rain in California, this was an unusual occurrence so you wouldn't see a lot of these in the manual.

As the program advanced and become more complex, there have been more bugs identified than we are able to fully addressed on a reasonable timeline. Starting with the release of ResSim 3.5 (2024), we have attempted to document all major known issues and continue adding known issue documentation if new bugs are found.  Find a list of each version's Known Issues under the Release Notes or see links on righthand sidebar. Also look for the BUG IN VERSION X tags. 

Tips are added where we wanted to make an instruction or description standout. Sometimes, a Tip will provide a "how-to" for a "hidden feature" that we wanted to share where it seemed most logical. For example, see the Tip in the section on creating a New Simulation.

Warnings are used to tell you to be careful, or to watch out for something, or to just not do something.

Notes are used to share information that you should take special note of. They are intended to emphasize a point or to tell you something beyond the how-tos of the ResSim user interface.

Lists of Release Notes

Lists of New or Updated Content

Lists of Known Issues