5.31 Beta Release (Dec 2023)

Owned by Pardha Mallipudi
Last updated: 22 Feb 2024
6 min read

The changes in this beta will also be available in the next Source production release due out at in May 2024.

This release includes:

  • A prototype reach scale Water balance Tool.

  • New functionality to represent water trade

  • Bug fixes to address issues with the Environmental Flow Node

  • Other enhancements and bug Fixes

Water Balance Tool:

  • Water Balance Tool provides an ability to partition the network into the user defined reaches based on reach network elements and define flux components. It will alert the user where the fluxes are not adding up for a mass balance by generating reach-by-reach water balance summary for a given time period. 

  • User can define reach by specifying upstream and downstream boundary nodes and by including the network elements with flux components. 

 

  •  User can generate the water balance report by including defined reaches, data aggregation approach (monthly/yearly) and report start/end dates. For each water balance report, report column can be specified with flux type (gain/loss/change in storage).  

 

  • User can turn on water balance analysis recorder for the report in the project hierarchy and can see the generated water balance report in the Results Manager. User can also export high-level water balance summary along with monthly/yearly aggregated timeseries for each report column.  

 

  

Note: This is a prototype build undergoing testing; thus, it is not yet available for download. It will be released as part of the core application soon. 

Trade Manager:

  • The purpose of the Trade Manager is to improve and standardise the functionality about defining how Trade happens in Source. The current implementation used by MDBA with their Trade Plugin is reliant on the options available in the Resource Assessment System Trigger specification. The attempt is to allow the specification of trade rules that could be defined through a dedicated piece of functionality. 

  • A user can find the option "Trade Manager" from the "Edit" menu of Source.

  • User has to check the box "Enabled" to enable the functionality of Trade Manager.

  • In the left-hand pane of the Trade Manager Tree, you can see 2 entities: Trade Groups and Trade Rules

 

  • The following are the UI interactions to them.

  • Right-click ‘Trade Groups’ to see a ‘Add New Trade Group’ option.

  • Right-click a specific Trade Group that is created as 'Group 1' to see a ‘Rename’ and ‘Delete Trade Group’ options.

  • For each Trade Group, we can select any number of water users available that are not assigned to any other groups.

  •  By clicking the "Trade Rules" screen, you can see all the configured Trade Groups in a table with the following columns:

  1. Name - name of the Trade Groups created by user.

  2. Can Trade - can be Value/Function/Timeseries

  3. Max Trade In - can be Value/Function/Timeseries

  4. Max Trade Out - can be Value/Function/Timeseries

  • That's how we define Trade rules among the trade groups. 

Bug fixes on Environmental flow:

RM-17420: Number of Spells Started in Season counting before threshold exceeded.

Summary of the issue:

The recorder 'Number of Spells Started in Season' is beginning to count spells starting, despite the threshold NOT being exceeded.

Investigation comments:

As the reporter's observations suggest, the number of spells started recorded does not behave as described in the User Guide. The recorder keeps track of the spells started in the model internally, regardless of the spells' status, without checking whether the spell has started by reaching the threshold flow value. The recorder has been adjusted to align its recording with what is described in the User Guide. Now, the number of spells started in the season increments only when the threshold is met, and the spell is started. With this change, the results of the scenario appear as follows:

It is also worth noting that this change causes four parallel fast regression tests to fail. Specifically,

  • SourceRegressionTests\Nodes\Environmental Flow\One spell no manager simple\One spell no manager simple.rsproj

  • SourceRegressionTests\Nodes\Environmental Flow\One spell no manager complex\One spell no manager complex.rsproj

  • SourceRegressionTests\Nodes\Environmental Flow\Two spells no manager\Two spells no manager.rsproj

  • SourceRegressionTests\Environmental Flow Manager\Two spells with manager\Two spells with manager.rsproj

All of these tests are related to directly observing the outcome of this recorder. So, the failures are expected.

 This recorder change has been integrated to the latest beta version (5.31 beta) and the four parallel fast regression tests that were failing with this change have been updated with the new values of the 'Number of Spells Started in Season' recorder.

 

RM-18763 - EFM Group unable to move action to new Group

Summary of the issue:

The project cannot be saved when an action is removed from an Environmental Flow Manager (EFM) Group and added to a new Group.

Investigation comments:

Code changes were made to fix this issue and should be available in 5.31 Beta version. Now the projects can be saved without the error that appeared when saving after removing actions from an EFM Group and adding to a new Group.

Enhancements &. Bug Fixes:

Minor enhancements and Bug fixes include:

  • 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.

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.31 Regression Test Changes

 

Full Release Documentation

type key status summary assignee reporter
Refresh