Rainfall Overlay tutorial: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(235 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Getting Started==
{{tutorial prerequisites
# [//tygronsupport.freshdesk.com/support/tickets/new Contact Tygron Support] to request the Kockengen Tutorial project
| tutorial=This tutorial relies on base knowledge about the editor interface.
# Open the Tygron Engine, logon with user name and password and open the project ''Kockengen Tutorial''
| project=This tutorial relies on a specific Demo project.
# Download and unpack the content of this zip-file on your desktop: [http://support.tygron.com/w/downloads/tutorial/kockengen_data.zip]
| Open the {{software}} (the [[Roadmap#engine.tygron.com_.28Long_Term_Support.29|LTS server]]), logon with your user name and password and open the project ''Tutorial Kockengen''
[[File:kockengen_figure01.PNG|800px]]
| Download and unpack the content of this zip-file on your desktop: [//support.tygron.com/w/downloads/tutorial/kockengen_data.zip kockengen_data.zip]
}}


==Editing terrain: importing surface water==
==Introduction to the Rain Overlay==
First we add water to the terrain model of our project:
In this tutorial we will configure a [[Rainfall_(Overlay)|rainfall overlay]]. After this tutorial, you will be able to configure a [[Rainfall_(Overlay)|rainfall overlay]] by making use of the [[Water_Overlay_Wizard|configuration wizard]] and have learnt what kind of data is used as input for the [[Water_Module_Theory|water module]].
# Go to Terrain in the ribbon and select Import GeoJSON file
# Press Select File and import the file openwater.geojson from the tutorial
# Select Water from the Import as Terrain Type: selection menu


[[File:RFO_Tutorial_ImportTerrainFile.png|600px]]
[[File:Kockengen_figure01.PNG|800px]]


Press Send. You have added the canals of our water system!
==Adding a Rainfall Overlay==
Follow these steps below to add a Rainfall Overlay:
# Hover over the button ''Overlays'', in the ''current situation tab'' and select Add Rainfall. The rainfall overlay is added to the Overlays in the left-side-panel. And in the overlay bar on the right side of the map.
# Select the Rainfall overlay in the left side panel and take a moment to familiarize yourself with the tabs in the right panel: General, Keys, Legend and Attributes
#* General contains the most common information necessary to interpret the rainfall overlay.
#* In [[Key]]s you can relate settings for the Rainfall overlay to attribute information stored in [[Building]]'s and [[Area]]'s.
#* Legend allows you to customize your legend
#* Attributes contains the general settings of the Rainfall overlay.
# Click on the ''Configuration Wizard'' button (see image below).
[[File:Kockengen_figure02.PNG|800px]]
 
With the Rainfall Wizard, you can configure your water system, this includes:
* The setup of the weather boundary condition
* Definition of the water system, including water areas (peilgebieden), sewer districts and hydrological structures
* Setting of hydrological parameters


[[File:RFO_Tutorial_TerrainEdited.png|600px]]
==The Rainfall Wizard==


==Adding a Rainfall Overlay==
[[File:Kockengen_figure03.PNG|500px]]
# Go to Overlays, in the GeoData ribbon and select Add Rainfall. The rainfall indicator appears on the left-side-panel
# Open the Rain Overlay Wizzard by clicking on the Configuration Wizard button in the right-side-panel


The Rainfall Overlay Wizard will appear:
With the Rainfall Overlay Wizard you can configure your water system. In this part of the tutorial we are going to use the following [[GeoJSON|GeoJSON-files]] (which you have downloaded at the start of this tutorial):
* waterlevelareas.geojson
* sewerdistricts.geojson
* weirs.geojson
* overflow.geojson
Some [[Import_Geo_data#Requirements|tips for using vector data files]] for the [[Water_Overlay]]:
* All files need to have a coordinate reference system (CRS) defined, for the {{software}} to place the data on the correct location.
* Hydraulic structures (weirs, culverts, pumps and overflows) should be imported as polygons, but translated in the {{software}} to either work as point- or line based structures. Read [[Hydraulic_structures_(Water_Overlay)#Types|here]] more about this difference.


[[File:Kockengen_figure01.PNG|600px]]
[[File:Kockengen_figure04.PNG|600px]]


===Step 1: defining the weather===
===Step 1: defining the weather===
Press Next to proceed to the Weather panel, here the user can define rainfall and evaporation input. Change all numbers and the according to this picture:
Press Next to proceed to the Weather panel, here the user can define rainfall and evaporation input, simulation time, which area of the project to calculate and the groundwater mode. Select the Option 'Linear' for rainfall over time. Change all numbers according to this picture:
[[File:RFO_Tutorial_Weather.png|600px]]


By this setting you have defined a rainfall event:
[[File:Rainfall_wizard_step1.JPG|500px]]
# Of two peaks in 120 minutes
# With a total rainfall amount of 100mm
# With a dry period after rainfall of 120 minutes, so a total simulation time of 4 hours


Reference evapotranspiration will be assumed on 1.5mm/day
With this settings you have defined a rainfall event:
* Uniform rainfall in 120 minutes
* With a total rainfall amount of 50mm
* With a dry period after rainfall of 120 minutes, so a total simulation time of 4 hours
* The whole project area will be (re)calculated.
* Reference evapotranspiration will be assumed on 1.5mm/day
* For groundwater, we assume that there is only infiltration. Read the information on the [[Ground water (Water_Overlay)|Groundwater mode]] to understand what this means for the calculation.


===Step 2: setup of the water system===
===Step 2: setup of the water system===
Press next to proceed to the introduction screen: Setup Water System. In the following steps we will set up the water system using the prepared GeoJSONS. [[File:Kockengen_figure05B.PNG|thumb|250px|right]]


Press next to proceed to the introduction screen ''Setup Water System''
====Step 2.1: adding water areas====  
 
Press next to the screen for importing water areas. A [[Water_level_area_(Water_Overlay)|water area]] is an area with a spatially uniform water level varying in time. Variation can be caused by rainfall, evaporation on the surface water, inflow from sewer areas and inflow from the surface.
====Step 2.1: adding water level areas====
[[File:Kockengen_figure06.PNG|thumb|250px|right]] [[File:Kockengen_tutorial_waterlevel_areas.JPG|thumb|250px|right]]
Press ''next'' to the screen for importing water areas. A water level area is an area with a spatially uniform water level varying in time. Variation is caused by rainfall + evaporation on the surface water, inflow from sewer areas, inflow from the surface and groundwater inflow.
There are several options to define your water areas:
* Do Nothing: no water levels are used. Water terrains will be dry
* Import Water Areas: allows you to import a set of water areas
* Generate Water Areas: allows you to define 1 water area for your project area with 1 water level
* Select existing water areas based on attribute: allows you to connect already imported water level data by using an existing attribute of this dataset


There are three options:
Select Import Water Areas (start Geo data wizard) and press Import Water Areas. The [[Geo_Data_Wizard|Geo Data Wizard]] will open. We will import waterlevelareas.geojson. Use the following attributes in the GeoJSON file as attributes for the Rainfall Overlay:
* ''Import Water Areas:'' allows you to import a set of water level areas from an external dataset
* WATERLEVEL: the [[Water_level_(Water_Overlay)|initial Water Level]] in the water area (m + datum)
* ''Generate Water Areas:'' allows you to define 1 water level area for your project area
* NAME: the name of the water area
* ''Do Nothing'': the surface water system effectively has infinite storage
[[File:RFO_Tutorial_ImportWaterLevelAreas.png|600px]]


Press ''Import Water Areas''  and press ''Select File''. Browse to the file: waterlevelareas.geojson. Set the following:
Steps in the Geo Data Wizard:
# Set name based on attribute, and select the NAME attribute from the geojson file.  
# Select Import a GeoJSON file and press Next. Press Select File and locate the waterlevelareas.geojson. Press Open and press Next.
# Import the OUTLET attribute and assign it to the OUTLET key. Here a pump capacity (m3/s) is specified. In water areas with the pump capacity defined, water will be extracted with the pump capacity. Extracted water via the pump is assumed to be discharging outside the project domain.
# An overview of your areas is generated; see right-side pictures. Press Next
# Import the WATER_LEVEL attribute and assign it to the WATER_LEVEL key. Here the initial water level in the water area is defined in m + reference (being NAP in the Netherlands)
# In the next step you can filter features based on an existing attribute. We skip this step (because we do not want the filter our dataset) by pressing Next
[[File:RFO_Tutorial_WaterLevelAreas.png|600px]]
# We assign names to the water areas using the NAME attribute from the geojson; see right-side pictures. Press Next
# We select all attributes, importing all attribute data from the geojson, and press Next. Note that only numerical attributes can be imported in to the {{software}}.  
# We assign the WATERLEVEL attribute of the GeoJSON to the WATER_LEVEL key of the overlay; see right-side pictures
# At Finalize we press Finish to upload the areas to the server


Press send: you have now successfully defined your water areas!
After importing your water areas you can review all parameters by opening the selection menu. Take some time to review the attribute values. What is the meaning?


====Step 2.2: initial groundwater level====
====Step 2.2: initial groundwater level====
In step 2.2, you can specify ground water levels. By default, ground water levels are assumed to be the same as the water level in the water level area (see previous section). Alternatively, the user can specify pre-defined initial groundwater levels (GHG,GLG and GVG for the Netherlands) or a GeoTiff with ground water levels in m + reference (NAP in The Netherlands).
In step 2.2, you can specify ground water levels. Since this tutorial is about Rainfall, we choose the default option ('Do Nothing')[[File:Kockengen_tutorial_groundwater.JPG|thumb|250px|right]]; see right-side picture.
 
[[File:RFO_Tutorial_ImportGWL.png|600px]]
 
We will not do that as part of the tutorial and press ''Next''


====Step 2.3: adding sewer areas====
====Step 2.3: adding sewer areas====
Sewer districts are represented by areas which have one storage value (mm), uniform in space. Sewer storage will vary in time by sewer inflow from connected buildings (buildings, roads, etc), pumped outflow to a WWTP and sewer overflow to surface water.
[[Sewer_area_(Water_Overlay)|Sewer districts]] are represented by areas which have one [[Sewer_storage_(Water_Overlay)|storage value [m]]], uniform in space. Sewer storage will vary in time by sewer inflow from [[Sewered_(Water_Overlay)|connected buildings (buildings, roads, etc)]], pumped outflow to a WWTP (in the {{software}} this is to an external area outside of the project) and [[Sewer_overflow_(Water_Overlay)|sewer overflow]] to surface water.
In the wizard there are several options for defining the sewer system:
* Do nothing: no sewer areas are defined, this means that there is no sewerage in the project
* Import sewers: import sewer data
* Generate sewers: let the {{software}} [[How_to_generate_a_sewer|generate sewer areas]], based on adjustable parameters
* Select existing sewers based on attribute: if you already have sewer areas imported, you can connect them by selecting the attributes of the data to the overlay keys


Upload your GeoJson file by selecting ''Import Sewers'' in the Sewers screen.
Press import sewers and import the file sewerareas.geojson via the Geo data wizard. Assign the following attributes:
* NAME: name of the sewer district
* POC: [[Sewer_pump_speed_(Water_Overlay)|pump capacity assigned to the sewer district [m3/s]]]
* STORAGE: [[Sewer_storage_(Water_Overlay)|storage of the sewer district [mm]]] [[File:Kockengen_tutorial_sewer_attributes.JPG|thumb|250px|right]]
Follow the steps in the Geo Wizard according to the steps described in the water areas section:
* At step 5, multiply the attribute value for STORAGE in the GeoJSON (mm) by 0,001 (conversion to m); see right-side pictures.  
* At step 6, assign the the STORAGE attribute to the SEWER_STORAGE key and the POC attribute to the SEWER_PUMP_SPEED key


[[File:RFO_Tutorial_ImportSewerAreas.png|600px]]
Take some time to review the attribute values in the imported area Kockengen. What is the meaning?
For more information on the sewer model, read the [[Sewer_model_(Water_Overlay)|Wiki]] page.


Press Select File, browse to the file: sewerareas.geojson. Set the following:
====Step 2.4: adding inundation areas====
# Set name based on attribute, and select the NAME attribute from the geojson file.
[[Inundation_area_(Water_Overlay)|Inundation areas]] are used to represent inundated or flooded areas in advance of the model's simulation. The following options are available:
# Import the SEWER_PUMP_CAPACITY attribute and assign it to the SEWER_PUMP_SPEED key. Here a pump capacity (m3/s) is specified. In water areas with the pump capacity defined, water will be extracted from the sewer district with the pump-rate. Extracted water via the pump is assumed to be discharging outside the project domain.
* Do Nothing: there is no inundation area
# Import the SEWER_STORAGE attribute and assign it to the SEWER_STORAGE key. This is the sewer storage in meters
* Import Water Areas: allows you to import inundation area(s) from an own dataset
* Generate Water Areas: allows you to define 1 inundation area with one water level for your whole project area
* Select existing water areas based on attribute: allows you to connect already imported inundation data by using the water level attribute of this dataset


[[File:RFO_Tutorial_SewerAreas.png|600px]]
In this Tutorial, choose the default option (''Do Nothing)''.


Press send: you have now successfully defined your sewer districts!
====Step 2.5: adding hydraulic structures====
In the [[Water_Overlay_Wizard|configuration wizard]] it is possible to import the following hydraulic structures:
* [[Weir_(Water_Overlay)|Weirs]]
* [[Culvert_(Water_Overlay)|Culverts]]
* [[Pump_(Water_Overlay)|Pumps]]
* [[Inlet_(Water_Overlay)|Inlets]]
* [[Sewer_overflow_(Water_Overlay)|Sewer overflows]]


====Step 2.4: adding hydraulic structures====
=====2.5.1 Adding weirs=====
Currently one can import the following hydraulic structure:
You can upload weirs.geojson by selecting Import Weirs in the Weirs screen and pressing Import Weirs. We will import weirs.geojson, using the following attributes:[[File:Kockengen_figure10.PNG|thumb|250px|right]]
* Weirs, connecting different water areas. Flow between two water areas is computed with the weir formula, using the water level of the connected water areas(1).
* NAME: the name of the weir  
* Culverts, connecting two water areas. Flow between two water areas is assumed to be equal to a fixed flow capacity(1).
* WEIR_HEIGHT: the [[Weir_height_(Water_Overlay)|crest height [m + datum]]]; to be assigned to the WEIR_HEIGHT key
* Pumps, connecting two water areas. Flow between two water areas is assumed to be equal to the pump capacity(2).
* WEIR_WIDTH: the [[Weir_width_(Water_Overlay)|width of the crest [m]]]; to be assigned to the WEIR_WIDTH key
* WEIR_COEFF: tthe [[Weir_coefficient_(Water_Overlay)|flow coefficient related to the shape of the weir]]; to be assigned to the WEIR_COEFFICIENT key


(1) In cases in the Netherlands: deze kunstwerken zijn typisch peilscheidende duikers en stuwen.
In the Geo Wizard follow the steps:
# Select Import a GeoJSON file and press Next. Press Select File and locate the wiers.geojson. Press Open and press Next.
# An overview of your areas is generated as below. Press Next
# In the next step you can filter features based on attribute filtering. We skip this step by pressing Next
# We assign names to the water areas using the NAME attribute from the GeoJSON and press Next
# We select all attributes, importing all attribute data from the GeoJSON, and press Next
# We assign the WEIR_HEIGHT attribute of the GeoJSON to the WEIR_HEIGHT key of the overlay, the WEIR_WIDTH attribute of the GeoJSON to the WEIR_WIDTH key of the rainfall overlay and the WEIR_COEFF attribute of the GeoJSON to the WEIR_COEFFICIENT attribute of the rainfall overlay. [[File:Rainfall_weirs_keys.JPG|thumb|250px|right]]
# At Finalize we press Finish to upload the areas to the server


(2) In cases in the Netherlands: deze pompen zijn typisch voor onderbemalingen en zoetwatervoorziening in droge tijden.
Take some time to review the attribute values. What is the meaning? <br>
Notice that there is also a weir angle attribute, read the [[Weir_angle_(Water_Overlay)|wiki]] to know what this attribute is used for.
<br>
<br>
[[File:Rainfall_weirs_updated.JPG|500px]]


=====2.4.1 Adding Weirs=====
=====2.5.2 Culverts=====  
You can upload your GeoJson file by selecting Import Weirs in the Weirs screen
Click next to proceed to the step for importing culverts. Notice that there are already culverts imported. On the [[Project_Sources|project sources]] page you can read where this data comes from (last entry in the table). Select some culverts from the drop down menu and click on Show in Editor to see where they are located in the [[project area]]. Since from the open dataset not all attributes are known, for example the [[Culvert_diameter_(Water_Overlay)|culvert diameter]] is by default set to 1m. Notice that there are some errors. These culverts are marked red in the drop down menu and also the step itself is marked red. Read some of the error messages given when selecting a marked red culvert in the drop down menu and proceed with the next step.


[[File:RFO_Tutorial_ImportWeirs.png|600px]]
[[File:Culverts.JPG|500px]]


Press Select File, browse to the file: weir.geojson. Set the following:
=====2.5.3-5 Pumps, Inlets and Drainages=====
# Set name based on attribute, and select the NAME attribute from the geojson file.
Similar to the import procedure of weirs, you can add pumps, inlets and outlets and drainages. In this tutorial, choose the default (''Do Nothing'').
# Press Select Function, go to the ondergrond section and select stuw
# Import the WEIR_COEFFICIENT attribute and assign it to the WEIR_COEFFICIENT key. This is a dimension-less coefficient specifying all losses and fixed terms in the weir formula. 1 is a good default value for simple weirs
# Import the WEIR_HEIGHT attribute and assign it to the WEIR_HEIGHT key. This is the height of the crest of the weir relative to reference level (mNAP in The Netherlands)
# Import the WEIR_N attribute, this is a coefficient depended on the shape of the weir. 1.5 is a proper default value for simple weirs.
# Import the WEIR_WIDTH attribute and assign it to the WEIR_WIDTH key. This is the crest width of the weir in meters.


[[File:RFO_Tutorial_Weirs.png|600px]]
=====2.5.6 Adding Overflows=====
In this step we will add the [[Sewer_overflow_(Water_Overlay)|sewer overflow]]. Upload the overflows.geojson by selecting Import Overflows in the Wizard. We will import overflow.geojson, using the following attributes:
* LEVEL: the [[Sewer_overflow_attribute_(Water_Overlay)|crest level of the overflow]]; assign to the SEWER_OVERFLOW overlay key
* CAPACITY: the [[Sewer_overflow_speed_(Water_Overlay)|overflow capacity of the overflow]]; assign to the SEWER_OVERFLOW_SPEED overlay key
Follow the Geo Data Wizard similar to the procedure at importing weirs (see 2.5.1 adding weirs) and view the result. What do the values mean?


Press send: you have now successfully defined your weir!
[[File:Kockengen_figure13.PNG|500px]]


=====2.4.2 Adding Culverts=====
===Step 3: setup of coefficients===
You can upload your GeoJson file by selecting Import Culverts in the Culverts screen.  
In this step you can adjust default parameters related to the [[Surface_model_(Water_Overlay)|surface]] (e.g. roughness), [[Ground_model_(Water_Overlay)|sub-surface]] (e.g. conductivity) and infrastructure (e.g. is a type connected to a sewer or not). As we work with a [[project]] containing a lot of data, the determination of model-coefficients can be complex. E.g.:
 
* A [[Water_manning_(Water_Overlay)|manning roughness coefficient]] can be related to the surface type (e.g. clay) if no infrastructure present. If infrastructure is present (e.g. a road), the value of the road will be used, and the value of the surface type will be ignored
In this tutorial, we do not have culverts connecting two water areas. Select Do Nothing and press Next to continue
* An [[Terrain_ground_infiltration_md_(Water_Overlay)|infiltration]] parameter can be related to the surface (land cover), [[Ground_infiltration_per_day_(Function_Value)|infrastructure]] or the ground (sub-surface).
 
You can inspect each of the parameters by hovering or clicking on the question mark icon next to the parameter. We will leave everything to default by pressing next (4x)
=====2.4.3 Adding Pumps=====
<br>
You can upload your GeoJson file by selecting ''Import Pumps'' in the Pumps screen.
<br>
 
[[File:Kockengen_figure14.PNG|500px]]
[[File:RFO_Tutorial_ImportPumps.png|600px]]
 
Press Select File, browse to the file: pump.geojson. Set the following:
# Set name based on attribute, and select the NAME attribute from the geojson file.
# Press Select Function, go to the ondergrond section and select gemaal
# Import the PUMP_SPEED attribute and assign it to the PUMP_SPEED key. This is the pump capacity in m3/s by which water is pumped between two adjacent water areas.
 
[[File:RFO_Tutorial_Pumps.png|600px]]
 
Press send: you have now successfully defined your pump!
 
=====2.4.4 Adding Overflows=====
You can upload your GeoJson file by selecting ''Import Sewer Overflows'' in the Overflows screen.
 
[[File:RFO_Tutorial_ImportOverflows.png|600px]]


Press Select File, browse to the file: overflow.geojson. Set the following:
===Step 4: Interactions===
# Set name based on attribute, and select the NAME attribute from the geojson file.
Here you can choose to visualize your water system network in the rainfall overlay:
# Press Select Function, go to the ondergrond section and select riooloverstort
* Display Water System network: shows schematically the network of the water system
# Import the CREST_LEVEL attribute and assign it to the SEWER_OVERFLOW key. This is the crest level in meters relative to vertical datum (NAP in The Netherlands)
* Display Weirs with Panels: shows on the location of weirs a panel, allowing the user to overwrite structure settings
# Import the FLOW_CAPACITY attribute and assign it to the SEWER_OVERFLOW_SPEED key. This is the discharge capacity (m3/s) of the overflow by which the sewer district can spill to the connected surface water area.
* Display Water Areas with Panels: shows on all centroids of water areas panels, allowing the user to overwrite initial water levels


[[File:RFO_Tutorial_Overflows.png|600px]]
[[File:Kockengen_figure15.PNG|500px]]


Press send: you have now successfully defined your sewer overflow!
===Step 5: Output Overlays===
Each water overlay can produce one or more results. By default the [[Water stress_result_type_(Water_Overlay)|water stress]] is chosen, which is the amount of water on the surface. For water terrains a maximum allowed increase model parameter is set. Below that depth no water stress will be perceived. To see only the amount of water on the surface, select the [[Surface_last_value_result_type_(Water_Overlay)|surface last value]] and check the First checkbox, the [[Surface_elevation_result_type_(Water_Overlay)|surface elevation]] and the [[Base_types_result_type_(Water_Overlay)|base types]]. Read the wiki pages to understand what each result type will show. Also, unselect the water stress result type. Notice the number of [[Timeframes_(Water_Overlay)|Timeframes]] can be selected with the slider. The more timeframes, the more intermediate steps there are recorded and viewable for the user. Note that timeframes are not the same as [[Timestep_formula_(Water_Overlay)|timesteps]].
<br>
[[File:Rainfall_results.JPG|500px]]


===Step 3: setup of coefficients===
===Step 6: Input Overlays===
In this step you can adjust default parameters related to the surface (e.g. roughness), sub-surface (e.g. conductivity) and infrastructure (e.g. is a type connected to a sewer or not).
The Rainfall Overlay uses several input parameters to compute output. These input overlays can be visualized in the Input Overlays section. Select the [[Water_manning_(Water_Overlay)|manning roughness value [m/s^1/3]]].


You can inspect the values by going to the pages. We will leave everything to default by pressing next (4x)
[[File:Kockengen_figure17.PNG|500px]]


===Step 4: setup of overlays===
===Step 7: Advanced Settings===
The Rainfall Overlay produces several result types. Examples of these are the impacted building overlay, water stress and the maximum water depth. In step 4, result-types can be organized and parameters required for computing a result-type can be set.
Here you can change some [[Model_attributes_(Water_Overlay)|model attributes]] for the [[Rainfall_(Overlay)|rainfall overlay]].
The attributes you can change in this step are:
* [[Max_water_depth_m_(Water_Overlay)| Max water depth attribute]]
* [[Max_water_bottom_m_(Water_Overlay)| Max water bottom attribute]]
* [[ Object_correction_(Water_Overlay)| Object correction attribute]]
* [[Shoreline_(Water_Overlay)| Shoreline attribute]]
Read the above Wiki pages, but keep the default values.


We leave everything on default and press next
[[File:Advanced_settings_rainfall.JPG|500px]]


===Step 5: visualisation:
Press Finish to finalize the wizard
Here you can set the visualisation of your water system; how it appears on your screen:
* Show system Visualisation in Overlay: shows the network of the water system
* Adjustable Weirs with Popups: shows all hydraulic structures, allowing the user to overwrite structure settings
* Adjustable Water Areas with Popups: shows all centroids of water level areas, allowing the user to overwrite initial water levels and outflow capacity


[[File:RFO_Tutorial_Visualisation.png|600px]]
==After completion of the wizard==
[[File:Kockengen_tutorial_general_tab.JPG|thumb|150px|right|The general tab in the right panel]]
[[File:Kockengen_tutorial_inactive_copyJPG.JPG|thumb|150px|right|The inactive copy of the Rainfall overlay is greyed out]]
After finishing the wizard, you need to [[Grid_Overlay#Grid_recalculation|Update the grid]] to recalculate the rainfall overlay. Every time you change a parameter in the model, whether that is in the wizard or in the editor itself, the overlay has to be recalculated by pressing Update Now. However, if the [[Calculation_panel#Auto-update_indicators|auto update]] is on, the overlay is automatically recalculated when changing a parameter in the wizard. When working in/with a large project, a small grid size, long simulation time etc., it can be desirable to turn the auto update off in order to not have to wait every time on the recalculation of the overlay, until you are done with editing and ready for the results. When dealing with very long calculations, take note of the option to [[Calculation_panel#GPU_overview|cancel]] the calculation (if you notice that it will take a long time) and the option to [[Grid_Overlay#Delayed_calculation|delay]] the calculation.


We will check all options and press finish to complete the wizard!
When the calculation is finished, please explore the following interesting features:
<br>
[[File:Results_kockengen.JPG|500px]]
<br>
* Play the overlay by clicking on the arrows in the bottom left corner of the [[Viewer ]]interface. Can you explain what happens?
* Click in the left panel on the other overlays. Can you explain the results? Notice the [[Base_types_result_type_(Water_Overlay)|base types]] result. This result type shows input used for the model. As you can see the division in land, water and constructions is very rough. This is related to the [[grid cell size]]. In the General Tab you can press ''Change Grid'' to change the [[grid cell size]] to for example 2m. Can you see the difference, and see the impact on the [[Surface_last_value_result_type_(Water_Overlay)|surface last value]], timesteps and calculation time?
* Open the Rainfall Wizard again and click on the culverts step. Notice there are less errors with the culverts by changing the grid cell size. Can you now follow the error messages that were previously given?
* In the General Tab you can show the [[Water balance (Water Overlay)|Water Balance]]. Please explore.
* Below there is a summary, the [[Debug info (Water Overlay)|debug info]], please explore.
* In the General Tab, you can specify the [[Calculation_preference_formula_(Water_Overlay)|Calculation Preferences]].
* In the General Tab you can [[Geo_Data#Export_raster_data|export the result]] as a [[GeoTIFF]]. Please do so and visualize your result in a GIS, for example QGIS.
* In the General Tab, click on ''Save overlay result''. Notice what happens: an inactive copy of the result type is created in the overlay left panel. This inactive copy can be used to store results, from for example a specific rain event, and compare it later with another result type of another rain event.
* In the General Tab, [[Warnings (Water Overlay)|warnings]] may also appear, for example about the accuracy of the model in relation to the grid cell size.
* Create an overlay of the water areas to provide more insight. Follow the (general) steps [[Geo_Data_tutorial#Create_an_overlay|in the Geo Data tutorial]] for creating an overlay of the already imported water areas.
* Open the Rainfall Wizard again. Select more and/or different result types and update the Rainfall overlay. Can you display and interpret the results?


If you finish the wizard, your water system will appear as below. You may need to un-check and check the ''Show System Visualisation'' check-box to make that happen.
===Extra step: measuring tool===
The {{software}} also provides a [[measuring tool]] to create sections.
Try to create a line measurement with the same settings as below in the image. Make sure the result type that you are displaying is the [[Surface_last_value_result_type_(Water_Overlay)|surface last value]]. Can you explain what you see in the graph?
<br>
[[File:Measurement_tutorial.JPG|500px]]
<br>
The created section shows the amount of water on the surface (m + datum) in yellow and the terrain height in red. When you play the overlay, you will see the yellow line moving according to the amount of water that is on the surface during that timeframe. Make some more measurements on different places.  


[[File:RFO_Tutorial_WaterSystemVisualisation.png|600px]]
You have now finished the tutorial!
{{Water Module buttons}}

Latest revision as of 15:07, 26 January 2024

Prerequisites

The following prerequisites should be met before starting this tutorial:

  • This tutorial relies on base knowledge about the editor interface. If you have not yet followed the tutorials related to those subjects please do so first.
  • This tutorial relies on a specific Demo project. 

Preparations

Take the following steps as preparation for following this tutorial:

  • Open the Tygron Platform (the LTS server), logon with your user name and password and open the project Tutorial Kockengen
  • Download and unpack the content of this zip-file on your desktop: kockengen_data.zip

Introduction to the Rain Overlay

In this tutorial we will configure a rainfall overlay. After this tutorial, you will be able to configure a rainfall overlay by making use of the configuration wizard and have learnt what kind of data is used as input for the water module.

Kockengen figure01.PNG

Adding a Rainfall Overlay

Follow these steps below to add a Rainfall Overlay:

  1. Hover over the button Overlays, in the current situation tab and select Add Rainfall. The rainfall overlay is added to the Overlays in the left-side-panel. And in the overlay bar on the right side of the map.
  2. Select the Rainfall overlay in the left side panel and take a moment to familiarize yourself with the tabs in the right panel: General, Keys, Legend and Attributes
    • General contains the most common information necessary to interpret the rainfall overlay.
    • In Keys you can relate settings for the Rainfall overlay to attribute information stored in Building's and Area's.
    • Legend allows you to customize your legend
    • Attributes contains the general settings of the Rainfall overlay.
  3. Click on the Configuration Wizard button (see image below).

Kockengen figure02.PNG

With the Rainfall Wizard, you can configure your water system, this includes:

  • The setup of the weather boundary condition
  • Definition of the water system, including water areas (peilgebieden), sewer districts and hydrological structures
  • Setting of hydrological parameters

The Rainfall Wizard

Kockengen figure03.PNG

With the Rainfall Overlay Wizard you can configure your water system. In this part of the tutorial we are going to use the following GeoJSON-files (which you have downloaded at the start of this tutorial):

  • waterlevelareas.geojson
  • sewerdistricts.geojson
  • weirs.geojson
  • overflow.geojson

Some tips for using vector data files for the Water_Overlay:

  • All files need to have a coordinate reference system (CRS) defined, for the Tygron Platform to place the data on the correct location.
  • Hydraulic structures (weirs, culverts, pumps and overflows) should be imported as polygons, but translated in the Tygron Platform to either work as point- or line based structures. Read here more about this difference.

Kockengen figure04.PNG

Step 1: defining the weather

Press Next to proceed to the Weather panel, here the user can define rainfall and evaporation input, simulation time, which area of the project to calculate and the groundwater mode. Select the Option 'Linear' for rainfall over time. Change all numbers according to this picture:

Rainfall wizard step1.JPG

With this settings you have defined a rainfall event:

  • Uniform rainfall in 120 minutes
  • With a total rainfall amount of 50mm
  • With a dry period after rainfall of 120 minutes, so a total simulation time of 4 hours
  • The whole project area will be (re)calculated.
  • Reference evapotranspiration will be assumed on 1.5mm/day
  • For groundwater, we assume that there is only infiltration. Read the information on the Groundwater mode to understand what this means for the calculation.

Step 2: setup of the water system

Press next to proceed to the introduction screen: Setup Water System. In the following steps we will set up the water system using the prepared GeoJSONS.

Kockengen figure05B.PNG

Step 2.1: adding water areas

Press next to the screen for importing water areas. A water area is an area with a spatially uniform water level varying in time. Variation can be caused by rainfall, evaporation on the surface water, inflow from sewer areas and inflow from the surface.

Kockengen figure06.PNG
Kockengen tutorial waterlevel areas.JPG

There are several options to define your water areas:

  • Do Nothing: no water levels are used. Water terrains will be dry
  • Import Water Areas: allows you to import a set of water areas
  • Generate Water Areas: allows you to define 1 water area for your project area with 1 water level
  • Select existing water areas based on attribute: allows you to connect already imported water level data by using an existing attribute of this dataset

Select Import Water Areas (start Geo data wizard) and press Import Water Areas. The Geo Data Wizard will open. We will import waterlevelareas.geojson. Use the following attributes in the GeoJSON file as attributes for the Rainfall Overlay:

  • WATERLEVEL: the initial Water Level in the water area (m + datum)
  • NAME: the name of the water area

Steps in the Geo Data Wizard:

  1. Select Import a GeoJSON file and press Next. Press Select File and locate the waterlevelareas.geojson. Press Open and press Next.
  2. An overview of your areas is generated; see right-side pictures. Press Next
  3. In the next step you can filter features based on an existing attribute. We skip this step (because we do not want the filter our dataset) by pressing Next
  4. We assign names to the water areas using the NAME attribute from the geojson; see right-side pictures. Press Next
  5. We select all attributes, importing all attribute data from the geojson, and press Next. Note that only numerical attributes can be imported in to the Tygron Platform.
  6. We assign the WATERLEVEL attribute of the GeoJSON to the WATER_LEVEL key of the overlay; see right-side pictures
  7. At Finalize we press Finish to upload the areas to the server

After importing your water areas you can review all parameters by opening the selection menu. Take some time to review the attribute values. What is the meaning?

Step 2.2: initial groundwater level

In step 2.2, you can specify ground water levels. Since this tutorial is about Rainfall, we choose the default option ('Do Nothing')

Kockengen tutorial groundwater.JPG

; see right-side picture.

Step 2.3: adding sewer areas

Sewer districts are represented by areas which have one storage value [m], uniform in space. Sewer storage will vary in time by sewer inflow from connected buildings (buildings, roads, etc), pumped outflow to a WWTP (in the Tygron Platform this is to an external area outside of the project) and sewer overflow to surface water. In the wizard there are several options for defining the sewer system:

  • Do nothing: no sewer areas are defined, this means that there is no sewerage in the project
  • Import sewers: import sewer data
  • Generate sewers: let the Tygron Platform generate sewer areas, based on adjustable parameters
  • Select existing sewers based on attribute: if you already have sewer areas imported, you can connect them by selecting the attributes of the data to the overlay keys

Press import sewers and import the file sewerareas.geojson via the Geo data wizard. Assign the following attributes:

Follow the steps in the Geo Wizard according to the steps described in the water areas section:

  • At step 5, multiply the attribute value for STORAGE in the GeoJSON (mm) by 0,001 (conversion to m); see right-side pictures.
  • At step 6, assign the the STORAGE attribute to the SEWER_STORAGE key and the POC attribute to the SEWER_PUMP_SPEED key

Take some time to review the attribute values in the imported area Kockengen. What is the meaning? For more information on the sewer model, read the Wiki page.

Step 2.4: adding inundation areas

Inundation areas are used to represent inundated or flooded areas in advance of the model's simulation. The following options are available:

  • Do Nothing: there is no inundation area
  • Import Water Areas: allows you to import inundation area(s) from an own dataset
  • Generate Water Areas: allows you to define 1 inundation area with one water level for your whole project area
  • Select existing water areas based on attribute: allows you to connect already imported inundation data by using the water level attribute of this dataset

In this Tutorial, choose the default option (Do Nothing).

Step 2.5: adding hydraulic structures

In the configuration wizard it is possible to import the following hydraulic structures:

2.5.1 Adding weirs

You can upload weirs.geojson by selecting Import Weirs in the Weirs screen and pressing Import Weirs. We will import weirs.geojson, using the following attributes:

Kockengen figure10.PNG

In the Geo Wizard follow the steps:

  1. Select Import a GeoJSON file and press Next. Press Select File and locate the wiers.geojson. Press Open and press Next.
  2. An overview of your areas is generated as below. Press Next
  3. In the next step you can filter features based on attribute filtering. We skip this step by pressing Next
  4. We assign names to the water areas using the NAME attribute from the GeoJSON and press Next
  5. We select all attributes, importing all attribute data from the GeoJSON, and press Next
  6. We assign the WEIR_HEIGHT attribute of the GeoJSON to the WEIR_HEIGHT key of the overlay, the WEIR_WIDTH attribute of the GeoJSON to the WEIR_WIDTH key of the rainfall overlay and the WEIR_COEFF attribute of the GeoJSON to the WEIR_COEFFICIENT attribute of the rainfall overlay.
    Rainfall weirs keys.JPG
  7. At Finalize we press Finish to upload the areas to the server

Take some time to review the attribute values. What is the meaning?
Notice that there is also a weir angle attribute, read the wiki to know what this attribute is used for.

Rainfall weirs updated.JPG

2.5.2 Culverts

Click next to proceed to the step for importing culverts. Notice that there are already culverts imported. On the project sources page you can read where this data comes from (last entry in the table). Select some culverts from the drop down menu and click on Show in Editor to see where they are located in the project area. Since from the open dataset not all attributes are known, for example the culvert diameter is by default set to 1m. Notice that there are some errors. These culverts are marked red in the drop down menu and also the step itself is marked red. Read some of the error messages given when selecting a marked red culvert in the drop down menu and proceed with the next step.

Culverts.JPG

2.5.3-5 Pumps, Inlets and Drainages

Similar to the import procedure of weirs, you can add pumps, inlets and outlets and drainages. In this tutorial, choose the default (Do Nothing).

2.5.6 Adding Overflows

In this step we will add the sewer overflow. Upload the overflows.geojson by selecting Import Overflows in the Wizard. We will import overflow.geojson, using the following attributes:

Follow the Geo Data Wizard similar to the procedure at importing weirs (see 2.5.1 adding weirs) and view the result. What do the values mean?

Kockengen figure13.PNG

Step 3: setup of coefficients

In this step you can adjust default parameters related to the surface (e.g. roughness), sub-surface (e.g. conductivity) and infrastructure (e.g. is a type connected to a sewer or not). As we work with a project containing a lot of data, the determination of model-coefficients can be complex. E.g.:

  • A manning roughness coefficient can be related to the surface type (e.g. clay) if no infrastructure present. If infrastructure is present (e.g. a road), the value of the road will be used, and the value of the surface type will be ignored
  • An infiltration parameter can be related to the surface (land cover), infrastructure or the ground (sub-surface).

You can inspect each of the parameters by hovering or clicking on the question mark icon next to the parameter. We will leave everything to default by pressing next (4x)

Kockengen figure14.PNG

Step 4: Interactions

Here you can choose to visualize your water system network in the rainfall overlay:

  • Display Water System network: shows schematically the network of the water system
  • Display Weirs with Panels: shows on the location of weirs a panel, allowing the user to overwrite structure settings
  • Display Water Areas with Panels: shows on all centroids of water areas panels, allowing the user to overwrite initial water levels

Kockengen figure15.PNG

Step 5: Output Overlays

Each water overlay can produce one or more results. By default the water stress is chosen, which is the amount of water on the surface. For water terrains a maximum allowed increase model parameter is set. Below that depth no water stress will be perceived. To see only the amount of water on the surface, select the surface last value and check the First checkbox, the surface elevation and the base types. Read the wiki pages to understand what each result type will show. Also, unselect the water stress result type. Notice the number of Timeframes can be selected with the slider. The more timeframes, the more intermediate steps there are recorded and viewable for the user. Note that timeframes are not the same as timesteps.
Rainfall results.JPG

Step 6: Input Overlays

The Rainfall Overlay uses several input parameters to compute output. These input overlays can be visualized in the Input Overlays section. Select the manning roughness value [m/s^1/3].

Kockengen figure17.PNG

Step 7: Advanced Settings

Here you can change some model attributes for the rainfall overlay. The attributes you can change in this step are:

Read the above Wiki pages, but keep the default values.

Advanced settings rainfall.JPG

Press Finish to finalize the wizard

After completion of the wizard

The general tab in the right panel
The inactive copy of the Rainfall overlay is greyed out

After finishing the wizard, you need to Update the grid to recalculate the rainfall overlay. Every time you change a parameter in the model, whether that is in the wizard or in the editor itself, the overlay has to be recalculated by pressing Update Now. However, if the auto update is on, the overlay is automatically recalculated when changing a parameter in the wizard. When working in/with a large project, a small grid size, long simulation time etc., it can be desirable to turn the auto update off in order to not have to wait every time on the recalculation of the overlay, until you are done with editing and ready for the results. When dealing with very long calculations, take note of the option to cancel the calculation (if you notice that it will take a long time) and the option to delay the calculation.

When the calculation is finished, please explore the following interesting features:
Results kockengen.JPG

  • Play the overlay by clicking on the arrows in the bottom left corner of the Viewer interface. Can you explain what happens?
  • Click in the left panel on the other overlays. Can you explain the results? Notice the base types result. This result type shows input used for the model. As you can see the division in land, water and constructions is very rough. This is related to the grid cell size. In the General Tab you can press Change Grid to change the grid cell size to for example 2m. Can you see the difference, and see the impact on the surface last value, timesteps and calculation time?
  • Open the Rainfall Wizard again and click on the culverts step. Notice there are less errors with the culverts by changing the grid cell size. Can you now follow the error messages that were previously given?
  • In the General Tab you can show the Water Balance. Please explore.
  • Below there is a summary, the debug info, please explore.
  • In the General Tab, you can specify the Calculation Preferences.
  • In the General Tab you can export the result as a GeoTIFF. Please do so and visualize your result in a GIS, for example QGIS.
  • In the General Tab, click on Save overlay result. Notice what happens: an inactive copy of the result type is created in the overlay left panel. This inactive copy can be used to store results, from for example a specific rain event, and compare it later with another result type of another rain event.
  • In the General Tab, warnings may also appear, for example about the accuracy of the model in relation to the grid cell size.
  • Create an overlay of the water areas to provide more insight. Follow the (general) steps in the Geo Data tutorial for creating an overlay of the already imported water areas.
  • Open the Rainfall Wizard again. Select more and/or different result types and update the Rainfall overlay. Can you display and interpret the results?

Extra step: measuring tool

The Tygron Platform also provides a measuring tool to create sections. Try to create a line measurement with the same settings as below in the image. Make sure the result type that you are displaying is the surface last value. Can you explain what you see in the graph?
Measurement tutorial.JPG
The created section shows the amount of water on the surface (m + datum) in yellow and the terrain height in red. When you play the overlay, you will see the yellow line moving according to the amount of water that is on the surface during that timeframe. Make some more measurements on different places.

You have now finished the tutorial!