|
==Use of Ruby Scripts==
It’s possible to utilise the Ruby Scripting interface within InfoWorks ICM to speed up the export. A ruby script can be run to call the Open Data Export Centre, and export all requested tables, using a specified config file automatically, significantly reducing the number of button clicks. An example Ruby Script is available from [mailto:support@tuflow.com support@tuflow.com]. which exports the tables as shown in Table 1.
'''Ruby Script Conversion'''
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Component
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | InfoWorks Table Name
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | TUFLOW File
! style="background-color:#005581; font-weight:bold; color:white;" width=70% | Notes
|-
|'''1D Nodes''' ||Node||1d_mh_pit||Node is exported. Headloss Approach is assumed to be TUFLOW’s default Engelund approach. Flow width is calculated as diameter based on the chamber area.
|-
|'''1D Pipes''' ||Conduit||1d_nwk_pipe||Conduit is exported. Conduit shape ‘CIRC’ are set as Type ‘C’ and shape ‘RECT’ are set as type ‘R’, otherwise the conduit shape is set to I. Where ‘I’, the shape will need to be separately defined. Conduit Width/Height are converted from ‘mm’ to ‘m’. Manning's n roughness value are copied if roughness type is 'N' or 'MANNINGS'.
|-
|'''1D Subcatchment''' ||Subcatchment||2d_sa_subcatchment||Only the Subcatchment Geometry is exported on the assumption that this would be converted to a 2d_SA polygon.
|-
|rowspan="15" | '''1D Structures''' ||Bridge||1d_nwk_Bridges||Bridge methods are different so the bridge would need to be rebuilt in TUFLOW/Estry. Only the link geometry is exported.
|-
| Channel||1d_nwk_Channels||Link is exported. Shape data needs bringing across into a csv file and linked to the 1d_nwk_channels file.
|-
| Culvert Inlet||1d_nwk_Culvert_Inlet||Link is exported but no direct equivalent in TUFLOW currently.
|-
| Culvert Outlet||1d_nwk_Culvert_Outlet||Link is exported but no direct equivalent in TUFLOW currently.
|-
| Flap Valve||1d_nwk_Flap_Valve|| Link is converted to a circular, uni-directional conduit.
|-
| Flume||1d_nwk_Flume||Link exported but no direct equivalent in TUFLOW currently so set to conduit. If flume type is 'RFLUME' exported to Rectangular conduit otherwise set to 'I'.
|-
| Inline Bank||1d_nwk_Inline_Bank||Link exported as an irregular weir. Section data needs bringing across into a cross-section csv file.
|-
| Irregular Weir||1d_nwk_Irregular_Weir||Link exported as an irregular weir. Section data needs bringing across into a cross-section csv file.
|-
| Orifice||1d_nwk_Orifice||Link exported as a 1m length circular conduit.
|-
| Pump||1d_nwk_Pump||Link exported. Set as a PO type but user should check and add Operational Control as required.
|-
| Screen||1d_nwk_Screen||Link exported but no direct equivalent in TUFLOW currently.
|-
| Siphon||1d_nwk_Siphon||Link exported but no direct equivalent in TUFLOW currently.
|-
| Sluice||1d_nwk_Sluices||Link exported together with fields. Set to SGO type where sluice is variable.
|-
| User Control||1d_nwk_User_Control||Link is exported but no direct equivalent in TUFLOW currently. Note that a User Control uses differential head whereas a TUFLOW Q channel uses upstream depth.
|-
| Weirs||1d_nwk_Weirs||Link exported together with fields. Weir types converted across.
|-
|'''1D River Reach''' ||River Reach||1d_nwk_River_Reaches||River Reach Geometry exported to 1d_nwk file. See below section on river reaches.
|-
|rowspan="6" |'''2D Domain''' ||2D Zone||2D_Code||Polygon geometry exported, Code region set to 1.
|-
| 2D Point Source||2D_bc_P||Point exported and set to QT boundary.
|-
| 2D Boundary||2D_bc_L|| Line exported and Set to QT/HT/HQ type as appropriate, other types are set to 'Other' and need reviewing by the modeller.
|-
| 2D Boundary||2D_bc_L_Line_source||Line exported and set to QT Boundary.
|-
| Roughness Zone||2D_mat||Polygon geometry exported and Material ID set to Manning's n value. Need to generate materials csv file with Material ID equal to the Manning's n value.
|-
| Infiltration Zone (2D)||2D_soils||Polygon geometry exported defines the spatial locations of different soils types. Need to specify a separate tsoilf.
|-
|'''2D Initial Conditions''' ||ICzone-hydraulics(2D)||2D_IWL||Polygon geometry exported which defines the geometry where the initial condition is applied. The initial water level will need to be obtained from the Initial Conditions (2D) object based on a lookup with the polygon ID.
|-
|rowspan="2" |'''2D Results Objects''' ||Network Results Line (2d)||2D_po_L|| Lines exported and set to H_ Q_ type PO Lines
|-
| Network Results Point (2d)||2D_po_P|| Points exported and set to H_ type PO Points
|-
|rowspan="2" |'''2D Topography Modifications''' ||Mesh Level Zone||2D_zsh_R_MLZ||Polygon geometry exported
|-
| Mesh Zone||2D_zsh_R_MZ||Polygon geometry exported and Z value translated as well as shape options.
|-
|rowspan="4" |'''2D Structures'''||Porous Wall||2d_lfcsh_Porous_Wall||Line geometry exported
|-
| Base Linear Structure(2D)||2d_lfcsh_BLS||Line geometry exported
|-
| Sluice Linear Structure(2D)||2d_lfcsh_SLS||Line geometry exported
|-
| Bridge Linear Structure(2D)||2d_lfcsh_BridgeLS||Line geometry exported
|-
|}
Although the geometry is exported in most instances, it is envisaged that there will be some user interaction to map across the relavent fields to the closest TUFLOW equivalent.
To run the script, you’ll again need to run InfoWorks ICM with a viewer licence or greater. With the desired network in the geoplan, go to '''Network->Run Ruby Script'''. Navigate to and select the ruby script, in the below this is ICM_Out_to_shp_1.rb.
'''TUFLOW Network'''<br>
[[File:TUFLOW network.png|400px]]
==Error Messages==
The ruby script will create an log file for each InfoWorks table with any error messages that may arise during the export.
==Exporting a River Reach==
|