...
NB: Geoff D to add a new picture
A new
...
recorder for ordering
We have developed a new recorder to better analyse orders, it shows all the nodes and links in a network and what their orders and requirements are on a particular date and is a debugging tool for the ordering system. Available under: Miscellaneous \ Ordering \ Order Crawler. The Order Crawler is a fully interactive zoomable schematic that shows:
- order data for all nodes and links (water users show their requirements)
- the entire network with node locations in the same location as the network
- the minimum order time values (same value as order recorder) e.g. if order travel time is 3 (minimum) to 5 (maximum) days the orders for 3 days out will be shown.
Note that for large networks, it does record a lot of data and is primarily for problem-solving and not intended to always be turned on.
Results Streaming
Results can now be streamed to files on disk rather than stored in memory. This is to prevent memory issues with large runs. Results streaming is off by default, however, it can be turned on in Project Options:
The format used (called Source Time Series Database .sdb) is now also available as a general timeseries format.
...
We have made changes to significantly improve performance for editing and saving in some large models, for one project this reduced the time to save from 12 minutes to 45 seconds.
We have also improved the performance of the command line so that less memory (RAM) is now used during a run. Run times have been reduced in the command line.
The command line now has additional options for results saving:
...
--resultsOutputMode
There are three modes currently available:
- NoOutput - Does not save results anywhere, hence does not fetch results either. Can be used where the result data files are ignored. E.g. in tests, or where a plugin gives a different pathway to results. This improves performance when using automatic exporting tools such as Scenario Options: Simulation results or Simulation Log which automatically exports results after each run to a specific location.
- ClientNamedFormat- Results fetched to client, saved to output file from there, in a format based on output file extension. The data is transferred back to the client and saved (current behaviour).
- ServerNamedFormat - Results saved to output file directly from server, in a format based on output file extension. Does not fetch results to client. This "server side" save is more efficient. Default for InProcess mode, since "server side" is local here. Can be used in Client mode, assuming the end user has access to the path provided to the server e.g. a network drive.
A new Water User and Constraint Phase
...
We recommend you review any functions that are evaluated in the ordering phase and ensure they are configured correctly using: Edit \ Feature Table.. \ Functions.
New Version Number system
We have changed the version number system to help users understand when they need a new version of Source to open projects. The previous database version was a letter that wasn't in the version number.
The previous system was:
...
Order
...
Name
...
New system:
...
Order
...
Name
...
Essentially a unique identifier for Source builds
...
Results Streaming
Results can now be streamed to files on disk rather than stored in memory. This is to prevent memory issues with large runs. Results streaming is off by default, however, it can be turned on in Project Options:
The format used (called Source Time Series Database .sdb) is now also available as a general timeseries format.
Performance improvements
We have made changes to significantly improve performance for editing and saving in some large models, for one project this reduced the time to save from 12 minutes to 45 seconds.
We have also improved the performance of the command line so that less memory (RAM) is now used during a run. Run times have been reduced in the command line.
The command line now has additional options for results saving:
|
There are three modes currently available:
- NoOutput - Does not save results anywhere, hence does not fetch results either. Can be used where the result data files are ignored. E.g. in tests, or where a plugin gives a different pathway to results. This improves performance when using automatic exporting tools such as Scenario Options: Simulation results or Simulation Log which automatically exports results after each run to a specific location.
- ClientNamedFormat- Results fetched to client, saved to output file from there, in a format based on output file extension. The data is transferred back to the client and saved (current behaviour).
- ServerNamedFormat - Results saved to output file directly from server, in a format based on output file extension. Does not fetch results to client. This "server side" save is more efficient. Default for InProcess mode, since "server side" is local here. Can be used in Client mode, assuming the end user has access to the path provided to the server e.g. a network drive.
Summary of minor changes
- We have made improvements to Date Ranges. This will change results for a number of users, so we have implemented a Scenario Option to turn on the new Date Ranges algorithm. Existing projects won't be using the new method and will have to manually swap over. This gives users a chance to test the new implementation before it becomes the only option.
We have introduced the concept of Locking to the Function Modelled Variables, selected variables can now be locked, making it less likely for mistakes to occur.
Ordering for the Irrigator demand model now includes an option to make the Flow phase and Order phase identical.
Data Sources can now find data based on the column name rather than the index. Being able to match by name is important when using Reload on Run. Match data items by Name is now the default option.
It will validate and fail to run if you are matching based on name and reload a file with duplicate names.You can now freeze columns and drag columns to reorder the columns in the Allocation table within Resource Assessment.
Constituent Trend and % removal model. Links and Storages decay models have been extended to include a decay to a background concentration rather than to 0 and a % removal that can occur after the decay.
- Annual Accounting recorder changes. Some annual accounting recorders at RAS system level were giving incorrect values. The recorded values of "Total account spill reduction", "Total usage water year" and "Total Account Adjustments" at RAS system level values will change. See RM-18149 for details.
- Ownership adjustment for storages and weirs - End of day volumes in Storages and Weirs can now be adjusted.
- Custom charts now include a search bar and more menu items under right-click. Customs charts are also no longer saved by default. All automatically generated charts are created under Temporary and only saved when moved into Saved. Users can also create folders and subfolders for organising custom charts.
- We have made changes to the version numbering system to help users understand when they need a new version of Source to open projects. Details are available at:
Community Plugin Changes
We have moved to .net 4.8.0 which requires Visual Studio 2019. We are planning on moving to .NET 5. The transition to .NET 5.0 won't be a quick process as some components we currently use will no longer be supported, however it does provide a potential pathway to running natively on Linux. Source can currently be run on Linux under Wine, but only natively on Windows.
...