This section describes the Source processing tools and component models that are installed by default or are plugins to in Source. For detailed descriptions of component models, see the Source Scientific Reference Guide.
Mapping Analysis window
The mapping analysis window displays a spatial map of the of flows and constituent loads per sub-catchment and can be accessed using . . You The relevant catchment variables need to have been recorded in the Scenario run to be able to view them in the Map Analysis Window. You can perform the following functions in this window:
- To display the individual flows and loads in each sub-catchment, under Map Details, click to open the Runs drop-down menu. Choose a scenario, then the desired Variable and Statistic values from the respective drop-down menus. Move the mouse curser cursor over a sub-catchment in the map view. A tool-tip appears near the mouse cursor, indicating the variable amount of constituent exported for that sub-catchment per year (Figure 1);
- Flows are reported in ML/d and constituent loads in kg/d;
- You can compare calculate the statistics of difference between two scenario runs by enabling the Subtract checkbox. Carry out the same steps outlined above for the mapping analysis window;Displays the difference in total loads for the selected constituent for each sub-catchment in kg per year; and
- Display results per unit area by enabling the Divide by Area checkbox. Flow depth is reported in m/s and constituent load in t/km2/y.
Figure 1. Mapping form with tool-tip showing TSS
Data unit converter
This tool converts units (embedded into data files) in Source from one type to another. You can access it from (Figure 2).
Figure 2. Data Unit Converter
Use the converter as follows:
- Drag and drop the input a data file onto the Source data window in the left side panel. If there are units in the data file, they will appear in the units field below the input window. If they do not, log an issue into JIRA;
- Enter the output/target units in the Units field on the right side (under Converted Data). You can either use the default name (copied from the source data file) or enter a new name; and
- Click Convert. To save the converted file, you have to drag it somewhere else in Source that has a Save as function. You cannot right-click the converted data graph and save it.
Note that if there are no units in the input file, you must force the data converter to assume that there are input units by ticking the Override input units checkbox and entering the "assumed" unit under Units. For example, you have a CSV file containing dates and rainfall, but it does not contain any units. You want an output containing metres per day. Assume the input is in mm/day:
- Drop the input file into the Source data window;
- Tick the Override units checkbox;
- Enter mm.day-1 into the Units field;
- In the converted data window, enter the name for the converted data set;
- In the converted data window units field, enter m.day-1 (this is metres per day); and
- Click Convert. The converted data should be scaled down.
You can also scale the converted output to your desired units by ticking the Use converting quantity checkbox. Enter a non-zero value into the Value field and click Convert to scale the output by both the value and the difference in magnitude of the units eg 0.5 mm/h converted to m/h with value 3 ends up being 0.0005 m/h. Note that you must specify both the source value and the target units.
Right clicking in the 'Converted data' window will reveal a pop-up menu of options. This enables zooming, panning, dragging, formatting and copying a picture of the output graph to the paste buffer.
Data calculator
The Data calculator can be used to analyse spatial data and time series through the use of simple arithmetic operators. A single data set or two comparable data sets can be analysed using the data calculator. In Source, you can access it using .
You can use rasters, time series or numbers as operands:
- Drag and drop raster data or time series into either of the two view controls (raster or time series are displayed in a small window called a View Control (Figure 3) or use a combination of a raster/time series and a number.
- Use the radio buttons to select either the view control or the numeric value values as left and right operands.
- Click one of the basic operations buttons (addition, subtraction, square root etc). The data calculator displays the operand you selected.
- Click =, and the result, either raster/time series or numeric, appears in the results area on the right.
| Info | ||
|---|---|---|
| ||
| Note: Time series and spatial data need to be in a format compatible with Source. See File formats. |
The memory feature of the data calculator allows you to save previous results, either numeric or raster/time-series.
Click Memory to open the memory area. To save a result raster/time series into the memory, click on the 1st or 2nd operand, or result, view control, then drag and drop the contents into your desired memory view control. The label above each view control resides shows the mathematical operation leading to the result stored there. Figure 3 shows the memory area with several stored results.
Figure 3. Data Calculator with data stored in memory
| Info | ||
|---|---|---|
| ||
| Note: When you close the data calculator, the stored results are not saved. If you want to keep any of the rasters, right-click the raster, and choose Save from the contextual menu. |
To save any of the results, right-click any of the view controls, and choose Save from the pop-up menu. You can also drag the contents of any view control into any other view control or graph form anywhere else in Source.
The Stats tab gives a statistical summary of the data sets that have been analysed with the Data Calculator. The Reflected Operations tab provides additional data manipulation operations, such as Merge, find Maximum value or multiply two rasters. It allows you to perform customised operations. You can use a plugin to create these operations, which then appear on the list, and can be performed on various data sets.
Data modification tool
Figure 4. The Data modification tool
Contributor
The Contributor plugin is used to determine how much constituent travels to a point in a network. For example, you may calculate the amount of suspended solids that run off a sub-catchment that have been transported to the mouth of a river (the assumption is that proportions of the runoff are deposited in the network as it travels through the catchment). Use the following plugin file:
| Code Block |
|---|
C:\Program Files\eWater\Source version\Plugins\RiverSystem.Plugins.Contributor.dll |
Location in Source:
| Info | ||
|---|---|---|
| ||
Note: You must have a scenario open with runs recorded before you can use Contributor. |
Basic operation
Select and run the constituent of interest (functional units cannot be chosen yet). The map provides a graphical representation of the amount of the constituents that have contributed to the terminal (or outlet) node in the network (Figure 5). You can select another point in the system by clicking on the link above the desired node on the map. The results are automatically recalculated and may be standardised for catchment areas by clicking the Standardise for area checkbox at the bottom left of the plugin window.
Figure 5. Contributor tool, spatial analysis
The Table tab shows the results in tabular form (Figure 6). You can export the results to a .CSV file by clicking Export.
Figure 6. Contributor tool tabular results
Spatial data pre-processor
The spatial data pre-processor offers a range of tools that can be used to manipulate spatial data.
Plugin file:
| Code Block |
|---|
C:\Program Files\eWater\Source version\Plugins\RiverSystem.Plugins.SpatialDataPreProcessor.dll |
Location in Source:
QuickRemap
The QuickRemap tool allows the grid codes of a raster file to be changed in an easy manner by changing the values in the table and running the tool to get a new raster:
- Drag and drop a raster into the src box. This is the source raster from which remapping will be done;
- Enter the modified grid codes that map to certain layers within the raster. For example, a forest layer in a land use map may have a grid code of 3. If a scenario is required where the forest is cleared for horticulture, the grid code may need to be changed to 5, to signify that it is a Horticulture FU.
- Click Run and the remapped raster appears in the dest box. This can be saved to disk.
CreateMask
The CreateMask tool creates a new raster of the same dimensions as the source raster with grid cell values that equal the mask value. Therefore, all non-null values in the raster grid are replaced with the maskValue parameter. This can be done as follows:
- Drag and drop a raster into the src pane. This is the source raster from which remapping will be done;
- Enter a value for maskValue, which will replace all the non-null values in the raster grid. For example, a maskValue of 1 (default) will produce a new raster with the value of 1 in all cells that are not null values; and
- Click Run and the new mask raster appears in the dest pane. This can be saved to disk.
CookieCut
The CookieCut tool allows a portion of a larger raster to be "cut out" and a new raster produced. This may be useful when you only need a small segment of a large land use or DEM file.
- Drag and drop the raster that a segment is to be "cut" from into the "dough" pane;
- In the cutter pane drag and drop the raster that will mark the dimensions or border of the new raster; and
- Click Run and the new segment raster is displayed in the cookie pane and can be saved using the Save icon to the left of the Cookie pane.
SelectColumns FromVectors
The SelectColumnsFromVectors tool extracts a particular attribute column from a vector map (ie. shape file) and creates a new vector map based on the selected attribute.
- Drag and drop a vector file (such as a shape file) into the sourceData pane. A list of attributes is displayed. To display the spatial extent of the attribute, select the attribute name in the sourceData pane. The number of the attribute column is displayed under Hide.
- Set the attribute column number in the entryToTake pane. In the example shown a value of 1 corresponds to the GRIDCODE attribute column.
- Click Run. The resulting vector map is displayed in the destinationData window, which contains only the attribute in the column corresponding to the value specified in entryToTake.
Sub-catchment Union
The Sub-catchmentUnion tool joins all sub-catchments in a sub-catchment raster into a single catchment area:
- Drag and drop a sub-catchment raster into the src pane.
- Click BI. The resulting catchment raster is displayed in the dest pane and can be saved by clicking Save.
HazardMap Scaling
Hazard maps are useful for informing catchment and land managers of those parts of the landscape that are most vulnerable to certain environment hazards, such as soil erosion or salinity. Scaling the Event Mean Concentration (EMC) and the Dry Weather Concentration (DWC) values using an erosion hazard map allows areas with "hazardous" land uses (eg. highly grazed areas can be susceptible to higher levels of soil loss) to reflect the expected constituent magnitudes in such areas.
EMC and DWC parameters are determined from analysis of water quality data and are given as a minimum, median and maximum for each land use - but can be considered to apply to that land use only if it has a median erosion hazard. If the erosion hazard is above or below the median, the DWC and EMC need to be modified for that land use in that particular location. The erosion hazard map is defined as a weighted sum of the Universal Soil Loss Equation (USLE) and gully density maps (these can be generated using eWater SedNet). The weights are chosen by the user but are conceptually a function of the sediment delivery ratio (SDR). The default values are 1.5 and 0.05 for gully density and USLE respectively.
The erosion hazard map is used to compute the median, min and max values for each land use across the whole catchment, and for each land use within each sub-catchment. So, for every sub-catchment and every land use within each sub-catchment, there is a value of min, median and max erosion hazard.
The EMC and DWC values applied to a particular land use in a particular sub-catchment is computed from the ratio of sub-catchment to global values multiplied by the global EMCs and DWCs for each land use. This can be best illustrated via the hypothetical example where Table 1 for tree and grass EMCs for each sub-catchment is computed by using Table 2 and Table 3 to linearly scale Table 4.
Table 1. Derived event mean concentrations (example values)
Sub-catchment number | EMC for area covered by trees | EMC for area covered by grass |
|---|---|---|
1 | 12.5 | 86.7 |
2 | 20 | 100 |
3 | 52 | 180 |
Table 2. Erosion hazard (example values)
Global erosion hazard values | Minimum | Median | Maximum |
|---|---|---|---|
Trees | 1 | 5 | 10 |
Grass | 5 | 50 | 100 |
Table 3. Erosion hazard per sub-catchment (example values)
Sub-catchment number | Erosion hazard for area covered by trees | Erosion hazard for area covered by grass |
|---|---|---|
1 | 2 | 40 |
2 | 5 | 50 |
3 | 9 | 60 |
Total for all sub-catchments | 16 | 150 |
Table 4. Event mean concentrations (example values)
Global EMC values | Minimum | Median | Maximum |
|---|---|---|---|
Trees | 10 | 20 | 60 |
Grass | 40 | 100 | 500 |
| Info | ||
|---|---|---|
| ||
Note: It is recommended that the Hazard Map be generated external to Source using a spatial data mapping and editing package. Note: Functional unit names must exactly match the list displayed in the EMC window. An alternative approach is to save out the empty EMC/DWC files as a template to ensure functional unit names/spaces and spelling are correct. This table can then be populated with minimum, median and maximum EMC/DWC values and loaded into Source. |
The basic approach to scaling EMC and DWC values using a hazard map is as follows:
- Choose
- Choose Scale EMCs and DWCs using Hazard Map from the Available Methods drop-down menu.
- The sub-catchment and functional unit maps will automatically be displayed in the second and third boxes with the hazard map box initially blank.
- Drag and drop a hazard map into the blank window.
- Click on the Parameter tab. The Output, Constraint and State tabs can be ignored, as they are automatically generated by Source.
- Select the Constituent type from the Select Element drop-down menu (eg. TSS).
- Manually enter or load a text file containing functional unit name, minimum median and maximum EMC values for each corresponding functional unit type. An example is given in Figure for EMC values. Repeat for DWC window.
- Percentile - specifies the percentile bound for generating the regional hazard statistics visible under the State tab;
- Processing cell size - this parameter can be ignored. The ProcessingCellSize is used when rasterising the FU land use and Hazard maps, and is set to a default of 100, which is 100 meters wide (and high). A smaller the size results in a finer the scale for spatial scaling of erosion hazard values, but processing will take longer; and
- Use FU areas - this parameter can be ignored as it is automatically generated and requires no input from the user.
- Click Run;
- When processing is complete the green progress bar at the bottom of the screen will have moved across;
- If more than one constituent type is listed, then a new constituent must be selected from the drop down list at the top of the screen. A new set of corresponding EMC/DWC values need to be loaded to correspond to the new constituent selected; and
- Select Close when appropriate EMC/DWC values have been assigned for all constituents.
StreamOrder Lengths
The StreamOrderLengths tool gives a summary of the lengths (in meters) of the river reaches and streams for each sub-catchment so that management tasks, such as riparian buffer zones, can be applied to specific stream orders within sub-catchments.
Select . The Stream Order Lengths window appears:
- Drag and drop a stream order raster into the StreamOrderRaster pane;
- Drag and drop the sub-catchment map into the Sub Catchment Raster pane;
- Adjust the sinuosity factor if necessary (default value is 1.25);
- Click Create to create a table summarising the stream orders and lengths per sub-catchment; and
- Click Save to save the table. Source saves this as a tab-delimited file (.txt).
ExtractRaster
The ExtractRaster tool allows a spatial layer to be extracted from a raster. Therefore, if grid code 3 is entered in the val box, then all grid codes referenced as 3 will be extracted from the source raster (src).
allows you to edit data inputs depending on conditions that you wish to specify. Choose Tools » Data Modification Tool to open the tool, as shown in Figure 4 and carry out the following steps to change the data inputs:
- Click Open under Data loader, which displays the file name in the box below, along with the file on the right;
- Under Condition builder, click Add to add a condition. Modifying the input data, conditional operator and condition value can be accessed by hovering and clicking on the relevant area in the condition builder. A drop-down menu appears.
- Click Name to associate a name with the condition;
- Clear can be used to clear the list of conditions if it gets too long and is no longer required.
- Under Rule Executer, you can specify the output for specific aspects of the input. For example, if the condition reaches a certain value, the result will be 0.
- Click Execute, ad the output will be displayed in Result, which can be saved by clicking Save.
Figure 4. Data modification tool
Graph Control
Choose Tools » Graph Control to open a charting tool window, which can be used to drag data and display it. Refer to Using the Charting Tool for details.
Regression tests
Regression tests ensure the following:
- Changes (such as bug fixes) on Source do not introduce additional problems;
- Old projects are compatible with future versions of Source; and
- Correct results are not inadvertently changed due to software changes.
A detailed description on working with regression tests can be found at /wiki/spaces/SD41/pages/25822617.
There are three sub-menus under Tools » Regression tests that allow you to create and run regressions tests locally. The first step is to set up the regression test project and build the test using the Scenario test builder.
1 Scenario Test builder
The Scenario test builder (Figure 5) allows you to create a folder that will contain all the regression test files for a project:
- Prior to running a scenario, ensure that you have recorded the parameters relevant to your test;
- Once you have run a scenario, ensure that all the recorded results show the correct results. Open the Scenario Test Builder (using Tools » Regression Tests » Scenario Test Builder); and
- Click on the ellipsis button and load the folder containing the results of the regression tests. Click Save to save the folder location or Clear to load a different folder. This test folder contains sub-folders for each scenario within your project containing the expected results or baseline files. This folder also contains a Source project file that the regression test loads and runs to compare to the baseline files.
Figure 5. Regression tests, Scenario Test builder
2 Create/Edit Regression Test Description file (.xml)
This allows you to document information about the test files that were saved in the scenario test builder. It tells you what functionality each file is testing and is saved in XML format.
Choose Tools » Regression Tests » Create/Edit Regression Test Description file (/xml) to open the Add Regression Test Project dialog (Figure 6). Once you have entered as much information as you can, click Save.
Figure 6. Regression tests, Add regression test project
3 Test Runner
The test runner allows you to run various tests on scenarios:
- Choose Tools » Regression tests » Test Runner to open the dialog shown in Figure 7;
- Click on the ellipsis button to load a folder containing the errors; and
- Click Run to run the scenario.
Click the Show less Info. button to view fewer details on the errors. The Export All Errors button allows you to save the errors to a file.