Prepared by

Barry Croke, Felix Andrew,

Jessica Spate, Susan Cuddy

www.toolkit.net.au/ihacres

USER GUIDE
Document History
Date Author Version Edition Description of Change
2 Feb 2004 Susan Cuddy V1 First compilation of material
24 Nov 2004 Felix Andrews V1.1 Fixed definitions of objective functions, v2.0.0.
30 Nov 2004 Susan Cuddy V1.2 Synched with website details, v2.0.0
Synched with software version for transfer to toolkit product.
11 Jan 2005 Susan Cuddy v2.1
Amended minor errors
19 Jan 2005 Nick Murray v2.1 Fixed minor formatting errors & updated to latest Template
14 Feb 2005 Susan Cuddy v2.1 First Finalised for release
28 Apr 2005 Susan Cuddy v2.1.0 Second Updates to description of Instrumental Variable

Copyright notice
© The Australian National University, Australia 2005

Legal Information
To the extend permitted by law, the Australian National University and the Cooperative Research Centre for
Catchment Hydrology (including its employees and consultants) accept no responsibility and exclude all
liability whatsoever in respect of any person's use or reliance on this publication or any part of it.

Availability
Distribution of the IHACRES software package is via the CRC for Catchment Hydrology’s Catchment
Modelling Toolkit website under an agreement between the Integrated Catchment Assessment and
Management (iCAM) Centre of The Australian National University and the Cooperative Research Centre for
Catchment Hydrology.
The Product Manager for IHACRES is Dr Barry Croke of the iCAM Centre, The Australian National
University, barry.croke@anu.edu.au.

Reference
Croke, BFW, F Andrews, J Spate and SM Cuddy (2005) IHACRES User Guide. Technical Report 2005/19.
Second Edition. iCAM, School of Resources, Environment and Society, The Australian National University,
Canberra. http://www.toolkit.net.au/ihacres

Contact Details
CRCCH Toolkit website - http://www.toolkit.net.au
Integrated Catchment Assessment and Management Centre
http://icam.anu.edu.au/
School of Resources, Environment and Society
Building 48A Linneaus Way
The Australian National University
Acton ACT 0200

Revisions
IHACRES is under active development and has a planned delivery schedule of new and/or revised features
for the period 2004-2005. This User Guide will be updated as necessary to reflect these revisions.
Acknowledgements
IHACRES v2 is a major reimplementation of the original IHACRES model (hereafter known as
the Classic version).
It has been recoded to incorporate additional functionality by its ANU development team,
with the support of a team of beta testers who have extensive experience with the original
version of IHACRES. The development team would like to acknowledge the contribution
made by the following testers:
• Dr Ian Littlewood, Centre for Ecology and Hydrology, Wallingford, Oxfordshire, UK
• Dr Jeff Chanat, Univesity of Virginia, USA
• Dr Teemu Kokkonen, Helsinki University of Technology, Finland
• Dr Barbara Baginska, Environment Protection, Department of Environment and
Conservation, New South Wales, Australia.
Coding and core debugging have been by Alex Luddy and Felix Andrews of the ANU
development team within the Integrated Catchment Assessment and Management (iCAM)
Centre.
Tutorials have been designed and written by Jessica Spate, a PhD student at ANU and in-
house tested by Michael Kehoe.
This User Guide has been compiled by Susan Cuddy, iCAM Centre and CSIRO Land and
Water, from material written by Alex Luddy, Barry Croke, Felix Andrews and Jessica Spate.
 Contents

IHACRES
CONTENTS

1 Introduction...........................................................1
1.1 The user guide.............................................................................................. 1
1.2 IHACRES...................................................................................................... 2
1.2.1 Overview .................................................................................... 2
1.2.2 Features ..................................................................................... 2
1.2.3 Audience .................................................................................... 3
1.3 Data requirements......................................................................................... 3
1.3.1 Input data................................................................................... 3
1.3.2 Predicted or calculated data.......................................................... 3
1.4 Product components...................................................................................... 3
1.5 Supporting material....................................................................................... 4
1.5.1 Companion documents ................................................................ 4
1.5.2 Key scientific references ................................................................ 4
Original IHACRES model.............................................................. 4
PC-IHACRES (Classic v1).............................................................. 4
IHACRES_v2.0 (Classic Plus) ......................................................... 4
Modification for ephemeral catchments .......................................... 4
Catchment moisture deficit............................................................ 4
1.5.3 Workshops.................................................................................. 5

2 Installation ............................................................6
2.1 Technical specifications.................................................................................. 6
2.2 Licence agreement ........................................................................................ 6
2.3 Folders ........................................................................................................ 7
2.4 Installation ................................................................................................... 7
2.4.1 Windows and non-Windows.......................................................... 7
2.4.2 Data .......................................................................................... 7
2.4.3 Start menu icons.......................................................................... 7
2.5 Uninstalling IHACRES .................................................................................... 7
2.6 User interface ............................................................................................... 8
2.6.1 Terminology................................................................................ 8
2.6.2 Charting functions ....................................................................... 8
2.6.3 Navigation.................................................................................. 9

3 A quick tour.........................................................10

i
IHACRES User Guide

3.1 Getting started.............................................................................................10

3.1.1 Running IHACRES.......................................................................10
3.1.2 Loading and creating projects ......................................................10
3.2 The three modes ..........................................................................................11
3.2.1 Data .........................................................................................11
3.2.2 Calibration ................................................................................11
3.2.3 Simulation .................................................................................13

4 Using IHACRES....................................................14
4.1 General concepts.........................................................................................14
4.1.1 Project files ................................................................................14
4.1.2 Statistics ....................................................................................14
4.2 Data...........................................................................................................15
4.2.1 Data > Summary .......................................................................15
4.2.2 Data > Import ...........................................................................15
4.2.3 Data > View ..............................................................................16
4.3 Calibration..................................................................................................16
4.3.1 Calibration > Periods .................................................................16
Add a calibration period..............................................................17
Remove a calibration period ........................................................17
Multiple calibration periods .........................................................17
4.3.2 Calibration > Model ..................................................................17
4.3.3 Calibration > Model - Linear Module ...........................................18
Model > Delay ..........................................................................18
Model > Cross correlation ..........................................................18
Model > Instrumental Variable ....................................................18
Model > Fixed Transfer Function..................................................19
4.3.4 Calibration > Model - Non Linear Module....................................19
Model > Grid Search .................................................................19
Grid Search > Pre Grid Search....................................................19
Grid Search > Run Grid Search...................................................20
Grid Search > Charts .................................................................20
Grid Search > Post Grid Search...................................................21
Grid Search > Analysis ...............................................................21
4.4 Simulation...................................................................................................22
4.4.1 Simulation > Calibration.............................................................22
4.4.2 Simulation > Simulation Summary................................................22
4.4.3 Simulation > Statistic Summary ....................................................22
4.4.4 Simulation > Charts ...................................................................23
4.4.5 Simulation > Hydrograph............................................................23

ii
 Contents

5 Tutorial ...............................................................24
5.1 Overview ................................................................................................... 24
5.2 Steps ......................................................................................................... 24
5.3 Step 1 – load the data ................................................................................. 25
5.3.1 Observed rainfall....................................................................... 25
5.3.2 Observed streamflow ................................................................. 26
5.3.3 Temperature ............................................................................. 27
5.4 Step 2 – check the data ............................................................................... 27
5.4.1 Data > Summary ...................................................................... 27
5.4.2 Data > View ............................................................................. 27
5.5 Step 3 – define the calibration period(s) ......................................................... 28
5.6 Step 4 – calibrate the linear module .............................................................. 29
5.6.1 Cross-Correlation ...................................................................... 29
Pre Cross Correlation................................................................. 29
Instrumental Variable ................................................................. 30
5.7 Step 5 – calibrate the non-linear module ....................................................... 30
5.7.1 Grid search............................................................................... 30
Pre Grid Search......................................................................... 30
Instrumental Variable ................................................................. 31
Post Grid Search – find a suitable parameter set............................ 32
Post Grid search – refine the parameter set................................... 34
Accept the parameter set ............................................................ 34
5.8 Step 6 - simulation ...................................................................................... 36
Statistic Summary....................................................................... 36
Discussion of simulation results.................................................... 37
Simulation summary................................................................... 37
Charts ...................................................................................... 37
5.9 Exercise...................................................................................................... 38

6 Fitting models......................................................39
6.1 Calibration................................................................................................. 39
6.1.1 Linear module ........................................................................... 39
Instrumental variable (IV) estimator .............................................. 39
Fixed transfer function ................................................................ 40
6.2 Model performance..................................................................................... 40
6.2.1 Calibration period ..................................................................... 40
6.2.2 Catchment size.......................................................................... 41
6.2.3 Timestep................................................................................... 41
Monthly data............................................................................. 41
Catchment size and timestep....................................................... 41

iii
IHACRES User Guide

6.2.4 Ungauged catchments ................................................................41

6.3 References ..................................................................................................42

7 Troubleshooting ..................................................43
7.1 NaN...........................................................................................................43

Appendix A - Data Files ................................................44

A.1 - User provided files ............................................................................................44
A.2 - IHACRES files ...................................................................................................44
A.2.1 - Configuration file (configuration.txt) ....................................................44
A.2.2 - Project files (.ipr) ...............................................................................45
A.2.3 - Grid search files (.igs)........................................................................45
A.2.4 - Log file (ihacres_log.txt) .....................................................................45
A.3 - Results files.......................................................................................................45

iv
 Contents

TABLE OF FIGURES
Figure 3-1 IHACRES command panel ...............................................................................................10
Figure 3-2 Data > Summary Panel showing the status of the Murrindindi tutorial data ..........................11
Figure 3-3 Calibration > Model panel .............................................................................................12
Figure 3-4 Calibration > Model panel after model calibration............................................................13
Figure 3-5 Simulation > Calibration > Streamflow panel after calibration complete .............................13
Figure 5-1 Data Summary screen for Murrindindi River (Data > Summary)............................................25
Figure 5-2. Import screen showing Murrindindi streamflow and rainfall data (Data > Import)..................26
Figure 5-3 Viewing Murrindindi River data (Data > View) ....................................................................28
Figure 5-4 Calibration periods screen for Murrindindi (Calibration > Periods) .......................................28
Figure 5-5 Pre Cross Correlation Chart for Murrindindi data (Calibration > Calibration Period 1 >
Pre Cross Correlation) ......................................................................................................30
Figure 5-6 Grid Search parameters for Murrindindi data (Calibration > Calibration Period 1 > Pre
Grid Search) ....................................................................................................................32
Figure 5-7 Grid search results for Murrindindi, sorted by Efficiency (R2) (Calibration > Calibration
Period 1 > Post Grid Search) ............................................................................................33
Figure 5-8 Analysis of Most Efficient (R2) Grid Search result for Murrindindi streamflow (Calibration >
Calibration Period 1 > Analysis > Streamflow) ...................................................................33
Figure 5-9 Accepted parameter sets for Murrindindi (Calibration > Calibration Period 1 > Analysis).......35
Figure 5-10 Calibrated model for Murrindindi River ............................................................................35
Figure 5-11 Hydrograph of simulated vs observed flow for Murrindindi (Simulation) ...............................36
Figure 5-12 Statistic Summary for Murrindindi simulation (Simulation > Statistic summary) .....................37

TABLE OF TABLES
Table 2.1 2D chart manipulation functions..........................................................................................8
Table 2.2 3D chart manipulation functions..........................................................................................8
Table 2.3 Chart range selector functions.............................................................................................9
Table 3.1 File > Menu actions.........................................................................................................11
Table 4.1 Statistics used in IHACRES ................................................................................................14
Table 4.2 Table of Post Grid Search Chart types................................................................................20
Table 4.3 Chart types available when displaying Simulation Data........................................................23

v
This page intentionally left blank
 Introduction

1 Introduction
IHACRES is a catchment-scale rainfall-streamflow modelling methodology. Its purpose is to
assist the hydrologist or water resources engineer to characterise the dynamic relationship
between basin rainfall and streamflow. Applications include:
• identification of unit hydrographs
• continuous time series streamflow modelling
• environmental change – hydrological regime studies
• runoff event modelling
• hydrograph separation (for example, to assist with water quality investigations)
• derivation of a Slow Flow Index
• derivation of Dynamic Response Characteristics
• investigation of relationships between Dynamic Response Characteristics and physical
catchment descriptors
• teaching unit hydrograph theory and its applications
• hydrometric data quality assurance/control (QA/QC)
• infilling missing streamflow data.

1.1 The user guide

This User Guide provides instruction on the three main components of IHACRES, namely:
• data and its preparation
• calibration
• simulation.
Instruction is provided via tutorials which are distributed with the software package, along
with the necessary data.
The purpose of the User Guide is to give instruction on how to use the package and its
interface. The methodology and several of its applications are well documented in the
scientific literature (see Section 1.5.2 for key references).

1
IHACRES User Guide

1.2 IHACRES

1.2.1 Overview
The emphasis in IHACRES is on modelling identifiable catchment-scale rainfall-runoff
behaviour rather than the small-scale hydrological processes by which rainfall causes
streamflow.
To run IHACRES, it must first be calibrated to optimise the performance over a known period.
In this way a catchment can be characterised by a small set of parameters. The model takes
as input, once calibrated, time series of rainfall and either temperature or potential evapo-
transpiration. The output is a time series of modelled stream flow. For the calibration period
and the validation period, observed stream flow is also available – this allows measures of
performance to be computed.
Calibration has two modules, in series:
• a non-linear loss module
• A linear unit hydrograph module.
The linear relationship between effective rainfall and streamflow allows the application of
well-known unit hydrograph theory which conceptualises the catchment as a configuration of
linear storages acting in series and/or parallel. All of the non-linearity commonly observed
between rainfall and streamflow is accommodated in the (non-linear loss) module which
converts rainfall to effective rainfall.
Conceptualisation of spatially distributed processes in both the non-linear and linear modules
is restricted. An advantage of this spatially “lumped” approach is that the model requires
only a small number of parameters, typically six (3 for the non-linear loss module and 3 for
the linear unit hydrograph module). Despite this structural simplicity, the IHACRES
methodology performs well for many types of catchment.
The IHACRES Classic Plus package is built on the Java platform and requires the Java
Runtime Environment, Java3D and VisAD (Visualisation for Algorithm Development) to be
installed on the computer. Version specifications and download sites for these software
packages are given in Section 2.1.

1.2.2 Features
IHACRES Classic Plus is a (Java) re-development of the original PC-Windows version
(Littlewood et al., 1997) . It retains all the original features, plus:
• the original non-linear loss module including the extension for ephemeral catchments
made by Ye et al, 1997)
• extension of the linear routing module to include all possible second order transfer
functions
• a cross correlation tool
• additional goodness of fit indicators
• visualisation tools including zoomable and 3-D plots.
While the last feature is purely an enhancement, the others are refinements of core methods
and are described in the key references.
Features under development include:
• baseflow filtering
• direct estimation of the unit hydrograph
• spectral analysis tools

2
 Introduction

• the catchment moisture deficit (CMD) version of the non-linear module (Croke and
Jakeman, 2004).

1.2.3 Audience
The IHACRES software is intended for scientists and practitioners who are interested in the
development of predictive models of catchment runoff.

1.3 Data requirements

1.3.1 Input data

IHACRES requires three sets of time series data. These are:
• observed rainfall (in millimetres or inches)
• temperature (in degrees Celsius, Fahrenheit, or Kelvin) or
evapo-transpiration (in millimetres or inches)
• observed streamflow (in cubic metres per second, megalitres per time step, millimetres
per time step, litres per second, or cubic feet per second).
These data must be in delimited ASCII text format (white space is ignored). Each time series
can be stored in one file (3 separate columns), or in three separate files.
Three timesteps are supported (minutes, hours and days).
Depending on the measurements units used for the above datasets, catchment area (in sq
kms) may be required.

1.3.2 Predicted or calculated data

A time series of modelled streamflow is produced, along with multiple statistics which
describe the characteristics of each series. Nearly all data and tables can be exported as
comma delimited ASCII text files and are also viewable as graphs within the package.
The results of various grid searches conducted as part of calibration can be saved as .igs files
which can be re-loaded. Additionally, the state of the project, once data has been loaded,
can be saved as a project (.ipr) file.

1.4 Product components

While IHACRES has two modes – calibration and simulation – it is bundled as one product,
available on one CD or downloadable from the Toolkit website. The name of the file
reflects the version. For example, the file
• IHACRES-2.1-setup.jar
installs version 2.1 of IHACRES Classic Plus.
This installer file is typically ~7Mb in size. It contains the software, the User Guide,
instruction and data for self-guided tutorial, and release notes.

3
IHACRES User Guide

1.5 Supporting material

1.5.1 Companion documents

IHACRES Workbook
This workbook contains worked examples that build calibrated IHACRES models for a range
of hydrologically dissimilar catchments.

1.5.2 Key scientific references

IHACRES has been extensively written up in the scientific literature. Key references are:

Original IHACRES model

Jakeman, AJ, GM Hornberger (1993) How much complexity is warranted in a rainfall-runoff
model? Water Resources Research 29(8), pp2637-2649.
Jakeman, AJ, IG Littlewood, PG Whitehead (1990) Computation of the instantaneous unit
hydrograph and identifiable component flows with application to two small upland
catchments. Journal of Hydrology, 117, pp275-300.
Littlewood, IG, AJ Jakeman (1994) A new method of rainfall-runoff modelling and its
applications in catchment hydrology. In: P Zannetti (ed) Environmental
Modelling, Volume II, Computational Mechanics Publications, Southampton, UK,
pp143-171.

PC-IHACRES (Classic v1)

Littlewood, IG, K. Down, J.R. Parker and D.A. Post. (1997) IHACRES: Catchment-scale
rainfall-streamflow modelling (PC version) Version 1.0 - April 1997. Institute of
Hydrology, Centre for Ecology and Hydrology, Wallingford, Oxon, UK.
http://www.nwl.ac.uk/ih/www/products/mswihacres.html

IHACRES_v2.0 (Classic Plus)

Croke, B.F.W., Andrews, F., Jakeman, A.J., Cuddy, S. and Luddy, A. (2005). Redesign of the
IHACRES rainfall-runoff model, to appear in the proceedings of the 29th
Hydrology and Water Resources Symposium, Engineers Australia, February 2005.

Modification for ephemeral catchments

Ye, W., B. C. Bates, N. R. Viney, M. Sivapalan and A. J. Jakeman 1997, "Performance of
conceptual rainfall-runoff models in low-yielding ephemeral catchments", Water
Resources Research, vol 33, pp 153-166.

Catchment moisture deficit

Croke, B.F.W. and A.J. Jakeman 2004, "A Catchment Moisture Deficit module for the
IHACRES rainfall-runoff model", Environmental Modelling and Software, vol 19,
pp 1-5.
Dye P.J. and B. F. W. Croke 2003, "Evaluation of streamflow predictions by the IHACRES
rainfall-runoff model in two South African catchments", Environmental Modelling
and Software, vol 18, pp 705-712.

4
 Introduction

1.5.3 Workshops
Training workshops are available on demand. Contact the Product Manager1 for details or
see www.toolkit.net.au/training.

1
Name and contact details of the current Product Manager are available from the IHACRES
Product page of the CRCCH Modelling Toolkit website http://www.toolkit.net.au. Details (current
at the production of this User Guide) are on the inside cover of this Guide.

5
IHACRES User Guide

2 Installation
2.1 Technical specifications
IHACRES is built on the Java platform and is platform independent.

Type of machine
Minimum CPU Pentium II (equivalent of)
Minimum memory 128Mb
Minimum available 10Mb, dependent on number of projects that are created. Project size is a
disk space function of the length of the time series which determines the size of the input and
output files. Allow a few Mb per project.
Operating system Platform Independent
Other supporting You must install or have installed:
software 1. A version of the Java Runtime Environment that is not older than 1.4. The latest
version (approx 7MB) can be downloaded from http://java.sun.com/getjava.

2. Java3D to use the advanced chart features. The latest version (approx 7MB)
can be downloaded from http://java.sun.com/products/java-
media/3D/download.html .

3. VisAD (Visualisation for Algorithm Development). This is distributed and installed

with IHACRES For further details go to http://www.ssec.wisc.edu/~billh/visad.html

This release is packaged using an across-platform installer. The installation does not update
the Windows registry.

Note If you are using a networked computer, then inform your system
administrator BEFORE installing the supporting software as there may
be other applications on your computer that could be affected by these
updates.

2.2 Licence agreement

Agreement to terms and conditions of use are part of the download and install procedures.
You must acknowledge that you have read, understood and agree to be bound by the
licence agreement to be able to proceed with the installation.

6
 Installation

2.3 Folders
The IHACRES install defaults to installing the package in C:\Program Files\Toolkit\IHACRES.
It creates 3 directories:
• ProductFiles
• Tutorials
• Uninstaller
The root directory contains the User Guide (in pdf format), release notes (RelNotes.txt), the
licence agreement (Licence.txt) and run.bat which initiates the Java environment and the
IHACRES software.
On install, an IHACRES program group is created in the Start program list.
It is recommended that users create their own directory structure for managing their project
data that is external to the IHACRES package directories.

2.4 Installation

2.4.1 Windows and non-Windows

In order to install IHACRES Classic Plus, you need to have the Java runtime environment
(version 1.4 or later) installed. This can be downloaded from http://java.sun.com/getjava.
Once you've installed the Java Runtime Environment, you install IHACRES by double-clicking
on the .jar file and following the instructions in the installer.
Note that Java3D and VisAD do not need to be installed for the IHACRES installation –
however they must be installed for the IHACRES package to run.

2.4.2 Data
Data for four river systems, including the Murrindindi tutorial used in this User Guide, are
distributed with the package. It is intended that additional tutorials and exercises, with their
data, will be available from the IHACRES Modelling Toolkit Product web page.

2.4.3 Start menu icons

The IHACRES start menu entry provides access to:
• IHACRES (the executable)
• Release Notes
• Uninstall IHACRES
• User Guide.

2.5 Uninstalling IHACRES

The IHACRES package has its own uninstall tool accessed from the IHACRES Start menu. It
will delete all the software except for the log file - ihacres_log.txt and parts of the tutorial.

7
IHACRES User Guide

2.6 User interface

2.6.1 Terminology
Terminology used in this Guide to describe user interface actions is set out below. The
IHACRES package uses tabs for navigation – these can occur at multiple levels – ie most
tabs have their own set of tabs.
The instructions assume that clicking the left button on your mouse is your Select operation.
If this is not the case, then adjust the instructions accordingly.

Tab Move the cursor over the tab and Select. The
tab’s panel appears.

(This example has 3 top level tabs and 2 second

level tabs)

Panel Form/page used to display and capture

information. A panel can contain dialog boxes,
buttons, etc

Dialog box Used to capture information from the user. Exit

is usally via pressing the OK button.

Button Selecting the button initiates a task (which may

have its own panel)

2.6.2 Charting functions

Charting is based on VisAD data visualisation technology. This technology includes various
chart manipulation functions, for both 2D and 3D visualisation. These are described below.
Table 2.1 2D chart manipulation functions

2D Function Function Action Description

Move Hold down the left mouse button while over a
chart and move mouse.
Zoom Hold down the left mouse button and a shift
key while over a chart and move the mouse up
to zoom in and down to zoom out.
Cursor Hold down the third mouse button (use both
left and right if third mouse button is not
available) while over a chart and move mouse.
Moves the chart with respect to the
plane of the panel.
Moves the chart with respect to the
normal of the plane of the panel.
Displays the coordinates, with respect to
the chart data, of the current mouse
position.

Table 2.2 3D chart manipulation functions

3D Function Function Action Description

8
 Installation

3D Function Function Action Description

Move Hold down the left mouse button and a control
key while over a chart and move mouse.
Zoom Hold down the left mouse button and a shift key
while over a chart and move the mouse up to
zoom in and down to zoom out.
Cursor Hold down the third mouse button (use both left
and right if third mouse button is not available)
while over a chart and move mouse.
Pan Hold down the left mouse button while over a
chart and move mouse.
Moves the chart with respect to the
plane of the panel.
Moves the chart with respect to the
normal of the plane of the panel.
Displays the coordinates, with respect to
the chart data, of the current mouse
position.
Rotates the chart with respect to centre
of panel.

Many charts within IHACRES use a range selector. A range selector is a control that allows
you to select a sub range of the chart data to display. A range selector can be manipulated
in two ways.

Table 2.3 Chart range selector functions

Range Function Function Action Description

Modify start and Hold down the left mouse button while over a
finish of the sub yellow triangle. While holding down the button,
range move left to move backward in the range, move
right to move forward in the range.
Modify entire sub Hold down the left mouse button while over the
range pink bar and move the whole bar left or right
Cursor Hold down the third mouse button (use both left
and right if third mouse button is not available)
while over a chart and move mouse.
Pan Hold down the left mouse button while over a
chart and move mouse.
The left triangle corresponds to
the start of the range and the right
triangle corresponds to the finish
of the range.
Moves the entire sub range with
respect to the range
Displays the coordinates, with
respect to the chart data, of the
current mouse position.
Rotates the chart with respect to
centre of panel.

Some range selectors also allow input of specific time step numbers for the start and end
points, or as dates for the start and end points.

2.6.3 Navigation
The use of tabs with associated panels provides for relatively easy navigation. This is
particularly important when working with multiple occurrences of a component, such as
multiple calibration periods.
Within this Guide > is used to indicate a navigation path. For example, Calibration >
Model means that Model is accessed from (and after) Calibration.

9
IHACRES User Guide

3 A quick tour
3.1 Getting started
The three major modes of the IHACRES package are Data, Calibration and Simulation.
Navigation between these is via horizontal tabs at the top of each panel. Within each major
mode, there are also minor modes shown as a lower horizontal set of tabs.
IHACRES starts with a new, empty project. You can begin the new project by importing the
required datasets within the Import tab, or alternatively you can open a saved project by
choosing Open for the File menu.

3.1.1 Running IHACRES

Selecting IHACRES from the program group, or clicking on run.bat from the IHACRES
directory starts up the Java environment and the IHACRES package. A command panel
opens which can be minimised once it launches the IHACRES interface. The command panel
looks like:

Figure 3-1 IHACRES command panel

3.1.2 Loading and creating projects

IHACRES has only 2 menu items – File and Help. File provides the usual project
management functions of

10
 A quick tour

Table 3.1 File > Menu actions

Menu item Item Action

New Clears all data in memory and interface fields
Open Displays the standard file open dialog – defaults to listing IHACRES project (.ipr) files in
the last directory accessed.
Save Overwrites the current .ipr file. If one has not yet been created, then the Save As dialog is
displayed.
Save as Allows you to save the current project file under another name. The existing project name
can be overwritten
Exit Exits IHACRES

File > About gives details of the version number of the software and other
acknowledgements.

3.2 The three modes

3.2.1 Data
Each component has its own set of tabs to provide navigation. The Data component has
three tabs that provide access to
• a Summary of the data currently loaded (if any)
• an Import tool to load in the required input time series data, and
• View tools to interrogate the loaded data.
The Data > Summary panel for the Murrindindi tutorial data looks like:

Figure 3-2 Data > Summary Panel showing the status of the Murrindindi tutorial data

The Import and View tools are described in Section 4.2, with guided instruction in the tutorial
in Section 5.

3.2.2 Calibration
Calibration mode has two tabs that allow you to
• define the calibration Periods
• build the Model (the linear and non-linear modules).
The first time that you enter Calibration mode, the lack of information in the panel lets you
know that you have a little work to do in defining the period and the model! The tutorial
walks you through these definitions in practical detail. Just so you know what you need to
do, here is the Calibration > Model entry panel:

11
IHACRES User Guide

Figure 3-3 Calibration > Model panel

The general order of operation is:

• Step 1 - set Calibration Periods
• Step 2 – set the Linear Module calibration by
• performing a Cross Correlation to calculate the delay between rainfall and
streamflow. This action has its own panel which is described in the tutorial.
• activating the Instrumental Variable function (by checking its box) or the Fixed
Transfer Function to control the linear module calibration.
• Step 3 – set the Non Linear Module calibration by
• selecting the Classic Model Module (the Catchment Moisture Deficit module is
under development)
• performing a Grid Search to search through parameter space to find a good
parameter set. This has its own set of panels to manipulate settings and
analyse parameter sets and is described in the tutorial.
After these steps are completed, the Calibration > Model panel will be populated as
follows:

12
 A quick tour

Figure 3-4 Calibration > Model panel after model calibration

3.2.3 Simulation
There is no simulation information to observe until the Calibration is complete. Once this is
done, Simulation provides access to extensive analytical tools to explore the predicted
streamflow time series. The entry panel is the Simulation > Calibration Period 1 >
Calibration > Streamflow panel which is shown in Figure 3-5.

Figure 3-5 Simulation > Calibration > Streamflow panel after calibration complete

13
IHACRES User Guide

4 Using IHACRES
4.1 General concepts

4.1.1 Project files

The current state of your IHACRES project can be saved to an IHACRES project file (.ipr) by
selecting File > Save or File > Save As. Save uses the IHACRES project file that was last
opened or saved, while Save As allows you to specify an new IHACRES project file name.
The current state of IHACRES can be initialised from an IHACRES project file by selecting File
> Open and selecting an IHACRES project file using the Open File dialog.

4.1.2 Statistics
Throughout IHACRES various statistics are used. These are described in Table 4.1. In
reading these statistics,

• QO is an observed flow value

• QM is a modelled flow value

• ε is the 90th percentile of observed non-zero flows.

Table 4.1 Statistics used in IHACRES

Name Description Formula

∑ (Q − QM )
Bias Overall error in flow volume, in mm
per year O

∑ (Q − Q )
Relative Bias
O M

∑Q O

∑ (Q − Q )
R Squared Measure of fit between observed 2
and modelled streamflow
1−
O M

∑ (Q − Q )
2
O O

14
 Using IHACRES

Name Description Formula

∑( Q )
R2_sqrt Variation of R Squared, giving less 2
weight to peak flows − QM
1−
∑( Q )
O
2

O − QO
R2_log Variation of R Squared, giving equal
∑ (ln(Q + ε ) − ln(Q M + ε ) )
2
weight to all flow percentiles
1−
O

∑ (ln(Q )
2
O + ε ) − ln(QO + ε )
R2_inv Variation of R Squared, giving more 2
weight to low flows ⎛ 1 1 ⎞
∑ ⎜⎜ Q + ε − Q + ε ⎟⎟
1− ⎝ O M ⎠
2
⎛ 1 1 ⎞
∑ ⎜⎜ Q + ε − Q + ε ⎟⎟
⎝ O O ⎠
U1 Auto-correlation of streamflow
X1 Cross correlation

Unless otherwise stated, the term ‘statistics’ used in this Guide refers to the above statistics.

4.2 Data

4.2.1 Data > Summary

Data > Summary shows the current state of the three time series that are imported, namely
Observed Rainfall, Temperature and Observed Streamflow. The Status column indicates the
state of each time series which can be:
• Uninitialised (data has not yet been imported)
• Initialised (data has been imported but not synchronised)
• Synchronised (data has been imported and synchronised).
The Imported Unit column shows the measurement unit of each imported time series.
The Start Time column shows the start time of each time series.
The Time Step column shows the time step of each time series.
If the time series is Uninitalised, its units will be set at NA.

4.2.2 Data > Import

Data > Import displays the Import Data Tool panel. The Open Raw Data File button
launches an Open File dialog so you can select a file containing the relevant time series.
The data contained within a raw data file must be in ASCII text format with separate time
series in columns separated by commas (white space is ignored). When a raw data file is
opened the top part of the file appears in the table in the Import File Data area of the Import
Data Tool panel. If the Open is successful, the contents of the data file are displayed.
The Time Parameters area of the Import Data Tool panel is used to specify the time
parameters of the time series being imported.

15
IHACRES User Guide

The Start Time parameters refer to the time corresponding to the first time step of a time
series that is being imported. The start time is specified by adjusting the Year, Month, Day,
Hour and Minute list boxes so as the correct start time is shown.
The Time Step parameter refers to the time between each time step of a time series that is
being imported. The time step is specified by selecting the units using the list box (Minutes,
Hours or Days) and specifying an amount using the text field.
The import process involves 4 steps:
1 Select a cell on the Import File Data table that is within the column corresponding to
the time series that is to be imported. Clicking a table cell will select the table column.
A table cell that is selected has a yellow border.
2 Select the type of the time series that is being imported by clicking on the appropriate
tab – Obs. Rain (observed rainfall), Temperature or Obs. Stream. (observed
streamflow).
3 Select the unit of the time series being imported using the Unit list box. The contents of
the Unit list box are dependent on the type of the currently selected time series. The
available units are listed in Section 1.3.1.
4 Press the Import button. If the select unit requires a catchment area value then you
will be asked to specify the catchment area value (in sq km) using a dialog box after
the Import button is pressed.
It is possible to import data for different data types from different raw data files.
When all time series have been initialised they will be automatically synchronised.

4.2.3 Data > View

Data > View tab allows you to visually examine the imported time series. Multiple data
series can be shown together, or one at a time. Selection of chart contents is via the
checkboxes on the right of the panel. As with other charts, the range selector allows more
detail to be shown for a particular time period.

4.3 Calibration
Calibration requires:
• establishing the calibration period (or periods)
• defining the linear module
• defining the non-linear module.

4.3.1 Calibration > Periods

Calibration > Periods is used to specify calibration periods and initially shows only the
Observed Streamflow chart. Other charts can be added using the check boxes in the upper
right part of the panel. When a check box is selected the corresponding chart is added.
When a check box is deselected the corresponding chart is removed, unless the check box
being deselected is the only selected check box.
The warm up duration is shown at the bottom right of the panel. It can be changed by
pressing the Set button and typing in a new value.
The Runoff Coefficient chart shows the runoff coefficient as a moving average over either one
month or one year, depending on which of the radio buttons are selected at the bottom of
the panel.

16
 Using IHACRES

The start and end of a calibration period are specified using the range selector that appears
at the bottom of the Periods panel. The range of the charts is controlled by the range
selector. When using the range slider to specify a calibration period the start of the selected
range corresponds to the start of the calibration period and the finish of the selected range
corresponds to the finish of the calibration period.

Add a calibration period

To add a calibration period select the range corresponding to the calibration period and
press the Add Calibration Period button. The start and finish of the new calibration period
are added to the table below the Add Calibration Period button.

Remove a calibration period

To remove a calibration period right click on the entry in the table below the Add Calibration
period button corresponding to the calibration period that is to be removed. When a
calibration period is removed it is no longer displayed in the table. All calibration periods
can be removed by pressing the Clear All button.
If a calibration period has an associated calibration then that calibration will be removed
when the calibration period is removed.

Multiple calibration periods

IHACRES allows you to select multiple calibration periods for a project. For example, you
may specify 2 calibration periods and then specify a different calibration for each and
analyse the simulation data for each calibration period separately.
To accommodate multiple calibration periods, each period has its own set of tabs. While the
contents of each calibration period tab are functionally identical each period has its own set
of parameters and actions.
For example, when using the Unit Hydrograph Linear Module Calibrator peaks can only be
selected from the calibration period corresponding to the current selected calibration period
tab. In addition when a calibration is ultimately specified it is only applied to the calibration
period corresponding to the current selected calibration period tab.
Throughout this Guide reference to ‘the current calibration period’ is a reference to the
calibration period corresponding to the currently selected calibration period tab.

4.3.2 Calibration > Model

Calibration > Model shows the current calibration state and provides access to functions for
calibrating the IHACRES model. It has 3 components:
• Calibration Periods
• Non Linear Module and
• Linear Module.
The Calibration Periods area shows the calibration periods that have been specified using the
Periods tab. At least one calibration period must be specified.
The other two areas (the linear and non-linear modules) on the panel configure the IHACRES
model. You must specify the model modules that are to be used before launching any
calibration functions.
The non-linear (loss) module converts rainfall into effective rainfall and the linear module
transfers effective rainfall to stream discharge. The linear module routes effective rainfall to
stream through any configuration of stores in parallel and/or in series.

17
IHACRES User Guide

Note In Version 2.1, only the Classic non-linear module and the Core linear
module are available. Functions under development for the linear
module include fixed exponential components, unit hydrograph, and
baseflow.

The current calibration state is shown in the text boxes in the bottom part of the Non Linear
Module and Linear Module areas.

4.3.3 Calibration > Model - Linear Module

Model > Delay

The Delay area within the Linear Module area shows the delay component of the calibration
state and provides access to Cross Correlation which allows you to specify the delay between
rainfall and streamflow, and analyse the associated data.

Model > Cross correlation

When Cross correlation is launched (by pressing the Cross correlation button) a calibration
period tab appears for each calibration period. Each calibration period tab contains a Pre
Cross Correlation tab. The lead and lag cross correlation parameters are specified using the
corresponding text fields on the Pre Cross Correlation tab. Pressing the Run Cross
Correlation button runs a cross correlation for the current calibration period.
After a cross correlation is run a Post Cross Correlation tab appears. The Post Cross
Correlation panel contains a chart of the streamflow autocorrelation (green), rainfall
autocorrelation (red) and cross correlation (white). The IHACRES calculated delay is shown
below the chart.
The delay for the current calibration period can be specified in the Delay Value text field
below the chart and pressing the Set Delay button.
Pressing the Finished button returns to the Calibration > Model panel.

Model > Instrumental Variable

The implementation of this algorithm is initiated by checking the Instrumental Variable check
box. The model determines the parameters for the linear module and is an alternative to
functions such as the Fixed Transfer function.
However, it behaves quite differently in that it is invoked during the non-linear module
calibration, and requires you to select a store configuration (using radio buttons on the Pre
Grid Search panel) as one of:
• Single Exponential Store (1,0)
• 2 Exponential Stores in Series (2,0)
• 2 Exponential Stores and Instantaneous Store in Parallel (2,2)
• Exponential Store and Instantaneous Store in Parallel (1,1)
• 2 Exponential Stores in Parallel (2,1).

18
 Using IHACRES

These store configurations determine the parameters and structure of the linear module. (The
numbers in brackets identify the form of the transfer function algorithm which is well
described in Young (2001)2).
The configuration of stores is identified from the time series of rainfall and discharge but is
typically either one store only, representing ephemeral streams, or two in parallel, allowing
baseflow or slowflow to be represented as well as quickflow. Only rarely does a more
complex configuration than this improve the fit to discharge measurements. This is restated
as a set of guidelines:
• For a catchment with a strong baseflow component (like the Murrindindi tutorial
example), check 2 Exponential Stores in Parallel (2,1);
• For a more ephemeral catchment, a Single Exponential Store (1,0) may suffice;
• For a ‘peakier’ structure with a baseflow component, the 2 Exponential Store and
Instantaneous Store in Parallel (2,2) structure might be appropriate.
• The Exponential Store and Instantaneous Store in parallel (1,1) is a slightly ‘peakier’
form of the Single Exponential Store (1,0);
• The 2 exponential Stores in Series (2,0) is rarely (if ever) used. It describes a
catchment which is represented as one exponential store draining to another.
More information on the Instrumental Variable estimator and selecting store configurations is
given in Chapter 6 – Fitting models.
Checking the box disables access to the alternate linear module calibrators.

Model > Fixed Transfer Function

This button provides an alternate way of specifying the linear module calibrator. It has its
own panel where you enter the relevant parameter values, namely
• N and M
• Alpha 1 and Volume 1
• Alpha 2 and Volume 2 (if required).
More information on the Fixed transfer function is given in Chapter 6 – Fitting models.

4.3.4 Calibration > Model - Non Linear Module

Model > Grid Search

The Grid Search Non Linear Module Calibrator allows you to select a non linear module
calibration by analysing various statistics produced by running the IHACRES model using sets
of non linear module parameters.
When launched a calibration period tab appears for each calibration period.

Grid Search > Pre Grid Search

Each calibration period tab has a Pre Grid Search tab (and associated panel) which contains
an entry for each of the current non linear module parameters. The Classic Plus model has
five (5) parameters, being:
• drying rate at reference temperature (tw)

2
Young, P. (2001) Data-based mechanistic modelling and validation of rainfall-flow processes.
In Model Validation: Perspectives in Hydrological Science, M. G. Anderson and P.D. Bates (eds),
Wiley. p117-161.

19
IHACRES User Guide

• temperature dependence of drying rate (f)

• reference temperature (tref)
• moisture threshold for producing flow (l)
• power on soil moisture (p)
You must specify a start, end and step value for all these parameters for the grid search.
IHACRES provides defaults for all parameters.
When the Grid Search is run the IHACRES model is executed for each possible combination
of non linear module parameters. The number of combinations of grid points is shown in the
top right hand corner.
You can set a parameter to a “fixed” value by specifying a finish value that is the same as the
start value. In this case, the step value is ignored.
Four actions are available at the bottom of the panel:
• Run Grid Search
• Copy Settings to All Calibration Periods
• Run Grid Search for All Calibration Periods
• Load Previous Grid Search.
Selecting Copy Settings To All Calibration Periods copies the values on the current Pre Grid
Search panel to all other calibration periods.

Grid Search > Run Grid Search

Pressing the Run Grid Search button runs the grid search for the current calibration period.
When complete, two new tabs appear - Charts and Post Grid Search.

Grid Search > Charts

The Charts panel allows you to visualise the grid search results. There are two main chart
types – one dimensional (1D) and two dimensional (2D). 1D charts allow you to view the
range of one non linear module parameter; 2D charts allow you to view the range of two
non linear module parameters. You switch between these chart types via the radio buttons at
the top of the Charts panel.
The Charts panel has two main areas Data and Visualisation. The Data area is used to
specify the data to be visualised and the Visualisation area is used to specify how the data
will be visualised. The contents of both areas are dependent on the current main chart type,
one or two dimensional.
You specify the data aspect of a chart by
• selecting the non linear module parameter(s) to appear on the axis(es)
• specifying the values corresponding to the non linear module parameters that are to
be held constant, and
• specifying the statistic to be viewed (the dependent variable).
You specify the visual aspect of a chart by
• selecting a chart type using the chart type list box and
• configuring any chart parameters.
The available chart types and corresponding chart parameters are shown in the table below.

Table 4.2 Table of Post Grid Search Chart types

20
 Using IHACRES

Main Chart Type Chart Type Chart Parameters

One Dimensional Line None
Two Dimensional Contour None
Two Dimensional Surface Shaded or Contour

Pressing the Create Chart button creates the chart as a new tab. The chart can be removed
by pressing its Remove Chart button (from the chart’s panel).

Grid Search > Post Grid Search

The Post Grid Search panel displays the data produced by the grid search in a table. Each
row of the table corresponds to one combination of non linear module parameter values.
You will want to select certain combinations of parameters to analyse further before you
determine the best parameter set for calibration.
IHACRES offers a sort tool to help you move around within the table. The Sort by Selected
Column button at the bottom of the panel sorts the table based on a selected column (eg R
Square). Sorting is from highest to lowest.
The Sort by Non Linear Module Parameters button reverts the table to the initial grid search
order.
The contents of the table can be exported by pressing the Export button. This launches a
Save File dialog and writes the data out in comma delimited (.csv) ASCII format.
The data can be saved for reloading by pressing the Save Grid Search button. This launches
a Save File dialog and writes the data out in an internal IHACRES format (.igs file).
The Analyse column (the left most column of the table) contains a check box for each row.
You use these check boxes to specify the rows you wish to analyse further. Simply check
inside the box.
When you have checked the rows, proceed to Analysis (by pressing the Analyse button).

Grid Search > Analysis

The Analysis tab gives access to charts of streamflow and error and is the point at which you
(finally) accept a calibration.
The Streamflow and Error tabs give access to the Hydrograph chart (observed and modelled
streamflow) and the error chart (difference between observed and modelled streamflow)
respectively for the current non linear module calibration. Changing the current selected non
linear module calibration changes the charts.
The list box at the bottom of the Analysis panel is used to select the current non linear
module calibration from the calibrations that were selected for analysis.
Pressing the Accept Calibration button sets the non linear module calibration for the current
calibration period to the current non linear module calibration.
Pressing the Finished button stops the Grid Search Non Linear Module Calibrator. At this
point the current grid search data are lost. A warning message is displayed to confirm the
stopping of the Grid Search Non Linear Module Calibrator.

21
IHACRES User Guide

4.4 Simulation
The Simulation panel allows for analysis of the data created as a result of running the
IHACRES model using the current specified calibrations. A calibration is a linear module
calibration combined with a non linear module calibration.
Each calibration period has its own tab which provides access (via a subset of tabs) to the
following details for each calibration period:
• Calibration
• Simulation Summary
• Statistic Summary
• Charts and
• Hydrograph.

4.4.1 Simulation > Calibration

Calibration shows the terms of the current calibration period, and the linear and non linear
modules calibrations.

4.4.2 Simulation > Simulation Summary

Simulation Summary shows a summary table of data underpinning the simulation in one
table. The first 6 columns of the table contain, for each time step:
• Date and Time
• Observed Rainfall
• Temperature
• Observed Streamflow
• Effective Rainfall
• Modelled Streamflow.
Depending on the modules selected for the calibration, there may be more data displayed.
The statistics for the calibration period are shown to the right of the table.
The Export button at the bottom of the panel launches a Save As dialog to save the table
contents as a comma delimited (.csv) ASCII file.

4.4.3 Simulation > Statistic Summary

Statistic Summary shows the statistics for various periods of interest in one table. Each row
corresponds to a particular period. The Rest period corresponds to the period that excludes
the current calibration period. The Year … period(s) correspond to various years after the
start date. For example, the Year 1 period corresponds to the period that starts at the start
date and finishes a year after the start date.
The Number Valid Values column shows the number of valid observed streamflow values
associated with the respective period.
The Export button at the bottom of the panel launches a Save As dialog to save the table
contents as a comma delimited (.csv) ASCII file.

22
 Using IHACRES

4.4.4 Simulation > Charts

The Charts panel allows you to create charts of the simulation data. To do this, you must
specify the data and visualisation parameters.
Chart Data Parameters allows you to select the data to be visualised.
Chart Visualisation Parameters is where you specify the style of chart (see Table 4.3).

Table 4.3 Chart types available when displaying Simulation Data

Chart Type Description

Multiple Charts
Single Chart, Common Y Axis Scale
Single Chart, Multiple Y Axis Scales
Each data component appears as a single chart.
A single chart contains all data components and a single Y axis
scale is used for all data components.
A single chart contains all data components but each data
component has a unique Y axis scale.

Pressing the Create Chart button creates the chart as a new tab. The chart can be removed
by pressing its Remove Chart button (on the chart’s panel).

4.4.5 Simulation > Hydrograph

Hydrograph shows the streamflow and error charts for the current calibration period.

23
IHACRES User Guide

5 Tutorial
This Section presents the detail given in Section 4 in the form of a tutorial.
The tutorial builds a calibrated model for a sub-catchment of the Murrindindi River. This river
is a tributary of the Goulburn River, and is located north-east of Melbourne, Victoria, in
south-eastern Australia. The catchment is almost entirely forested, and has a very strong
baseflow component.
This tutorial contains observed streamflow, rainfall and temperature data for the period 8
June 1975 to 29 June 1998. These data are provided with the tutorial and should have
been installed in the Tutorials\Murrindindi sub-directory of IHACRES.
This tutorial is a simple demonstration of IHACRES functionality. The comparison of
modelled and measured streamflow for the catchment is shown in Figure 5-10. The
modelled flow reproduces the observed flow well, except for extreme events, where the
surface runoff is underestimated.

5.1 Overview
This tutorial uses just one calibration period and the Instrumental Variable linear module
function to calibrate the model. The first attempt at calibration uses default settings for
parameters. It then refines two parameters to improve the calibration fit.
The Instrumental Variable function determines the parameters for the linear module. The
alternative, i.e. using the Fixed Transfer function to determine the parameters and structure of
the linear module, is only recommended for experienced modellers.

5.2 Steps
There are 6 basic steps in setting up an IHACRES project.
Data Set up
Step 1 Load observed data
Step 2 Check the consistency and synchronisation of the data
Calibration
Step 3 Define the calibration period(s)
Step 4 Calibrate the linear module (by setting its parameters)
Step 5 Calibrate the non-linear module (by setting its parameters)

24
 Tutorial

Simulation
Step 6 Run the calibrated model in simulation mode to predict stream flow

5.3 Step 1 – load the data

After installing and opening IHACRES, the Data screen appears automatically after the
opening graphic.

Figure 5-1 Data Summary screen for Murrindindi River (Data > Summary)

As yet, we have no data loaded. This is the first thing we must do.
1 Select the Import tab to access the Data > Import screen. The same screen is used to
load:
a observed rainfall
b observed streamflow
c temperature.
In this example rainfall and streamflow series are stored as columns in the same file (pq.dat).
This is not a requirement and you may store them separately if you prefer.

5.3.1 Observed rainfall

1 Select Obs. Rain (the left-most tab under Import), then press the Open Raw Data File
button. A standard Open file dialog box appears.
2 Find and select pq.dat from the Tutorials/Murrindindi subdirectory.
The first few lines of the file will be previewed on screen like this:

25
IHACRES User Guide

Figure 5-2. Import screen showing Murrindindi streamflow and rainfall data (Data > Import)

Rainfall is stored in Column A – it is a daily time series and measured in millimetres.

3 Associate Column A with rainfall by clicking on any cell in that column – the whole
column will be selected.
4 Select ‘mm’ as the measurement Unit (list box at the bottom of the screen.
The subsequent columns are streamflow measurements, day-of-month, month, year
and day number (offset from 1st January 1800) respectively. We will deal with
streamflow later, but now we need to set the start date.
5 Enter the Start Time. (In this case, it is 8th June 1975). The year menu is most easily
scrolled by selecting the side bar and pulling down.

For daily data, you do not need to edit the Hour and Minute fields (leave as 0, the
default). The time step is 1 day (the default).
6 Press the Import button.
When the rainfall import is finished, a small window should pop up with the message Data
import complete. If it doesn’t, check that you have a column selected and all the options are
specified appropriately and try again.

5.3.2 Observed streamflow

In this example, streamflow is stored in Column B in the same file (pq.dat).
1 Select the Obs. Stream. Tab and follow a similar procedure as that for rainfall, except
that you do not need to open the raw data file again.
2 Select ‘ML/time step’ as the measurement Unit.
In this case, streamflow has the same start date as rainfall so you do not need to adjust the
start date.
3 Press the Import button.
Because we are using streamflow data in flow rate units, we must specify the catchment area.
4 Enter ‘104.9’ (catchment area in km2) in the dialog box that pops up and press OK.

Note Area is required for all streamflow units except mm/time step and must
be entered in km2.

26
 Tutorial

5.3.3 Temperature
1 Select the Temperature tab.
2 Find the file t.dat in the ‘Murrindindi’ folder. Temperature is in Column A. Select that
column and ensure that the date listed in the subsequent columns is consistent with
the Start time.
3 Select ‘Celsuis’ as the measurement Unit, then press the Import button.
The three series should now be correctly loaded. The following message will appear. Press
the OK button.

4 At this point, save your project file using File > Save as. This will create a .ipr file in
the directory of your choice.

5.4 Step 2 – check the data

5.4.1 Data > Summary

Click the Data > Summary tab to display the start and end dates of each series, and a few
other sundry (useful) pieces of information.
Check that these are correct, and then proceed to the View tab.

5.4.2 Data > View

Click on the Data > View tab. This might take a few moments to load – have patience.
Graphs of the input data series will appear on screen.
This view panel is very flexible – you have control over the number of series displayed and the
time scale on the x-axis. For example, if you want the first few months of the rainfall data,
uncheck Temperature and Observed Streamflow in the boxes on the right of your screen.
Time periods can be selected by
• Dates (by typing in valid dates in low: and hi: fields at the bottom left)
• day number3 (by clicking and dragging the ends of the bar at bottom centre or by
entering numbers in low: and hi: at the bottom right)
Select only rainfall and use any method to restrict the period to one year. Your screen should
look like the one below. The pink bar can be dragged to the left or right to give a scrolling
view of the data.

3
The maximum number of days is calculated by IHACRES from the number of points in the
combined temperature, flow, and rainfall record.

27
IHACRES User Guide

Figure 5-3 Viewing Murrindindi River data (Data > View)

5.5 Step 3 – define the calibration period(s)

Now to establish one (or more) calibration (and warm-up) periods.
1 Click on the Calibration tab. The Calibration > Model screen tells you that

2 Click on the Periods tab to select some. A Calibration Chart appears (with default
display of streamflow for the whole period).
3 You can view Observed Rainfall, Temperature and Observed Streamflow by checking
their boxes at the top right. For now, ignore Runoff Coefficient.

Figure 5-4 Calibration periods screen for Murrindindi (Calibration > Periods)

Because this example has > 23 years of data you can use a large calibration period. It
should be as representative of the whole record as possible (this may take some trial and
error).

28
 Tutorial

Let’s use the four years from 8 June 1976 to 8 June 1980 (days 366 to 1827) with a warm-
up period of 200 days.
4 Warm Up period
a Press the Set button in the Warm Up box (bottom left) and enter a whole
number (in this example, 200).
b Press OK.
5 Calibration period
a Enter the start and end dates (6 June 1976 – 6 June 1980; days 366 – 1827)
using whichever method you prefer (described in Viewing Data > View5.4.2).
Remember to press Enter to update the graph.
b Press the Add Calibration Period button.
The start and end points of the selected period will appear in the Calibration
Period table.
Multiple calibration periods can be specified, but we will use only one.
6 Now, move back to the Model tab.
The Calibration Periods message should now display:

5.6 Step 4 – calibrate the linear module

5.6.1 Cross-Correlation
The first step is to run a cross correlation between rainfall and streamflow to identify the delay
between these time series.
1 Click Cross-Correlation n the Linear Module area (the left hand area of the Model
panel).
2 Accept the default Lead (10) and Lag (30) options (recommended at this stage) and
click Run Cross Correlation.

Pre Cross Correlation

A plot like the following one should appear.

29
IHACRES User Guide

Figure 5-5 Pre Cross Correlation Chart for Murrindindi data (Calibration > Calibration Period 1 > Pre Cross
Correlation)

In this graph the black peak appears a little to the right of the blue and red. This identifies
that there is a delay between rainfall and streamflow. The consequence is that, on any given
day, streamflow is more correlated with yesterday’s rainfall than today’s. IHACRES has
estimated this delay at one (1) day, which appears in the small dialog box (at the bottom
middle of the panel).
You can override this delay estimate if you wish (and we will do so in this tutorial). Why?
One day delay is not very different to no delay.
3 Enter 0 in the ‘IHACRES Calculated Delay’ field and then click Set Delay
4 Click the (wide) Finished button at the bottom of the panel to exit pre cross
correlation.

Instrumental Variable
5 Back under the Models tab, check the Instrumental Variable box to control the linear
module calibration (this disables the Fixed Transfer Function option).
(Remember that you will set the store configuration on the Pre-Grid Search panel (next step).
We can now calibrate the non linear module.

5.7 Step 5 – calibrate the non-linear module

5.7.1 Grid search

This tutorial uses the Classic module (presently the only one available).
1 Press Grid Search in the Non Linear Module area (the right hand area of the Model
tab panel). This tool performs a search through parameter space to find a good
parameter set.

Pre Grid Search

The Classic model module has 5 parameters for which IHACRES requires us to set the
minimum (Start Value), maximum (Finish Value), and step size (Step Value) for each
calibration period. These 5 parameters are:

30
 Tutorial

• drying rate at reference temperature (tw)

• temperature dependence of drying rate (f)
• reference temperature (tref)
• moisture threshold for producing flow (l)
• power on soil moisture (p)
The default values are a good initial guess. Let’s leave them unchanged for now.

Note To overwrite these values (some other time), you just type alternate
values into the boxes.

A few simple commonsense rules must be obeyed, e.g. the maximum search value must be
larger than the minimum.
In the top right, you will see a calculation of the number of grid points. This is a good guide
to how long your search will take. Beware - large grid searches will use considerable
resources on your computer.

Instrumental Variable
In the Instrumental Variable area (bottom left), select a model for the storages that you think
best describes the catchment’s flow duration curve.
2 Check 2 Exponential Stores in Parallel (2,1) (the Murrindindi has a strong baseflow
component).
You should see this:

31
IHACRES User Guide

Figure 5-6 Grid Search parameters for Murrindindi data (Calibration > Calibration Period 1 > Pre Grid
Search)

In this tutorial, we will calibrate only the first two (2) parameters. If the model performance is
not adequate, then some or all of the remaining parameters can be calibrated in a
subsequent grid search.
We are ready to perform the grid search.
3 Press the Run Grid Search button. A progress bar will pop up.
When the search is finished, two new tabs will appear to the right of the Pre Grid Search tab
- Charts and Post Grid Search.

Post Grid Search – find a suitable parameter set

Under Post Grid Search, there will be a table of the tested parameter values and the
performance statistics corresponding with the calibration at that point in parameter space.
For the precise meanings of these statistics, see Table 4.1.
The two we are most concerned with are R squared (R2 also called Efficiency) and Bias. The
optimal value of R2 is unity (1.0) and Bias should be as close to zero (00 as possible.

Note You can re-size the columns by clicking and dragging the boundaries.

How to find a suitable parameter set? Firstly, find the ‘best’ R squared.
4 Sort (in descending sequence) the results by R2 (the column titled ‘R Squared’, or ‘R
Sq…’ or ‘R S…’) by clicking on any entry in that column and pressing Sort by Selected
Column.
The best R2 results will be in the top rows of the results table.
As you can see from Figure 5-7, the best R2 value is 0.853 - not a bad result for a first try.
The Bias for this point is 10.8 mm/year, which is acceptable.

32
 Tutorial

Note If you have an R2 of 0.778, it may be because you forgot to change

the delay in the cross correlation from 1 to 0.)

Figure 5-7 Grid search results for Murrindindi, sorted by Efficiency (R2) (Calibration > Calibration Period 1 >
Post Grid Search)

Let’s now investigate the model fit that produces these statistics.
5 Tick the box for this row (ie the top row) in the Analyse column (Column 1), and then
press the (wide) Analyse button at the bottom of the panel.
6 Click on the Streamflow tab to view a plot of modelled vs observed streamflow).

Figure 5-8 Analysis of Most Efficient (R2) Grid Search result for Murrindindi streamflow (Calibration >
Calibration Period 1 > Analysis > Streamflow)

7 Click on the Error tab to view a plot of the point-by-point errors.

We could accept these parameter values and move on to simulation. However, let’s refine
the parameter search according to the results of the initial grid search. DO NOT press the
Accept Calibration button yet!

33
IHACRES User Guide

Post Grid search – refine the parameter set

8 Go back to the Post Grid Search tab.

Notice that the best R2 values occur when the Drying Time constant (‘dryi…’, Column
3) is between 7 and 22, and Temperature Dependence of Tw (‘tem…’, Column 4) is
between 1.0 and 2.0.

Note You might like to save your initial grid search at this point by pressing
the Save Grid Search button ( bottom right on the Post Grid Search
panel).

Using this knowledge, let’s do another grid search.

9 Click on the Pre Grid Search tab to set new values for another grid search. Set:
a ‘drying rate at reference temperature (tw)’
start value – change to 7 (from 2)
finish value – change to 20 (from 30)
step value – change to 2 (from 5)
b ‘temperature dependence of drying rate (f)
start value – leave at 0.0
finish value – change to 2.5 from from 2.5
step value – change to 0.2 (from 0.5).
10 Press Run Grid Search again.
11 Sort the new results by R squared.
The best has a value of 0.855, almost the same as the previous best R squared. The Bias is
also similar.
This is not much of a surprise, because, looking at the initial grid search statistics, there is
little difference between the first few performance statistics. The R squared surface for this
parameter search is quite flat near the maximum. It is clear that this is the best R squared we
are likely to get from this system.
12 Tick the Analyse box of the first row (as in the initial Grid Search), noting that there is
little variation in the fit indicators for the surrounding entries.
13 Press the Analyse button. This time we will accept the calibration.

Accept the parameter set

Firstly, view the observed and measured streamflow plot and ensure that you are happy with
the result.
14 Press the (wide) Accept Calibration button at the bottom of the panel. A box
summarizing the linear and non-linear module parameter sets pops up, like so:

34
 Tutorial

Figure 5-9 Accepted parameter sets for Murrindindi (Calibration > Calibration Period 1 > Analysis)

15 Press OK and then the (wide) Finished button (on the Analysis panel).
A confirmation message will appear, reminding you to save your grid search if you want to
use it later.

Note To Save, go to the Post Grid Search panel (using the Post Grid Search
tab) and press the Save Grid search button.

Once finished, you will be automatically returned to the Model panel, which will now look
like:

Figure 5-10 Calibrated model for Murrindindi River

35
IHACRES User Guide

5.8 Step 6 - simulation

1 Click on the Simulation tab.
You may get a Please Wait message while the computer applies the model with parameters
as defined in the calibration stage. A hydrograph of the model output and flow observations
is displayed.

Figure 5-11 Hydrograph of simulated vs observed flow for Murrindindi (Simulation)

As you can see, the flow is modelled reasonably well though the fit deteriorates over time. In
addition, the unusual large cluster of peaks towards the end of the record is not well
captured.

Statistic Summary
Let’s examine the statistics for each year.
2 Select the Statistic Summary tab to view a large range of statistics for each year.

36
 Tutorial

Figure 5-12 Statistic Summary for Murrindindi simulation (Simulation > Statistic summary)

3 Look at the R squared column. The R2 for years 20 onwards are particularly poor, in
keeping with what we saw on the hydrograph.
4 Look at the row with the label Rest in the Calibration column (Column 1, row 2). The
R2 = 0.659 and Bias = 29.430 mm/year.
5 Looking at the R squared values for individual years, we see quite a broad range of
performance statistic values, from R2 = 0.84 in year 16 to –0.086 in year 20 (which
corresponds to the 1995 drought). The largest bias is –147.424 mm/yr for year 9
(1983)

Discussion of simulation results

1983 had a rainfall slightly above the average annual value, and followed the driest year on
record. This suggests that, at least in this data set, the dependence of streamflow generation
on antecedent conditions is not quite correct for periods following a drought. This could be
improved by calibrating the parameter ‘moisture threshold for producing flow’ (which you
may recall we did not calibrate in this tutorial), though this would require selecting a
calibration period that includes the years 1982 and 1983.

Simulation summary
6 You can also interrogate the raw observed and modelled data from the Simulation
Summary tab.
7 You can export all or any of the summary data to a comma separated variable (*.csv)
file but pressing the Export button at the bottom of the Summary panels.

Charts
Other plots can be created with the Charts tab. These can be one or a combination of
• observed rainfall
• observed streamflow

37
IHACRES User Guide

• modelled streamflow
• temperature
• effective rainfall
• slow flow component
For example, observed and effective rainfall can be viewed together as separate plots by
checking the boxes next to each variable and then selecting the Multiple Charts option in the
Chart Visualisation Parameters section at the bottom of the panel.
You have now completed a brief IHACRES modeling process for the Murrindindi catchment
data. Save your project using File > Save or File > Save As …

5.9 Exercise
Slightly better results can be achieved for the Murrindindi catchment.
If you like, you can go back and give these options a try:
• Pick a different calibration period or multiple periods
• Experiment further with grid search options.

38
 Fitting models

6 Fitting models
While IHACRES provides extensive tools for exploring and assessing goodness of fit of
models, it takes experience and insight to determine what is a reasonable fit, whether it is
worth pushing the parameterisation to achieve a better fit, or whether that is the best that can
be achieved with the data.
This Chapter contains notes taken from IHACRES workshops to assist you develop this
expertise.

6.1 Calibration

6.1.1 Linear module

You would usually start your calibration by doing a coarse grid search using the primary
parameters. For the Classic non-linear module, these are the drying rate at the reference
temperature (tw) and the temperature dependence (f). Then, based on performance, you
would refine it in some smaller area around the best fit (if you consider that worth doing).
The important thing is to look at results from neighbouring grid elements – if there is not
much change, then there is no point going to finer grid. If there is significant change, then it
is probably worth while doing a finer grid search. The chart plotting tools provided in the
Charts tab can assist here.
For each element of the grid search, the software produces an effective rainfall time series
which it passes into the linear module.

Instrumental variable (IV) estimator

While part of the linear module calibration, the IV is invoked during the non-linear module
calibration.
The linear module uses a constant-coefficient transfer function approach, where the unit
hydrograph is assumed to comprise of a small number of exponentially decaying stores
arranged in series or parallel. For each store, the flow is some constant (between 0 and 1)
times the previous flow and some fraction of the effective rainfall. There is also a time step
delay parameter that accounts for the delay between rainfall and streamflow response.
The algorithm requires you to select a store configuration (using radio buttons on the Pre
Grid Search panel) as one of:
• single exponential store (1,0)
• exponential store and instantaneous store in parallel (1,1)
• 2 exponential stores in series (2,0)

39
IHACRES User Guide

• 2 exponential stores in parallel (2,1)

• 2 exponential stores and instantaneous store in parallel (2,2).
Some helpful guidelines:
• For a catchment with a strong baseflow component (like the Murrindindi tutorial
example), check 2 exponential stores in parallel;
• For a more ephemeral catchment, a single exponential store, or an exponential store
in parallel with an instantaneous store may suffice;
• For a ‘peakier’ structure with a baseflow component, the 2 exponential and 1
instantaneous store structure might be appropriate (though it should be noted that the
en-bloc version of the IV estimator implemented within IHACRES v2.1 has difficulty
with calibrating the model using this structure).
Experience shows that, even when you have good data, and can see separate stores in the
linear module, a 2 stores configuration may be a better representation. Why is this? This is
an inherent problem with hydrology – when you are seeing streamflow you aren’t seeing
what is contributing. The question is then, when you are putting the model together, do you
want to impose what you think you are seeing, or do you want to let the data INFORM you
of the structure?
For example, from the data you can only identify 2 stores (yet you can see 5). The IHACRES
approach is to let the model determine from what the data are saying is going on, rather
than imposing the number of stores. Normally we would consider two components – a quick
and a slow – with quick being surface – but this is not always the case. It depends on the
response characteristics of the catchment.

Fixed transfer function

The Fixed Transfer Function is an alternate way of specifying the linear module parameters, if
prior information on the parameter values is available (e.g. through regionalisation).
Typical alpha values would be:
• -0.7 for quick flow;
• around 0.9 to 0.98 for slow flow.
The slow flow volume (vs) will be near zero for flashy streams, and near 1 for catchments with
a very strong baseflow component (characterised by a smaller range in observed flows, and
higher flows during the dry season compared with flashier catchments).
All the model is trying to do is take the input of effective rainfall and observed flow and get
the best possible estimate of the linear module parameters. There are several ways of doing
this, but IHACRES Classic Plus uses the en-bloc approach. This just sums up the elements
and then solves, in one single operation, for the optimum operator set. It doesn’t have the
flexibility and power of the recursive form, but is fast.
The recursive approach steps through the time series, updating the parameter set at each
time step. It then iterates through that to get the best choice of parameters. It also means
that you can then have time varying parameters. This approach will be implemented in a
future release. The disadvantage is that this approach can take much longer to calibrate a
catchment.

6.2 Model performance

6.2.1 Calibration period

The selected calibration period should cover a significant range in the observed climate
variability. Ideally, the calibration period should include very wet and very dry years. If the

40
 Fitting models

focus of the application is on flood peaks, then the calibration period should include such
events. However, the uncertainty in such events is high due primarily to the uncertainty in the
rating curve. Thus, if the focus is on low flows, then flood peaks should be avoided as much
as possible. In temperate/humid catchments, a two to three year calibration period is usually
sufficient. In arid and semi arid catchments, a longer calibration period is generally needed
as flow events in such catchments are less frequent.
In summary, the selection is really a function of the purpose of the modelling exercise. Some
characteristics to look for:
• Good reliable input data
• A good variety/range of responses
• Avoid really high peaks, unless you want to model really high peaks.

6.2.2 Catchment size

Generally, smaller catchments have a shorter response time, and so need to be modelled at
a finer timestep. In very large catchments, spatial variability within the catchment can result
in poor performance as IHACRES is a lumped model. Most catchments where IHACRES has
been applied at a daily timestep are between 10 and 5000 sq km.
For very large catchments, you may choose to apply the model to subcatchments and then
route the flow down to larger catchment. If you go to a smaller system, there is advantage in
going to a shorter timestep. See discussion in next section.

6.2.3 Timestep

Monthly data
IHACRES supports the use of monthly data. However, you are limiting the information that
you are feeding into the model, in particular the linear module. Without the dynamics, you
can’t really calibrate the linear module.
A better approach would be to calibrate the model on a daily timestep, and then aggregate
results up to monthly.

Catchment size and timestep

Smaller catchments tend to have a short response time, and as a result need a shorter
timestep in order to determine the parameters and structure of the linear module. This can
be a problem even with fairly large catchments. For example, in the Namoi River basin, a
2500 sq km catchment has flow peaks where the flow typically decays to half the peak value
in three hours. Using daily data means that most of the information regarding the dynamic
response characteristics of the catchment are not used.
An alternative is to use higher resolution streamflow data to investigate the dynamic response
characteristics independently of the rainfall data (Croke, 2005). A tool for this is being
developed and will be available in a later version of IHACRES.

6.2.4 Ungauged catchments

Significant effort is being made in the international community to develop approaches to
model flows for ungauged catchments. A standard approach (called regionalisation) is to
look at a number of gauged catchments in the area, and attempt to determine relationships
between model parameters and catchment characteristics –eg area, drainage density, soils,
vegetation cover. These relationships can then be used to predict the model parameters in

41
IHACRES User Guide

ungauged catchments (Post and Jakeman, 1999; Kokkonen et al, 2003; Sefton and
Howarth, 1998).
However, what you are really after is an optimal set of parameters rather than a set of
optimal parameter estimates. An alternative approach is to determine regional relationships
for catchment response characteristics rather than parameters. A characteristic could be the
runoff coefficient, or the shape of the flow duration curve (FDC). Then, estimates of the
catchment response characteristics for an ungauged site can be used to constrain the model
fit (Croke and Norton [2004]).

6.3 References
Croke, B.F.W. (2005) A technique for deriving the average event unit hydrograph from
streamflow-only data for quick-flow-dominant catchments, Advances in Water Resources.
Croke, B.F.W. and J.P. Norton (2004) Regionalisation of Rainfall-Runoff models, In Pahl, C.,
Schmidt, S., Rizzoli, A.E. and Jakeman, A.J. (eds.) Complexity and Integrated Resources
Management, Transactions of the 2nd Biennial Meeting of the International Environmental
Modelling and Software Society, Volume 3 pp. 1201-1207. iEMSs, June 2004.
Kokkonen, T.S., A.J. Jakeman, P.C. Young and H.J. Koivusalo. (2003) Predicting daily flows
in ungauged catchments: model regionalization from catchment descriptors at the Coweeta
Hydrologic Laboratory, North Carolina, Hydrological Processes 17, 2219–2238, 2003.
Post, D.A. and A.J. Jakeman. (1999) Predicting the daily streamflow of ungauged
catchments in S. E. Australia by regionalising the parameters of a lumped conceptual
rainfall-runoff model, Ecological Modelling, 123, 91-104, 1999.
Sefton, C.E.M. and S.M. Howarth. (1998) Relationships between dynamic response
characteristics and physical descriptors of catchments in England and Wales, Journal of
Hydrology, 211, 1-16, 1998.

42
 Troubleshooting

7 Troubleshooting
IHACRES is under continuous development and has a few known bugs. These are described
in the latest Release Notes (see RelNotes.txt in the IHACRES root directory).
You may also like to check through the IHACRES historical bug tracking system on the toolkit
website.
Bugs can be logged and tracked by users.

7.1 NaN
NaN (not a number) can appear in the statistics and summary reports and indicates a failed
calibration. It is usually produced when using the "two exponential and one instantaneous
store" linear model configuration.
Avoid using this model structure until the recursive instrumental variable estimator is
implemented.

43
IHACRES User Guide

Appendix A - Data Files

A.1 - User provided files
To avoid complications associated with prescriptive file formats for input data, he format of
the input time series (for observed rainfall, temperature or evapo-transpiration and observed
streamflow) is flexible. Date stamps, particularly troublesome are not used. Instead, the user
enters the start date and time step manually via a dialog box.
However, the data file must:
• be in comma-delimited ASCII text format
• be arranged in one column, without a header row
• be ordered (earliest to latest date)
• contain an entry (row) for every time step (ie no missing data).
The input format for the pq.dat tutorial file (which contains flow and files used in the tutorial
is of the form:

In this example the columns of interest are A and B which contain rainfall (in mm) and
streamflow. The other columns are not used by IHACRES import tool.

A.2 - IHACRES files

A.2.1 - Configuration file (configuration.txt)

IHACRES is distributed with a configuration file (configuration.txt) which contains settings for
the grid search and other routines. There should be no need for you to edit this file.

44
 Data Files

A.2.2 - Project files (.ipr)

IHACRES allows you to create (and then update) project files to store the status of your
project. This saves time reloading data files and running the calibration. These files are in a
binary IHACRES format. They are only meaningful to IHACRES. They can be loaded using
File > Load.

A.2.3 - Grid search files (.igs)

You can save the results of different grid searches for re-loading. Once again, this is a
mechanism to allow you to re-establish your place in an IHACRES calibration session, without
having to re-run your searches.

A.2.4 - Log file (ihacres_log.txt)

IHACRES maintains a log file for a session where exceptions are logged. This file may be
useful for debugging purposes.
You can save the results of different grid searches for re-loading. Once again, this is a
mechanism to allow you to re-establish your place in an IHACRES calibration session, without
having to re-run your searches.

A.3 - Results files

Some of the tables that are created in IHACRES can be exported to comma-delimited text
files. They can then be imported into Excel and other such packages for further analysis and
charting. The following data can be exported:
• table of post grid search results (Calibration > Model > Grid Search > Post Grid
search)
• the simulation summary table (Simulation > Simulation summary)
• the statistic summary table (Simulation > Statistic summary).

45