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.1 Production Release

August 2016

Download Source  Download Source (public version)

Since the previous production release, Source has had a variety of changes including new features and improved performance. Highlights are:

  • The ability to easily change model structure, input data and parameters using Scenario Input Sets, which also allow parent-child relationships;
  • Improved function management and more availability of functions;
  • Improved validation with the new Assurance Rules framework;
  • Water quality upgrades including sediment trapping and improved constituent mixing and decay;
  • Time-varying reservoir dimensions;
  • Online plugins;
  • Calibration tool improvements;
  • New groundwater/surface water interaction options;
  • Cross sections and automatic generation of rating curves;
  • A new improved wetlands solver; and
  • Enhanced results reporting, analysis and presentation.

Performance enhancements

Source software development focused on performance improvements and we have seen a reduction in model run times. A suite of models is monitored over time as part of our testing regime to quantify improvements. General improvements have been made as well as several user-configurable performance improvement options. Please see Improving Performance in this Source documentation. Options include:

  • configure networks with multiple outlet nodes to run separate networks (multiple outlets) simultaneously.
  • perform subcatchment calculations in parallel within a timestep.
  • generate water user orders simultaneously within a timestep and then pass to the supply points

New features

Cross Section Editor

With the new Cross Section Editor you can now create river cross sections and generate rating curves and then use them elsewhere in your model such as on a storage routing link or in the groundwater numerical model.

Groundwater Numerical model for 1-Dimensional flow (GN1D)*

A new numerical groundwater model on storage routing links, the Groundwater Numerical model for 1-Dimensional flow (GN1D), simulates the stream – aquifer flux and groundwater heads for a saturated connection between a river and connected unconfined aquifer. The model has been developed to meet three primary needs:

  • Improved calibration of rainfall-runoff models via better representation of groundwater interactions
  • Representation of floodplain interactions
  • Evaluation of conjunctive water use

Results Manager

Results Manager now replaces the Recording Manager as the tool to view, compare and analyse model results. New features in the Results Manager include:

  • new chart types include Double Mass plots and Bar charts. A regression line and equation have been added to the scatterplot.
  • custom charts, which make it possible to automatically refresh the same charted model results each time a model is run
  • transforms, which allow you to summarise your results in terms of percentiles, numbers, date ranges, aggregations, or a combination of these

  • powerful search and filtering capabilities including the ability to formulate complex table queries
  • chart themes enable you to create a customised chart theme according to your organisational requirements
  • report ready vector WMF output format, for including scalable charts in reports

Map View*

View your schematic nodes and links in geographic context against an OpenStreetMap background (map, photo, or hybrid)

Model management: Working with Projects and Scenarios

There have been a number of new developments focusing on making it easier to work with and customise scenarios and projects in Source.

Project Options

These options group together settings which operate on the whole project such as Unit Preferences, some Results Manager Options and *Audit Log settings

Scenario Options

These options group together settings which operate on the selected model network.

  • Set Assurance Rules to control the type of error notification which is received in certain potential error conditions such as mass balance issues.
  • Custom running configurations allows you to have multiple running configurations such as the flow calibration analysis can now be set up on different gauges without having to remove your previously configured calibration configurations
  • Be able to assign your own default schematic node rotation angle
  • Modify the order of execution of model elements
  • Decide whether to run catchments and/or process water user orders in parallel, to improve performance
  • Set a scenario projection, which can be especially useful when transferring schematic nodes to a geographic scenario.
  • *Set ordering priorities for Rules Based Ordering
  • *Customise the appearance of the Tabular editor
  • Choose maximum iterations, halving steps and a convergence limit for wetlands processing

Scenario Input Sets

Now not only modify input time series data sets through Data Sources, but also node, link and function parameters. Together with the scenario configuration option and command line running this is a powerful way to run the same model under different conditions and with different configurations.

Copy/Paste

Copy and paste a subset of nodes and links, together with any associated data sources and functions, between scenarios, as well as within the same scenario. It can even be used to copy from a schematic to a geographic scenario.

Scenario transfer node* 

Link scenarios and run them together using the new Scenario Transfer node. This node will also pass constituents, ordering and ownership between linked scenarios.

Deactivate nodes

You can deactivate some of the nodes in your model e.g. storages to run with/without the node options without needing to duplicate the scenario. Activating and deactivating nodes can be managed with Scenario Input Sets. It’s also useful when building a large scenario - you can disable most of the model and only run the section you are currently interested in.

Import Scenario*

You can now import scenarios from other project files. This works well with copy/paste to build models from a number of smaller models.

Scenario Diff Tool*

The diff scenario tool is used to compare two scenarios and explore the differences between them (Tools \ Diff), covering configuration, functions etc.. 

Export Summary

Export a summary of scenario content to .csv format. This tool also identifies parameters that can be configured in Scenario Input Sets.

Enhancements to existing features

Catchments Calibration

Two new objective functions have been added:

  • Square-root Daily, Exceedance, and Bias, which combines three terms: (i) the sum of squared errors on power transform of flow, (ii) the same sum on sorted flow values and (iii) the relative simulation bias
  • NSE Log Daily & Bias Penalty, emphasises mid-range to low flows while ensuring a low bias in total streamflow

Improvements to optimisation in the Calibration Wizard include:

  • default parameters for the Shuffled Complex Evolution (SCE) are now calculated based on the number of meta parameters used. This removes the need to adjust parameters manually to reflect the recommended settings for SCE.
  • choose the random seed used to generate the starting points for optimisation algorithms in the Calibration Wizard, allowing for repeatable calibration results

Constituents

  • Enable/Disable constituent modelling
  • Configure constituent start and end dates separately to flow, so that constituents are only run for the period when data is available.
  • Allocate catchment constituent generation and filtering according to constituent sources such as hillslopes, gullies, etc.
  • configure an observed constituent generation model in catchments to include both quick and slow flow components
  • Brune sediment trapping is now available for storages (and on storage routing links) through a community plugin. Nutrients attached to these sediments can be modelled as a proportion of the trapped sediments.

Dynamic storage dimensions

You can now add multiple storage level-volume-area relationships to represent the dynamic nature of storage volume over time, particularly relevant in high sediment producing catchments and for calibrating systems with changes to infrastructure

Feature Table

Since its release with version 3.7, the feature table has become a popular tool for Source modellers. In addition to an overview of nodes and links, the Feature Table now includes data inputs, resource assessment, ownership and functions. It provides quick access to many of the configuration attributes on Source elements, including an import/export facility which makes sharing attributes easier.

Forecasting

Rainfall and evaporation forecasting models can now be applied to storage routing links. This will improve overall forecasting accuracy in operations models.  

Functions

  • The ability to use functions has been added to a number of node/link parameters:
    • Irrigator Demand Model - Functions can now be used to specify Maximum Irrigated Area (new), Demand Limiting Factor, Spill from System and Return Efficiency.
    • Supply point -  Overbank Pump Capacity can now be specified using a function rather than a single value. This adds to the flexibility of functions already enabled for specifying Diversion Threshold and Maximum Account Deduction.
    • On-Farm Storage (OFS) within a water user node - Refilling Airspace (Planned Extractions and Unplanned Extractions) can be specified using functions. Storage Characteristics, Target Reserves and Return Flow have had this flexibility added in previous releases.
    • On-Farm Storage volume area relationships can now change over time. This can be used for specifying changes in the storage structure which may occur during the modelling period. 
  • Function usage and dependency visibility – Source is now better at showing you where a function is used and also what other functions and variables a function uses
  • View and delete all unused functions and variables
  • New variable types include two-way lookup tables and bi-linear variables

Plugin manager

The plugin manager has a new interface and now also accesses plugins which are available online

Rainfall-runoff modelling

To simplify setting up catchment models, assigning Rainfall-Runoff models and working with Functional Unit areas has been removed from the Geographic Wizard. The appearance of the Functional Unit area table was upgraded at the same time.

IHACRES-CMD replaces IHACRESClassic in the suite of available rainfall-runoff models

You can now assign ownership to the modelled flows in your catchment model.

Resource Assessment

Various updates to annual accounting and triggers, including:

being able to adjust the order in which account types, accounts, and triggers appear

Set distribution losses between river off-take and farm gate at the supply point node These values can then be used in the calculation of "usage to date" in the annual accounting resource assessment system by selecting “Usage From Account Host plus Distribution Losses” 

New Wetlands solver

A new Newton-Raphson solver with improved convergence characteristics has been implemented in wetlands. This allows for improvements in computational speed and provides valid results for a wider range of configurations, such as link capacity to storage volume relationships. The wetlands documentation has also undergone a thorough review with expanded sections clarifying the wetlands model implementation. 

Details of result changes: 4.1 Result Changes from 3.7

View Source revision history.

Documentation

View Source 4.1 User Guide.

Download

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)


Source 3.8.22 Beta Release

June 2016

Download Source Beta  Download Source (public version) Beta

The last production release was Source 4.1

This version of Source (3.8.22beta) was the production release candidate for testing and polishing for the Source 4.1 production release.  This beta release has focused once again on performance, but also function usability.

This is your last opportunity to test and provide your feedback before the production release is made available to the public – submit feedback here.

Performance

We have been working on memory and function execution management in this release, resulting in further performance improvements for some projects, such as the Paroo and Mekong models, which are running 10% faster. 

Functions

Functions are a powerful, yet complex feature of Source that allow you to control the behaviour of components within a model via an arithmetic expression. The Function Manager in Source is used to input functions for elements such as nodes, links, some catchment models, management modules, and model statistics. Functions can be applied as an alternative to a time series or single value. 

  • Function usage and dependency visibility – Source is now better at showing you where a function is used and also what other functions and variables a function uses. In 3.8.22, the Function Manager allows you to list all usages of functions and variables. Previously, only usage by nodes was listed, now you can also see which functions and variables call them. Click on the Show all function and variable usages button in the toolbar to toggle on and off.

function manager

You can also view all functions and variables that a function uses, and are therefore required for evaluating the function, by selecting it (either in the Function Manager or Function Editor) and then clicking on the Function Evaluation Tree button.

  • View and delete all unused functions and variables – You now have the ability to view only unused functions, then delete them all at once. The ability to delete all visible functions is only available when the new Unused functions and variables filter is on.

  • Time of Evaluation Improvements – If a function calls a modelled variable (x), the value of (x) the function uses is that which is correct at the time of evaluation of (x), as opposed to its value at the time the function is evaluated.  This applies only when you have specified a time of evaluation for the modelled variable. 

  • Bilinear Variables – You can now import and export bilinear variables, which are tables that allow you to look up and interpolate values in two dimensions.

 Download

You can access Source beta/s if you are covered by a software Support & Maintenance Package.

Download the latest beta/s from the eWater Toolkit:

Download Source Beta

Download Source (public version) Beta  


Source 3.8.21 Beta Release

May 2016

Improved Function Usage Visibility

The function editor previously listed which models were used by each function. Now you can see usages of other functions or modelled variables:

Function Manager

You can now import and export bilinear variables, which are tables that allow you to look up and interpolate values in two dimensions.

Faster loading results manager 

There is a much shorter delay when loading the results manager for the first time.

Logging into Source with a roaming profile

Users which have an IT system with a roaming profile configured will no longer have to log into Source each time they swap machines.

Water Users with multiple supply points

If a water user is connected to more than one supply point, there is now an option to constrain the generation of orders to be the same between minimum and maximum travel times. This simplifies the computation and ensures the defined ratio of orders between each supply point are maintained.

Water User 4 Editor

Resource Assessment

The resource assessment user interface now allows you to adjust the order in which account types, accounts, and triggers appear. 

Resource Assessment Explorer

Distribution losses between river off-take and farm gate at the supply point node (Supply Point » Distribution Loss). These values can then be used in the calculation of "usage to date" in the annual accounting resource assessment system (Edit » Resource Assessment » Annual Accounting » Usage to Date) by selecting “Usage From Account Host plus Distribution Losses”.

View detailed Source 3.8.21 beta release notes.

View Source revision history.



Source 3.8.20 Beta Release

May 2016

Performance

This beta release delivers significant improvement in model run times, with some models running more than four times faster than in 3.8.16beta. Our large test models have greatly improved, with the River Murray model running 40% faster.

Model run times of Flinders, Paroo and Namoi River Murray run times

Usability improvements

You can now define default unit preferences for logical user categories at the project settings level (Edit » Project Options » Unit Preferences). The desired units will then be set in all parts of the user interface without needing to be set each time in the user interface. Unit preferences can also be easily imported and exported via *.xml, which could be useful for organisations wanting to standardise the units used across their model suite.

Unit categories screenshot

3.8.20beta has new custom run configuration options, allowing for saved user-defined configurations for each analysis type. Once you add a new custom run configuration within scenario options (Figure 1, Edit » Scenario Options » Custom Running Configurations), it will be available to select in the simulation toolbar (Figure 2). Any settings you choose there will be saved to the custom run configuration and pre-selected next time it is selected from the simulation toolbar drop-down list. This option is useful for:

  • flow calibration analysis where you are configuring calibrations to different gauges, and
  • swapping model Time Steps with Scenario input sets, which can now be done seamlessly.

Figure 1. Defining custom run configurations

Figure 1. Defining custom run configurations screenshot

Figure 2. Selecting custom run configurations in the simulation toolbar

Daily Single Analysis screenshot

Report ready charts

The Results Manager can now export in full vector graphic format, giving a cleaner, sharper image that can be inserted into reports, either by copying directly into Microsoft Word, or saving to vector *.xps format for processing in specialised image software. With Results Manager's custom chart themes and this new functionality, you can quickly and easily format your model run results for reporting.

Results Manager screenshot

Water year reporting

The Source Results Manager can transform data to display yearly timesteps including totals, average daily, as well as maximum and minimum values. Water year can now be defined in the yearly aggregator by selecting the start month.

Storages

Source can now model variations in storage dimensions during the model run period. This is particularly useful in areas where reservoirs experience high sedimentation rates, or if storage infrastructure received significant upgrades during the modelling period. It could also be used to model the building of a storage during the modelling period.

Wetlands

A new Newton-Raphson solver with improved convergence characteristics has been implemented in wetlands. This allows for improvements in computational speed and provides valid results for a wider range of configurations, such as link capacity to storage volume relationships. The wetlands documentation has also undergone a thorough review with expanded sections clarifying the wetlands model implementation.

View detailed Source 3.8.20 beta release notes.

View Source revision history.


Source 3.8.19 Beta Release

April 2016

Performance

Source software development is currently focusing heavily on performance improvements, and we're seeing a significant reduction in some model run times. A suite of models is monitored over time as part of our testing regime to quantify improvements. Several user-configurable performance improvement options have been made available in recent Source releases. If you'd like to look into improving the performance of your model, see Improving Performance in the Source documentation. 

Flinders

Paroo

CBM

Constituent Generation

You can now configure an observed constituent generation model in catchments to include both quick and slow flow components.

Ownership

There are now more options for how ownership is allocated for gauged releases from storages. This allows you to model different rules for the ownership of storage releases. 

Results Manager

Have you explored the new results manager yet? More functionality is being added all the time. The newer versions contain powerful search and filtering capabilities including the ability to formulate complex table queries. Queries are entered into the search bar at the top of the columns and the results are highlighted within the table columns. An optional filtering check-box can also be selected, which will ensure that only rows containing matches are displayed. To learn about writing queries, please see the Results Manager - Table Query Language.

View detailed Source 3.8.19 beta release notes.

View Source revision history.


 

Source 3.8.18 Beta Release

 

February 2016

Performance Enhancement Options

We're currently developing a range of performance enhancements which include options that will allow you to change the way Source runs the model. Many of these options will be suitable for the majority of models, but they can cause changes in results for some users, so caution should be used when selecting them. These include:

  • Parallel Networks
    Networks with multiple outlet nodes can be configured to run separate networks (multiple outlets) simultaneously. This should not be selected as an option if there are calculation dependencies across the separate networks, e.g. Subnetwork 2 calls a function which involves a value from Subnetwork 1.




     

  • Simultaneous Subcatchments
    Source was originally designed to perform subcatchment calculations in sequence from the top of the catchment to the bottom. It is now possible to select a performance option which will allow Source to perform subcatchment calculations in parallel within a timestep. Once again, this is only suitable for subcatchments where values are not called from other subcatchments within the same timestep.  This can currently only be done in Source with either using a function or in catchment model plugins.

    Subcatchments can now be calculated in parallel.

    Previously, each subcatchment was calculated as it was encountered on the node-link network.



    Now, all subcatchments, including rainfall runoff and constituent generation models, are calculated in parallel.



    And then the node-link network is calculated in the normal sequence.





  • Water User Orders
    Orders generated by water users were previously calculated sequentially from the bottom to the top of the system. Orders are now generated simultaneously within a timestep and passed to the supply points. In 3.8.18beta this is now the default option for ordering. In a small number of cases that use continuous accounting, the sequence of water user orders may change the results. Future versions will allow for the parallel water user option to be turned off if necessary, but most users should be able to utilise the improved performance option without issue.

  • Audit Log 
    The audit log keeps track of the changes made to a project over time. This is particularly useful for projects that are worked on by multiple people over a period of time, but can become a processing burden, especially in the case of large projects. It is now possible to disable and clear the audit log (Edit » Project Options). Some models will show significant improvement in load and run times by selecting these options, particularly with larger models. 


    Namoi Model Run Time

Results

Results Manager now allows you to set the start/end dates for annual results. This means that you will be able to specify and report on water years.  

River Operations

It is sometimes necessary for a river operator to override the modelled storage release. When an operating target is set for the storage, the releases influence the amount of water ordered to try and meet target levels. Overridden releases values are now used to calculate the order the storage sends up stream.

View detailed Source 3.8.18 beta release notes.

View Source revision history.


Source 3.8.17 Beta Release

December 2015

This release focuses on quicker editing, improved run times, and increased flexibility for irrigation model calibration.

Editing Improvements

  • Feature editor load times – After a great deal of investigation and testing, we discovered a bug in a third party control that caused editing to get slower as project size increased. It's now much quicker for editing particularly on larger models. This is great news for users working on larger models.
  • Feature Table load time is much quicker.

Run time Improvements

  • Storage feature editors now have an additional option 'Do Not Order From Upstream Storages'. This can significantly improve run times in models that have ordering and long travel times. Other ordering options have also been renamed to be more self explanatory.

Water User

  • The irrigator crop model now generates run off and returns to on farm storage (if configured) from undeveloped areas as well as for fallow.
  • Irrigator water use is improved in cases where maximum target levels are set.

Rainfall and evaporation forecasting models can now be applied to storage routing links. This will improve overall forecasting accuracy in operations models.

View detailed Source 3.8.17 beta release notes.

View Source revision history.


Source 3.8.16 Beta Release

October 2015

This release focuses on increasing flexibility for irrigation model calibration, improving navigation and data management within Source.

  • Ability to use functions to specify more parameters
    • Irrigator Demand Model - Functions can now be used to specify Maximum Irrigated Area (new), Demand Limiting Factor, Spill from System and Return Efficiency. 
    • Supply point -  Overbank Pump Capacity can now be specified using a function rather than a single value. This adds to the flexibility of functions already enabled for specifying Diversion Threshold and Maximum Account Deduction.
    • On Farm Storage (OFS) within a water user node - Refilling Airspace (Planned Extractions and Unplanned Extractions) can be specified using functions. Storage Characteristics, Target Reserves and Return Flow have had this flexibility added in previous releases. 
  • On Farm Storage volume area relationships can now change over time. This can be used for specifying changes in the storage structure which may occur during the modelling period. 

Model Management

  • Scenario Input Sets - Scenario Input sets were introduced in Source to aid in modelling different scenarios which require no changes to the source structure, but require changes to inputs files (data sources), node parameters or functions. In Source 3.8.3 - Beta Release (September 2014) scenario input sets were expanded to include the ability to change most parameters, making their use far more versatile. In this release, Input sets can now have parent-child relationships.
  • Deactivate branches: Source now fully replicates the IQQM inactive node functionality. It has been extended further with the ability to disable entire branches of scenario as well as individual nodes. This can be useful when building a large scenario, you can disable most of the model and only run the section you are interested in. 
  • Results Manager:
    • Navigation in the Results Manager is now easier. With the Results Manager window selected, Source allows users to click on the relevant node or link in either the schematic or geographic view to automatically navigate to the results. 
    • Univariate and Bivariate Statistics will now automatically be generated and available immediately following a model run. 
    • Improvements to graphing a large number of points
  • Source now supports 4k resolution screens
  • Performance improvements in deleting nodes / links, particularly in large projects
  • Rainfall runoff model IHACRES-CMD has been implemented in Source.  IhacresClassic has been removed as an option for creating new scenarios:

View detailed Source 3.8.16 beta release notes.

View Source revision history.


Source 3.8.15 Beta Release

September 2015

This release includes performance enhancements and a key feature for IQQM to Source conversion:

  • Nodes can be deactivated for scenario modelling:
    This is the last major component required to allow IQQM users to convert their models to Source and maintain previous functionality. Deactivating individual nodes will allow a single scenario to represent progressive stages of development – reducing model maintenance, file size, and run times when working on a subset of the model for the purposes of calibration and troubleshooting. Activating and deactivating nodes can be managed with Input Sets.
     
  • Calibration Wizard improvements (these will change results of calibration runs):
    • When using Shuffled Complex Evolution (SCE), the default parameters are now calculated based on the number of meta parameters used. This removes the need to adjust parameters manually to reflect the recommended settings for SCE.
    • There is now the option to choose the random seed used to generate the starting points for optimisation algorithms in the Calibration Wizard, allowing for repeatable calibration results.
  • Bivariate Statistics now include objective functions from the Calibration Wizard:
    This enables the performance of a model to be easily evaluated without having to run the Calibration Wizard. Previously, the performance statistics available in the Bivariate Statistics tab were limited to the Nash-Sutcliffe Efficiency (Daily) and bias. 
     
  • Plugin API improvements:
    In-stream processing models can now include custom outputs.

View detailed Source 3.8.15 beta release notes.

View Source revision history.