Software releases

eWater gratefully acknowledges the Australian Government’s financial and in-kind contribution to this project through the Murray Darling Basin Authority, the Department of Primary Industries (NSW), the Department of Environment, Land, Water and Planning (Vic), the Department of Water (WA), the Department of Environment, Water and Natural Resources (SA), the Department of Natural Resources and Mines and the Department of Science, Information Technology and Innovation (Qld).

Source 4.5 Production Release

June 2018

Download Source  Download Source (public version)

View detailed Source 4.5 Production release notes.

eWater is pleased to announce the latest production release of Source version 4.5 which is packed with new and updated features developed over the past 6 months since v4.3.  

Source 4.5 is faster in running, loading, saving and editing large catchment models. Environmental Flows, Pipe Junctions, Annual Accounting Resource Assessment systems and Management of Distribution losses between the offtake and water user/farm gate have all been improved in Source 4.5. A new Model Profiling Tool allows you to analyse model run times to optimise performance, and there are additional options so you can customise the look of the network display. Highlights since Source Production Release 4.3 include:

Environmental Flows

The new environmental flow functionality enables multiple environmental rules, sites, and account holders to be managed and prioritised centrally through the environmental flow manager. Environmental flow patterns may be dependent on a range of current and prior system conditions, and environmental flow account balances. The environmental flow node allows for configuration of spell based and translucency action types with various parameters to do with timing, size and shape of the desired flow patterns.

This release of Source 4.5 delivers improved management of return intervals in the manager, event termination behaviour and water requirement calculations.

  • The flow manager now allows for the opportunistic use of available environmental water following successful seasons. The environmental flow node can still be used independently of the environmental flow manager to order water if the desired frequency interval has elapsed since the last successful season.
  • The travel time associated with the reference flow in a translucency action is now assumed to be the minimum travel time, ie the time Source calculates it will take for the flow to reach the node from the closest storage.
  • Spells are now considered to have failed (and therefore have the event terminated to avoid wasting more water) as soon as any success criterion (volume, flow rate or timestep) has failed, rather than when minimum spell duration has elapsed.
  • The volume of water required for a planned event is now calculated more accurately, with the water required for the specified rise and fall behaviour taken into account.     

See Environmental Flow Node and Environmental Flow Manager scientific reference guide entries for further information on the underlying methods of calculation and management.

Runtime Performance for catchment projects

Runtime across all of the catchment models has improved, projects such as the Mackay Whitsunday, with 11 Functional units, over 200 catchments and 20 constituents now runs in 60% of the time it previously ran in Source version 4.3.


Mackay Whitsunday











Percent of original time




Project Load and Save Times

Load times have been reduced across most projects, both catchments based and schematic based projects.   Almost all project save times have also been reduced.

Load times

Mackay Whitsunday








Percent of original time



Save times

Mackay Whitsunday


Border Rivers









Percent of original time




Entitlement for Annual Accounting Accounts can now be defined with a function

The Entitlement of an account can now be modified during a run. Increasing or decreasing the entitlement won't change the account balance or the available water.  It will change the water that will get allocated next time an allocation occurs.

Pipe Junctions

When using the Pipe Junction node with priority ordering, orders made by Pipe Junctions are now given a higher priority than any other order in the system. 

This is to ensure that orders in the ordering phase can be delivered in the flow phase even when there are shortfalls in the system.

Supply Point Distribution System Loss

You can now specify a mix of proportional and constant volume for distribution system loss (loss between the offtake and water user/farm gate). There is also an option to continue to order the volume loss when there are no orders using "Order to fill channel":

Chart Aggregator now includes water years

You can now do annual aggregations in a chart to a customised water year start, rather than just the calendar year:

Network Display Improvements

There is a new scenario option for what nodes / Links you would like to be displayed on the Schematic or Geographic editors. It's available from either the Schematic editor, the Geographic editor, or under Scenario Options (Node/Link Display Settings).  It can be used to hide all of the confluence nodes, which can be helpful in a geographic model:

Model Profiling Tool

A model profiling tool is now available as a recorder: Miscellaneous \ Performance \ Scenario Model Timings.  It produces a report that shows execution time per component (node/link/catchment) and per phase (flow, constituent, ordering. etc.).

To improve model run time you can use this tool to find areas in your model that take the most time and check: Improving Performance for ideas about how to improve the model runtime. Example outputs are provided below.

Model Phase Summary:

Component / phase heat map:

Minor Enhancements:

  • Single Installer - We now have a single installer for both 64bit and 32bit machines. We also have a single .zip file for binaries which will work for both 64bit and 32bit machines.

  • Improved notes in resource assessment - You can now add in comments in more areas of Annual Accounting Resource Assessment.

Results and Configuration Changes

Some results have changed between Source 4.3 and Source 4.5. Result changes are mostly around Environmental Flows and changes to Weirs. The eWater development team maintains a detailed system to track when results vary between different version of Source. The details at the following link will help you work out why the results have changed, and any alterations you may need to make to your model configuration.

Details of result changes: 4.5 Result Changes from 4.3

View Source version history.


View Source 4.5 User Guide.

View detailed Source 4.5 Production release notes.


You can access these Production Beta Releases if you have a full Source licence. Contact us.

Download the Source releases from the eWater Toolkit:

Download Source Production

Download Source (public version)

Similar to the previous Source production release (version 4.1) there is a difference in functionality available in the Public and Full versions of the software. Features that are only available in the Full version are indicated with an asterisk (*).

Get Source       Download free trial

Source 4.3 Production Release

December 2017

Download Source  Download Source (public version)

View detailed Source 4.3 Production release notes.

Source Version 4.3 delivers new and improved functionality to solve help you solve some of the long-standing challenges in integrated water resource modelling. For example we've worked closely with MDBA and other stakeholders to deliver new environmental flow management functionality that allows for prioritisation across sites and works directly with entitlement systems. Urban models can now include looped flow systems via bidirectional flow using the new pipe junction node. 

Through consultation with many of our 3,500 Source users, we have identified and implemented solutions to improve the adoption and management of Source models with features such as faster model run times and implemented several tools to support model management systems to deliver greater efficiency, transparency and repeatability. We will be working with the eWater Community over the next six months to develop guidelines for how model management workflows can be implemented

Highlights of Source 4.3:

Environmental Flows

Environmental flow requirements describe the quantity, timing, and quality of water flows required to sustain freshwater and estuarine ecosystems and the human livelihoods and well-being that depend on those ecosystems.

Flow regimes are dynamic across multiple time scales and lead to a range of interconnected ecological responses which are often challenging to analyse and quantify. The benefits of replicating historical behaviours of environmental asset watering can result in a need to create rules to replicate complicated watering patterns. The specification of the water requirements and the operating rules for delivering water to these assets can be complex. 

The new Source functionality allows environmental flow rules to be implemented at individual points within the system and can be configured to reflect the interconnected, spatially and temporally diverse nature of ecological system requirements and the overall impact of environmental water holdings on the system. This provides an explicitly defined, reliable environmental water management model in Source that can be easily related to the rest of the framework.  The functionality can be used to fully realise a fit for purpose integrated modelling framework for water resources planning and management that enables the representation of planning, use and accounting of environmental water, and that can be used to carry out analysis of and therefore optimisation of alternative policy scenarios for environmental water allocation and use.  The implementation of tools to configure generalised rules is a better option than individual users configuring large numbers of custom functions (which is another option), for ease of use, management and transparency. 

 The Environmental Flow Node is used to generate orders to meet in-stream environmental requirements at an individual asset. The desired flow patterns are defined by configuring one or more actions including start criteria, desired flow response and frequency, as well as criteria for determining if an action was successful and the condition of the asset targeted by the action. 

 The Environmental Flow Manager is used to prioritise environmental flow actions defined at Environmental Flow Nodes throughout the system. The EFM also handles management of environmental water accounts, and apportionment of water from an account or accounts to particular environmental events. 

These two network elements interact with each other, and the rest of the network, including the Resource Assessment System, Ordering and Flow Phases to manage environmental water.

Environmental Flows User Guide and Scientific Reference Guide

Pipe Junction Node

Source has a new node type called a pipe junction. A pair of pipe junctions can pass flows and orders to each other no matter where they are in the system. One application of this is the ability to model bidirectional flows between storages in rules based ordering.

All decisions need to be consistent from the ordering phase to the flow phase.   Left hand diagram is misleading 

They are also available in NetLp.    

Run Time Performance

eWater maintains a suite of models within our test matrix to monitor performance metrics such as run, load and save times. This release delivers significant improvement in model run times, with some models running more than six times faster than when we began our focus on performance. Our large test models have greatly improved, with the River Murray model running 43% faster. 

Shortfall Priority Management

Shortfall priorities allow users in Source to specify how shortfalls are allocated to different water requirements in rules-based ordering systems. It is configured at the scenario level and influences how water is supplied to supply points, minimum flow nodes and storages, and released by storages and splitters. Without a priority system enabled, Source will shortfall all demands proportionally within the model. 

Scenario Options, Ordering Priorities

The minimum operating constraint at a storage only applies to water requirements of lower priority than the storage.


The new Backwards Euler approach to Reservoir Routing has enabled us to implement more water management options within storages such as:

1) Outlet Path Priorities

If the storage has more than one outlet path, the storage can be configured attempt to meet higher priority outlet path requirements first in the event of a shortfall. 

2) Operating Constraints and Targets

The Operating Constraints (formerly Operating levels) affect storage releases by trying to keep the storage level or volume within the specified range. The storage will not release water to satisfy lower priority  downstream requirements if this results in the water level dropping below the Minimum Operating value. Likewise, water will be released up to the Safe Release Capacity (set at an outlet path) to prevent the storage rising above the Maximum Operating value, for example, if you wanted to leave airspace for flood mitigation. This functionality was previously only available for weirs, but is now available for storage nodes when Backwards Euler release method is enabled.  

Operating Targets have now moved under the Ordering menu. An Operating Target refers to the level that the system will attempt to maintain in a downstream storage by ordering water from an upstream storage. 


Weirs are now their own node. There is a new (optional) algorithm that may be used to model a weir as a triangular pyramid. The original algorithm only allwed modelling the weir as a rectangular wedge. The new algorithm was developed from observations of hydrodynamic models, and more realistically models the wetted (surface) area as the weir fills up. This is useful for understanding the environmental impact of weirs.


Representing rain-fed crops in the catchment context

Rain-fed crops can now be modelled in place of a standard rainfall-runoff model as a functional unit within the catchment simulation. The agricultural runoff model represents the crop water use and agricultural runoff as part of the rainfall-runoff process. The daily crop water balance is based on the irrigator demand model and the method described in FAO56 (Allen et al, 1998). It models a daily crop water use, and generates runoff from rainfall excess from the functional units. The rainfall excess can be routed as quick flow and slow flow to the rivef system.  Crop use of water from small storages in catchments can be represented by on-farm storages (also known as check dams in some countries) within the agricultural runoff model.  A number of the model parameters can be calibrated alongside other rainfall runoff models using the Source calibration wizard.  

Distribution of Rainfall on a Link

You can now choose whether rainfall-runoff is distributed to the upstream or downstream end of the receiving link. Upstream distribution means that the time delay for routed flow (from an upstream catchment) is also applied to the sub-catchment's rainfall-runoff. Because the application of baseflow is then through the routing link rather than the runoff component of the rainfall-runoff model, this can affect rainfall-runoff model parameters and constituent generation models. New models will have downstream distribution set as default. 

 Geographic editor

Easily delete sections of a large network in the improved geographic editor. To multi-select and delete nodes, links and catchments, use Ctrl+Click or lasso select (new) and simply press delete. 

Model Management

Model Version Control

eWater's software development team understands the importance of maintaining good practice for version control of our software code.  We believe that these principles are of value to our Source users to help them manage their Source projects. We have implemented functionality to facilitate a Source project version control system.  This will help you identify project changes over time such as model configuration, inputs and results.  

Project Options, Project Summary Export

Using this option, you will get a file with a file path relative to the project's that is a summary of the project. e.g:

For scenario summaries, you can use Tools \ Export Summary. The summary file will be generated every time you save the project. When making a commit to a version control system, you should commit the Source project file as well as the summary file.

The Source result file format (.res.csv) has been improved to:

  • include more metadata,
  • use ISO date formats,
  • have a consistent column order, and
  • use quotation marks "" to encapsulate all fields that may contain a comma.

These changes make it independent of the operating system specified date and number formats which can help when running a project on a number of machines or in the cloud.

If you would like more information or help setting up a version control system to use with your Source projects, please contact us.

Recorder Sets

You can now easily switch between groups of recorders by using recorder sets. Similar to scenario input sets, they can be created from existing recorder configurations, specified manually using the text editor, or from a file. To access configuration, select  Edit >> Recorder Sets.

Configuration Options 

Enable recorders manually in the project hierarchy and parameter pane, and select Edit >> Recorder Sets, right click on the scenario name and select Create Current Recorder Set.

You can specify manually using the inbuilt text editor. Select Edit >> Recorder Sets, right click on the desired scenario and select Add Empty Recorder Set. Text configuration can also be read directly from an external text file with reload on run enabled, by selecting the File instead of the Manual configuration option.

Multiple recorder sets can be enabled and recorded in a model run.

Data Aggregator

Combining models which  run at different time-steps is now possible through the introduction  of a data aggregation feature for scenario data sources, allowing for the results from a model run on a smaller timestep able to be used as in input into a model with a larger timestep eg. 6 minute to daily. 

Time Series for initial values

You can now specify initial values for Storages and Resource Assessment using a time series or function rather than having to edit all initial values when you change a run period.

Functions and Modelled variables can now be evaluated at the start of run instead of specifying initial values. Previously, at the start of a run, all the modelled variables were set to the initial value specified (0 by default). If the function using the modelled variable has a time of evaluation before that of the modelled variable, the modelled variable will not have obtained it's first value in the first time step, and the set initial value will be used.

SubSource Community Plugin

The SubSource plugin runs a second Source model at different points during the main model run. For example in the figure below the main model (blue): steps through the simulation period, using Sub model (yellow) to calculate water losses to the end of the water year to improve allocation calculations.

At each call from the main model, the sub model (yellow) simulates the Dry (worst case) scenario until the end of the water year to estimate harvestable inflows and losses for the main model.

Other Features

There have been a large number of other changes, details are available in the beta release notes, including:

  • Resource assessment improvements including using a function for:
    • Account shares in Annual Accounting
    • Annual usage limits on off allocation accounts
  • Increaced validation for Data Sources and Function usages 
  • You can Normalise Functional Unit (FU) Areas (available under Edit > Assign Areas Manually) 
  • Locking is now used in Data Sources and Functions
  • Visibility of link types has improved in Geographic Editor

Would you like to try out these new features, or perhaps use Source for the very first time? Please see our Source access and pricing policy.

We are now moving to a new software release cycle, with a production release of Source every 6 months. Our priorities for the next release will be to make sure the Source User Guide and Scientific Reference Guide are up to date, and a focus on reporting and charting functionality. If you have ideas for additional Source functionality to help your work, we're always open to collaborative projects to help develop customised functionality and implement it in your modelling work, so stay in touch. 

Details of result changes: 4.3 Result Changes from 4.1

View Source version history.


View Source 4.3 User Guide.

View detailed Source 4.3 Production release notes.


You can access these Production Beta Releases if you have a full Source licence. Contact us.

Download the Source releases from the eWater Toolkit:

Download Source Production

Download Source (public version)

Similar to the previous Source production release (version 4.1) there is a difference in functionality available in the Public and Full versions of the software. Features that are only available in the Full version are indicated with an asterisk (*).

Get Source       Download free trial