5.52 Beta Release (April 2025)

The changes in this beta will also be available in the next Source production release.

This release includes:

• Reversion of recent changes made to the Irrigator model in Source version 5.51 beta.

• An enhancement to the handling of Rule-Based Orders in scenario transfers is made to ensure that the total water volume delivered reflects the full sum of all downstream priorities , while the recorder will display only the priorities defined in the configuration.

• Enhancements to non-extractive supply points, where the minimum constraint is set to the higher of the upstream minimum or supply point demand.

• Updates to the built-in function "ProbabilityOfExceedanceFlow" to use the PERCENTILE.INC algorithm, aligning it with the "ProbabilityOfExceedancePercentage" function for consistency in percentile calculations across Source.

• Changes to allow the Storage Filling Curve plugin to accept historical inflow data in both volume (ML) and rate (ML/day) units, with automatic unit conversion and compatibility checks to prevent errors during the model run.

• Changes to the Storage Filling Curve plugin to address issues where unexpected or missing plugin values were calculated for dates outside the 1st of the month or the filling season.

• A review of the original method applied for Spillable Water, “Total Water - Use”

• A patch recommended by MDBA to resolve concentration discrepancies in the Marker Constituent Routing system has been reviewed, approved, and implemented, with further work potentially needed.

• Fix to a bug where owners without any storage capacity who had target refill factor less than 1 were incorrectly generating orders. The model now skips refill calculations for such owners, preventing unintended order volumes.

• Updated the Flow Calibration Wizard UI for better clarity.

• Added a new assurance rule to ensure that variables with the Time of Evaluation (T.o.E.) set to Environmental Flow Prioritization have their Date Range set to Current Iteration.

• Restoration of a validation logic for the loss node configuration to ensure a monotonically increasing relationship.

• Updates to the .res.csv file format to reflect the renamed run in Results Manager, ensuring the updated run name is included in the exported results. The new format also adds the 'Today' date, applicable only in Operations mode.

• A new feature allowing users to define a custom run name for model executions. This is applicable in Operations mode from the UI and several run configurations from the command line.

• A fix for the issue where run names in charts did not update after importing renamed timeseries.

• An enhancement to the Update FunctionImporterExporterTool community plugin, enabling it to export and import bilinear variables.

• Overrides can now be exported automatically on project save from the UI.

• when a run is renamed in Results Manager, the updated name appears immediately in the UI and is included in the exported .res.csv files. The 'RunDisplayName' field is now added to exported .res.csv files, though it remains empty in auto-saved output files.

• Log Reporter is now automatically saved after Operations Mode runs (e.g., Warm Up configurations) when enabled in Scenario Options.

• Updates to the feature table to reflect the latest changes made to the Environmental Flow Node (EFN), including the settings of new spell observer logic.

• Addition of an option to select ‘None' for the 'Rise and Fall’ method in the UI, aligning with the “None” value set via scenario input sets.

• Enhancement to handling of weir outlet overrides.

SWP

• Reverted changes to the Irrigator model: Recent updates made to address forecasting issues resulted in unexpected behavior in ponded crops and the generation of 'regulated' and 'opportunistic' requirements. As a result, the changes have been reverted to the previous behavior.

• An enhancement to the handling of Rule-Based Orders in scenario transfers. Previously, upstream scenarios with limited priority levels would only display those priorities in the recorder, even if additional priorities existed in downstream scenarios. This would require users to manually reconcile total water volumes between upstream and downstream configurations. Now, the system ensures that the total water volume delivered reflects the full sum of all downstream priorities, while the recorder will display only the priorities defined in the configuration. This reduces manual reconciliation efforts and improves clarity in reporting.

  • Added a new recorder Rule Based Order>>Priorities>>n: This recorder represents the total volume of water ordered to meet the demand with the Priority Order n at this Network Element in the Minimum Travel Time number of timesteps from the current timestep. This value is determined during the order phase.

  • The sum of water volumes allocated across all priority levels (Rule Based Orders >> Priorities 1 to n) at each user site matches the total volume calculated under Rule Based Orders >> Orders >> Minimum Travel Time.

  • With Scenario Transfer Functionality, the "Rule Based Order >> Priorities>>n" recorder displays only the priority levels defined within its own configuration. It does not reflect additional priorities present in downstream scenarios.

• The following changes made to the non-extractive supply points :

  • For non-extractive supply points, the min constraint will now be set to the max (u/s min constraint, supply point demand). 

  • If the Extract water checkbox at the supply point configuration is disabled, water will not be extracted and water will pass downstream. i.e. the supply point will become non-extractive. When the supply point is set to non-extractive and the attached water user has Account Sharing enabled, the amount debited can be limited using the "Specify Maximum Account Deduction" check box and an appropriate function. By default, the amount debit from a non-extractive supply point will be the min (Flow at the Supply point, Water user demand).

  • When a supply point is set to non-extractive, the following functionality does not apply, overbank threshold, overbank pump capacity and diversion threshold. 

  • When the maximum extraction rate is enabled, it applies to both extractive and non-extractive supply points.  If required, the minimum constraint will be adjusted during to match the maximum extraction rate. 

  • Distribution loss will still be applied when the supply point is set to non-extractive. Orders by the supply point are increased to accommodate the distribution loss, and will then be increased again by the over order factor (if configured).

• Updated the built-in function "ProbabilityOfExceedanceFlow" to use the PERCENTILE.INC algorithm, aligning it with the "ProbabilityOfExceedancePercentage" function for consistency in percentile calculations across Source.

• Changes to allow the Storage Filling Curve plugin to accept historical inflow data in both volume (ML) and rate (ML/day) units, with automatic unit conversion and compatibility checks to prevent errors during the model run.

• Changes to the Storage Filling Curve plugin to address issues where unexpected or missing plugin values were calculated for dates outside the 1st of the month or the filling season. This fix has been passed to the user for review.

• To resolve varying concentration levels in the Marker Constituent Routing system, MDBA provided a series of recommended patches for the Marker code, addressing issues like discrepancies between upstream and downstream concentrations at confluences. The patch has been reviewed and approved for implementation. Note : Further work may be required to fully address the related issues.

• The original method for Spillable Water, “Total Water - Use”, did not consider water added to accounts via triggers. This method has been adjusted to be consistent with the “Carryover - Use” method where Spillable Water = Carryover Balance. Now, Spillable Water for “Total Water - Use” = Carryover Balance + Balance. This adjustment has been passed to the user for review.

• Addressed a bug where owners without any storage capacity who had target refill factor less than 1 were incorrectly generating orders. The model now skips refill calculations for such owners, preventing unintended order volumes.

• Updated the Flow Calibration Wizard UI for better clarity. The label 'End Warmup this Gauge' has been changed to 'Start Calibration this Gauge', and 'End' has been renamed to 'End Calibration this Gauge'. Additionally, the Simulation Runner plot's y-axis label has been wrapped for Objective Functions with long names to improve readability.

• Added a new assurance rule to ensure that variables with the Time of Evaluation (T.o.E.) set to Environmental Flow Prioritization have their Date Range set to Current Iteration. Variables intended to evaluate during this phase (or set to "Use Function T.o.E." with the associated function’s Time of Evaluation) must follow this rule. As a best practice, it is recommended to create a separate variable for exclusive evaluation during the Environmental Flow Prioritization phase, with its T.o.E. and Date Range set appropriately.

• The validation logic for the loss node configuration has been restored to ensure a monotonically increasing relationship, with a message displayed if the configuration is incorrect.

Open

EEWD

• A new feature allowing users to define a custom run name for model executions. This is applicable in Operations mode from the UI and several run configurations from the command line.

  • Updates include a new input field in the Warm Up Configuration window for specifying the run name.

  • Fixes to ensure the run name is properly exported in res.csv and netCDF outputs.

  • And, a new --runName parameter has been added for command line configurations such as Single Analysis, Run with Warmup, Flow-based Calibration, Replicate Analysis, and Linked Analysis.

  • Enforced validation on the Run Name field in the Warm Up Configuration window for Operations mode in the Source GUI, preventing the run name from being left blank. This ensures users always specify a valid run name prior to execution.

• Enhancement to Update FunctionImporterExporterTool community plugin, so that it is now capable of exporting and importing bilinear variables.

• Updates to the res.csv file format, ensuring that when a run is renamed via the Result Manager in the Source UI, the updated run name is reflected in the exported results. Additionally, the new version of the res.csv format includes the 'Today' date, applicable only in Operations mode.

• Improved Input Set selection in the Warmup Configuration window, now using a tree view. This update aligns with the behavior of Scenario Input Sets in the single run configuration window, enhancing consistency and usability.

• Fixed the issue where run names in charts did not update after importing renamed timeseries. Renamed run names now correctly reflect in charts within the Results Manager and Chart Settings.

• Improved the "Load a Folder of Result Files" feature, allowing users to load an entire folder containing both .res.csv and .bmd.csv files at once. Additionally, we've fixed an error that occurred when loading multiple .bmd.csv files simultaneously using the "Load Time Series" option.

• In the results manager - graphs, added the ability to persist the selection of charts or series in the plot legend. When a new time series is added, the previously selected series remain visible alongside the new one, rather than resetting the selection.

  • Single charts (Line, Cumulative, Exceedance, Residual Mass, Histogram, Cumulative Frequency, Mountain) share the same state for the checkboxes, meaning that if a series is selected or deselected in one of these charts, the selection persists across all single charts.

  • Individual charts (Difference, Addition, Scatter, Double Mass, Total Addition) maintain the state of checkboxes independently, meaning that changes to series visibility in one individual chart do not affect the selections in other individual charts.

• Addressed an issue where the vertical and horizontal scroll bars in the Tabular Editor sometimes disappeared, as observed in the RiverMurrayOps model. The scroll bars now appear as expected once the "Done" button in the Run status bar is clicked.

• Extended Log Reporter support to Operations Mode. Log Reporter is now automatically saved after Operations Mode runs (e.g., Warm Up configurations) when enabled in Scenario Options.
  This functionality was originally limited to Single Job runs. Once the project is saved with the correct setting, it will also create a Log Reporter file when run from the command line. The UI has been updated to reflect this expanded functionality.

• When a run is renamed using the Rename feature in Results Manager, the updated run name now appears immediately in the UI and is correctly included in the exported .res.csv output files.

  • res.csv files exported from Results Manager will now include the ‘RunDisplayName’ field if the run was renamed.

  • Auto-saved output files include the ‘RunDisplayName’ field, but it remains empty.

• Overrides can now be exported automatically on project save from the UI. This can be enabled via a new setting in the Project Options menu.

Open

• Override export now includes additional columns to help users identify recorders when GUIDs are unknown.

  • Improved unit handling in overrides:

    • The Unit column now correctly displays the display unit.

    • When importing overrides, unit conversion is now correctly handled. Source assumes that the unit and value match as displayed.

  • Full backward compatibility is maintained:

    • Older override files can still be imported/exported in Source 5.52.

    • Source will not throw errors when working with older versions of override files.

  • Added new command line options to support override workflows:

    • --importOverrides <path>: Imports overrides from the specified .csv file.

    • --exportOverrides [optional path]: Exports overrides to a .csv file. If no path is specified, the parameter must be placed last.

  • These command line options are currently supported only in In Process mode (not in Client-Server mode).

• Enhanced handling of weir outlet overrides: Minimum travel time is now correctly considered when pass-through orders at weirs are enabled, ensuring overridden releases align with expected downstream flow timings.

IRMU

• Updated the feature table to reflect the latest changes made to the Environmental Flow Node (EFN), including the settings of new spell observer logic.

• Added an option to select ‘None' for the 'Rise and Fall’ method in the UI, aligning with the “None” value set via scenario input sets.

  • “.Nodes.Environmental Flow Node Name.Action Name.Rise And Fall Method=None”

Open

UI when the old Environmental Flow Node Logic is enabled

Open

UI when the old Environmental Flow Node Logic is disabled

• Fixed a bug in the EFM Debited Volume recorders which caused some modelled variable tests to fail.

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.52 Regression Test ChangesPreview

Full Release Documentation