There are several user-configurable options in Source that can be used to increase performance (ie. reduce model run times) by changing 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.
...
To turn off all recorded parameters, in the Project Hierarchy, right click on the scenario's name and select Record None (Figure 1). Navigate to the parameters of interest using the Project Hierarchy and Parameters pane, right-click on the parameter and choose Record All (Figure 1). For more information, see recording parameters.
Figure 1. Selecting recording parameters
Parallel Networks
Networks with multiple outlet nodes (Figure 2) can be configured to run separate networks simultaneously by selecting Run Separate Networks in Parallel (Figure 3). 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.
Figure 2. Example of geographic and schematic scenarios with multiple outlets
Figure 3. Configure single analysis, Run Separate Networks Parallel
Minimise what is run during model setup
...
Components of a model can be deactivated by right-clicking on them in the either Schematic Editor or Geographic Editor and choosing Deactivate. Deactivated nodes are indicated by a grey circle backlash symbol on top of the node icon. Deactivated links become a solid grey line. (Figure 4). . In Geographic Editor, deactivating a link will change the border of its associated sub-catchment to grey.Deactivating large sections of a model (eg. a network branch) will improve performance by decreasing model run-time. This can be useful when you are working with part of a model only, eg. during calibration.
...
For more information on deactivation in Schematic Editor see here, and for Geographic Editor, see here.
Figure 4. Node and link deactivation
...
Figure 5. Scenario Options, Assurance Rules
Simultaneous Subcatchments
...
Water User Orders
Orders generated by water users were previously calculated sequentially from the bottom to the top of the system. As of 3.8.18beta, Process Water User Orders in Parallel is enabled by default, which means that orders are generated simultaneously within a timestep and passed to the supply points. This will decrease model run times.
...
Figure 7. Scenario Options, Rules Based Ordering.
Storage Dimensions
When configuring a storage, give consideration to the number of points used to define its dimensions, and use the minimum number of points necessary. minimise the number of points used to define its dimensions. The more points there are, the greater the processing time during a run.
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. Access this option through Edit » Project Options.
Computing Environment
To ensure optimal performance, use Source on a computer that meets the minimum System Requirements. Standard laptop drives are not recommended for optimum performance. Also, we suggest reducing what else is running on your computer. If you are using a server to run Source, ask system administrators to reduce the services that are running. For advice on optimising server performance, see these two microsoft articles: here and here.
Microsoft .NET version 4.6.0 has a performance issue that affects Source performance, particularly when saving projects. If you upgrade to 4.6.1, it will resolve the performance issue.
Garbage Collection (GC) Settings
Garbage Collection (GC) is a process that helps your computer manage memory automatically while running applications. It cleans up unused or temporary data, making sure your application runs smoothly. When running Source, you have the option to configure the GC mode to one of two options: Workstation GC or Server GC (this shouldn't be confused with Source's client/server configuration). Understanding the differences between these modes and knowing how to switch between them can help you optimize the runtime of your models.
- Workstation GC:
- Single-threaded: Workstation GC operates on a single thread, making it suitable for desktops with lower memory and CPU.
- Switching to Workstation GC: This is the default GC mode in Source, running Source under normal conditions will use this configuration.
- Server GC:
- Multithreaded: Server GC uses multiple threads to handle garbage collection, which can significantly reduce pause times and improve performance for applications with high memory allocation rates and large heap sizes (i.e. this could result in a shorter runtime for your Source model).
- High-throughput Optimization: Designed for server environments and desktops with multi-processor systems, making it more efficient for heavy workloads.
- Switching to Server GC: To enable Server GC in Source, you need to modify the
RiverSystem.Forms.exe.configfile (orRiverSystem.CommandLine.exe.configif you're using the command line version) in the Source installation directory before running the application. By default, Source uses Workstation GC, but you can switch to Server GC by adding the following code snippet between the<configuration>tags of the appropriate configuration file:
<configuration>
...
<runtime>
<gcServer enabled="true"/>
</runtime>
...
</configuration>
Note: The <runtime> tag is typically not present in the configuration file by default, so you will need to add it before setting gcServer enabled to true as shown in the above snippet. Removing <gcServer enabled="true"/> or change it to <gcServer enabled="false"/> will use Workstation GC.