Note: This is documentation for version 5.16 of Source. For a different version of Source, select the relevant space by using the Spaces menu in the toolbar above

Catchment Map Reporting Region

Owned by Meryl McKerrow
Last updated: 23 Jun 2022 by Samira Azadi (Deactivated)
7 min read

Mapping Analysis Window is one of the Source processing tools that are installed by default, accessible via Tools » Analysis Windows » Map.... Using this tool, the user will be able to record flows and constituents in bulk for a specified set of sub-catchments (known as reporting region) and/or for a specified set of functional units. This tool helps in displaying a map of flows or constituent loads per sub-catchment of the reporting region. Also, acquisition of basic statistics (such as sum, mean, median, etc.) for a defined period will be possible.


Two steps need to be done before displaying the results of flows or constituent loads in a map and obtaining the estimated statistics. Firstly, via Edit » Reporting Regions one (or more) reporting region needs to be created. Each of these reporting regions can be included of one or more sub-catchments.

In the “Mange Reporting Regions” window, right click on the scenario name and click on “Add Reporting Region”. This way one or more reporting regions can be added to the list below the scenario name.


Figure 1. Manage Reporting Regions window

To change the name of a reporting region, right click on the created reporting region and click on “Rename”. For each reporting region, from the list of sub-catchment names, one or more sub-catchments can be selected to be included in that reporting region. The quickest way to include all sub-catchments in a reporting region is to tick on the “Include in Reporting Region” box from the “Mange Reporting Regions” window.

Figure 2. Manage reporting region window- Rename reporting region


The next step is to specify data collector options via Tools» Analysis Windows » Reporting Regions Data Collector….

By turning the “Collect Data” into “on”, a desired reporting region (which was created in the previous step) can be specified from the list.

Figure 3. Reporting region data collector window


It should then be determined whether data collection needs to be done at the most downstream link or at each sub-catchment of the selected reporting region.

By selecting “Collect data at the most downstream link” a desired link from the dropdown menu needs to be specified. It should be noted that the dropdown menu only shows the links belongs to the selected reporting region. If the reporting region is included of multiple sub catchments and has a large number of links, then it is possible to start typing name of the desired link in the box to narrow down the options.

Figure 4. Reporting region data collector window; Selection of collecting data at most downstream link

Then depends on whether flow is the only variable that needs to be displayed for the reporting region in a map, “Collect Flow Only” box can be ticked “on”. The box can be left “off” and in addition to the flow, one constituent can also be selected from the dropdown menu. This way it is possible to display either the flow or the constituent loads at the most downstream link of the reporting region in a map.

Figure 5. Selection of recording flow and/or a constituent

By selecting “Collect data at each sub-catchment” more options will be available. For instance, it is possible to collect the desired data (flow and/or a constituent load) for each functional unit (which was defined formerly in the model) separately and in total. Also, it is possible to collect constituent data from each constituent source (which was defined formerly in the model) separately. It should be noted that at a time one or more than one functional unit and only one constituent source can be selected.

Figure 6. Reporting region data collector window; Selection of collecting data at each sub-catchment


Finally, data collection can be limited to a specified period via “Data Collection Start Date” and “Data Collection End Data”.

Figure 7. Reporting region data collector; Specifying data collection start and end date

After setting up the options relevant to the data collection, the model needs to be run again, to be able to view the collected data via Tools» Analysis Windows » Map …


The following tabs and options are available in the “Map Analysis Window”:


  • Map Tab:

On the left side of the “Map Analysis Window” the user can decide that the collected data displays for which functional unit and based on which statistic.

The desired functional unit can be chosen from the dropdown menu. It also should be noted that this option is not available if earlier at the “Reporting Region Data Collector” window, “Collect data at most downstream link” is selected.

Figure 8. Map analysis window; Selection of functional unit for displaying data

The desired statistic can be chosen from the dropdown menu. It is also possible to change and set a new “High Percentile” and “Low Percentile” based on user’s need.

Figure 9. Map analysis window; Selection of statistic for displaying data; Specifying High and Low Percentile

By checking the “Use Flow” the collected data for flow is displayed and by unchecking the “Use Flow” the collected data for the constituent (which was specified formerly in the “Reporting Region Data Collector” window) is displayed.

By enabling the “Divide by Area” the results are displayed per unit area.

By enabling the “Legend” a legend can be added to the map.

By selecting the save button (at the top right side of Map Window) the displayed map can be saved in a shape file format.

Figure 10. Map analysis window, more settings

  • Statistics Tab:

In the “Statistics Tab”, the values of various statistics for the specified period (at the “Reporting Region Data Collector” window) are presented. Also, these statistics are estimated separately for each sub-catchment belonged to the selected reporting region (in the “Reporting Region Data Collector” window) and for the functional unit selected on the left side of the window. It should be noted that if the data collection is applied at “the most downstream link”, then the separation of the sub catchments and functional units are not available, and the results are presented for that specific link of the reporting region. Just the same as “Map Tab”, the user can change the “High and Low Percentile”. As it is mentioned earlier the “Use Flow” check box can be used for switching the results between flow and the selected constituent load. Enabling the “Divide by Area” leads to the results estimated per unit area. Also “Export” button helps to save the table of statistics in a csv file format.


Figure 11. Map analysis window, Statistics Tab


  • Annual Statistics Tab:

In this tab, the value of different statistics is estimated on an annual basis for each year of specified period (at the “Reporting Region Data Collector” window). Also, there is an option to specify the start of each water year.


Figure 12. Map analysis window, Annual Statistics Tab


  • Time series Tab:

In this tab, the collected data for flows (reported in ML/d) or constituent loads (reported in kg/d) is presented at a daily time step for the specified period (at the “Reporting Region Data Collector” window). If data collection is done at each sub catchments of a reporting region, then the data at “Time Series Tab” is separately reported for each sub-catchment belonged to the selected reporting region (at the “Reporting Region Data Collector” window) and for the functional unit selected on the left side of the window. It should be noted that if the data collection is applied at “the most downstream link”, then the collected data is presented for that specific link of the reporting region.