Versions Compared

Old Version 2

changes.mady.by.user Juanita Moolman

Saved on

compared with

New Version Current

changes.mady.by.user Pardha Mallipudi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

eWater is pleased to release Source 5.40, which captures improvements and enhancements from June 2023 to April 2024, key activities include:

  • incorporating the functionality in the Farm Dams plugin into core Source

  • updates to the Hot start functionality to allow users to define a file name and date for the hotstart to be saved in the command line

  • performance improvements

  • introduction of a tool to determine all functionality being used in a project

  • a wide range of bug fixes and minor enhancements

  • long-term maintenance, including upgrades to Toolkit.

Performance improvements

Projects containing a large number of functions can have performance and stability issues both through the commandline and in the Source user interface. A new application option has been added to disable the calculation and display of references between functions. With the option enabled the load and run time for projects and scenarios with a large number of functions will be significantly improved. Enabling the option though will disable deletion validation in the UI.

Source Projects Analytics File

As part of our long-term maintenance focus, we have created a tool to identify the Source functionality used in a project. This will give critical insights to help prioritise maintenance and insights into how important different components of Source are to users. The tool is accessed via the RiverSystem commandline application, results can be saved on the local hard drive or sent to eWater. It is available as an extra option in Command Line Runner Single Analysis

Display option commands

Function

Example

Code Block
--saveAnalytics

This option will generate an XML analytics file for the loaded project. When no file path is specified, the file will be saved next to the project file. Alternatively, a file path can be specified to save the generated analytics file.

If this option is selected along with others in this table, if a file path to save is not specified, it must be the last option chosen.  

This option can only be used in InProcess mode.

Code Block
--saveAnalytics
--saveAnalytics "C:\\foldername\\analyticsfilename.anl.xml"

Enhancements &. Bug Fixes

Some other smaller enhancements and bug fixes are:

  • users can now delete or rename Functional Units

...

  • assign minimum and maximum pond levels through scenario input sets

  • resolving a bug in the Piecewise linear variable to recognize decimal places

  • resolving a bug in Results Manager that was preventing the comparison of calibration results of storage levels 

  • changes to automatically remove the relevant application such as the rainfall-runoff and constituent model after functional units are deleted

  • bug fixes to allow Minimum Flow Requirements that are set through the Min Flow node to be overridden through the Tabular Editor, including when the flow is set by either a rule curve or monthly pattern.

Long term maintenance

Over the past year, eWater has been prioritising a number of critical long term maintenance activities, including:

  • audit of technologies used, including supporting and 3rd party technologies as well as core technologies 

  • preliminary risk assessment of these technology dependencies

  • critical maintenance to Toolkit and updates to improve the user experience, including a more seamless process for freeing up floating licences and resolving issues with user verification.  

...

  • New functionality to represent Water Trade

  • Bug fixes and enhancements to how Environmental Flows are managed in Source

  • Debugger - a tool to diagnose and evaluate a run

  • Enhancements to the Farm Dams functionality include adding a dead storage & voluntary release to the onstream farm dam node

  • Other enhancements and bug fixes

Trade Manager

The Trade Manager (TM) functionality in Source replaces a plugin built by the MDBA, making water trade modelling available to all users, allowing the specification of trade rules to be defined through a standardised piece of functionality. A review of the tool has also allowed improvements to the functionality incorporated in Source providing additional features and recorder options. The trade manager incorporates the conceptualisation of economic demand and supply concepts into how trades occur between water users.

The Trade Manager is accessed through  "Trade Manager" on the "Edit" menu of Source. More information on how to use the trade Manger can be found at Trade+Manager in the Source User Guide.

...

Environmental Flows

Improvements to the representation of environmental flows have been done at the request of MDBA. These have included:

  • A fix to the Number of Spells Started in Season recorder. After this fix the number of spells started in the season increments only when the threshold is met, and the spell is started. This change will cause a change to any results or functions based on this recorder

  • The project could not be saved when an action was removed from an Environmental Flow Manager (EFM) Group and added to a new Group. Code changes were made to fix this and now projects can be saved without error.

  • A new field ‘Number of spells required for success’ has been added to the UI and a new recorderto track spells based on antecedent condition.

...

Debugger

Debugger is a diagnostic tool that allows pausing during a run and displaying current model values (using something similar to modelled variables to do so). Although it has been developed to help modellers understand the internals of the Environmental Flow node / manager and Resource Assessment, it can be used for all aspects of Source and provides a useful tool for modellers to debug and understand what is happening with their scenarios and projects.

More information on how to use the Debugger tool can be found at Debugger+-+User+Guide.

Farm Dams enhancements

Enhancements to the Farm Dams functionality in Source include:

  • allowing Bypass flow to also be determined according to a Monthly Pattern, a Data Source or a Function

  • adding a Dead Storage Volume to model a minimum volume which will remain in the Fam Dam. This volume can be based on an absolute volume or a proportion of the Dam Capacity. It can also be allowed to vary according to values entered using a Data Source or a Function

  • adding a voluntary Release Volume to the onstream farm dam node to meet downstream requirements without ordering. The Release Volume can also be managed according to values derived from a Data Source or a Function

...

Enhancements &. Bug Fixes

Other enhancements and bug fixes include:

  • After many user queries regarding Source bivariate statistics results, a review was undertaken to ensure alignment between Source documentation and code implementation of the equations. The provenance of the implementation of log-based bivariate statistics has been confirmed. Variations have occurred since the original implementation in 2015. The ‘c’ factor applied in Source to avoid numerical problems with attempting to calculate the logarithm of zero flows, is confirmed as equal to max(10th percentile of observed non-zero flows, 1ML).

  • Source window moves to the background upon closing Diff Window. Now fixed.

  • NullReferenceException in Final step of calibration wizard. The Issue seems to be related to methods RunManagerOnUpdateEvent and ProcessStatte in the class SimulationRunnerWithResults. Now fixed.

  • Priority orders are not maintained through a storage with "Pass through Orders" selected. A patch was provided by MDBA and the issue is now fixed.

  • Transfer Ownership Node: Unable to set ownership with Functions. Ownership can now be set using a Function

  • Can not delete restriction level in the triggers table in restriction curve. Fixed now.

  • Keep the Choose Scenario interface after the first clicking on Find Differences button in Diff Tool. Now fixed.

  • Can't specify "Current Recorder Tree" with --rs option. Working as expected.

  • Crop not selectable for irrigator demand model if use pattern is on with a monthly time step configuration. This is only an issue if using crops previously configured with monthly crop factor patterns for use with an IQQM demand model. The Irrigator Demand model requires the pattern input in a daily form. A message will now notify the user that crops with monthly crop factor patterns are not available to the Irrigator Demand Model.

  • Non Value (-9999) is involved in the Date Range calculation for preview. Fixed now.

  • Calibration results for multiple model elements: display the component objective function scores not just the combined objective value. Fixed now.

  • Invalid No. of agents prevents opening calibration configuration. Fixed now.

  • View Calibration Results Modelled Results Missing from Table and Statistics. Fixed now.

  • Timeseries Aggregation Doesn't Work. Fixed now.

  • Change Screen width to be wider to accommodate working on large complex projects. This applies to entries in the Piecewise Linear option in Storage Routing links.

  • Correct the "License expiry date" message on splash screen.

  • Issue with run name for Linked Scenarios. No duplicate names are displayed now.

  • Editing certain values for Storage Node in Feature Table causes Source to crash. User can now edit parameters for storage node in the Feature Table.

  • The overridden value in the gauge release does not persist when changed in operations mode. Fixed now.

  • Issue exporting functions from set of active recorders in Tabular editor. Fixed now

  • Projects created before v4.2.9 (October 2017) cannot be opened in v5.14 or later. Fixedon Version: Source 5.32.0.13017

  • Deleting last run from Dora tree also deletes the Latest Run. Fixed now

  • The Source project crashes when attempting to import a scenario into a project file. Fixed now.

  • Issue in importing function recorder in Tabular Editor recorders. Fixed now

  • Ops project disables Gauged Release after run. Fixed now

  • Gauged Release Value in the UI is being overridden by the Owner Releases value after the run.

  • Create an Assurance Rule to warn users if they have renamed a csv column when loading by position. Fixed but Note that the solution for a renamed CSV column when loading by position is only for reloading on the run, and there is no method to provide a warning when manually reloading the file.

  • The no account host does not work in the transfer trigger. Fixed now

  • Investigate execution order of functions on same element and Time of Evaluation.

  • Duplicate run names when using saved run. If there are saved run in Results Manager, new run numbers will start after the highest saved run number.

  • Calibration results in Scenario options don't export to a relative path. Fixed now.

  • Off Allocation recorder appears to be off by a factor of 4. This addressed calculation issues and duplicate recorder issues. Two recorders are added:

...

Regression testing

There is no tolerance in our regression test suite to allow for earlier identification of results being different on different machines or versions of operating systems. 

See: 5.40 Regression Test Changes

Full release documentation

...