InfoWorks ICM to TUFLOW - Revision history

Anne.Kolega: /* InfoWorks ICM Network Conversion */

2026-04-01T22:15:09Z

InfoWorks ICM Network Conversion

← Older revision		Revision as of 08:15, 2 April 2026
Line 12:		Line 12:
	[[File:ODEC.png\|400px]]		[[File:ODEC.png\|400px]]

	The data in InfoWorks ICM is stored in a number of database tables for each network type (~~eg,~~ a separate table for nodes, conduits, 2D zones etc…).		The data in InfoWorks ICM is stored in a number of database tables for each network type (e.g. a separate table for nodes, conduits, 2D zones etc…).

	==Quick Export of Geometry Data==		==Quick Export of Geometry Data==

Tuflowduncan: /* Quick Export of Geometry Data */

2026-01-06T12:53:09Z

Quick Export of Geometry Data

← Older revision		Revision as of 22:53, 6 January 2026
Line 16:		Line 16:
	==Quick Export of Geometry Data==		==Quick Export of Geometry Data==

	To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', select the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters. Once the data is exported, it's possible to ~~sue~~ the QGIS TUFLOW Plugin 'Insert TUFLOW Attributes to Existing GIS Layer' and then map across the field values from InfoWorks to TUFLOW with conversion as required.		To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', select the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters. Once the data is exported, it's possible to use the QGIS TUFLOW Plugin 'Insert TUFLOW Attributes to Existing GIS Layer' and then map across the field values from InfoWorks to TUFLOW with conversion as required.

	A Ruby script is also available which will export export all data via the Open Data Export Centre without the need for the user to export each table individually. The data can use a config file to undertake some of the mapping of field values and some conversion.		A Ruby script is also available which will export export all data via the Open Data Export Centre without the need for the user to export each table individually. The data can use a config file to undertake some of the mapping of field values and some conversion.

Tuflowduncan: /* InfoWorks ICM Network Conversion */

2024-04-11T15:07:24Z

InfoWorks ICM Network Conversion

← Older revision		Revision as of 01:07, 12 April 2024
Line 8:		Line 8:
	The InfoWorks data formats are native and therefore do require access to InfoWorks in order to convert the data. Note, that the following steps can be undertaken with a InfoWorks ICM Viewer licence and a full licence is not currently required.		The InfoWorks data formats are native and therefore do require access to InfoWorks in order to convert the data. Note, that the following steps can be undertaken with a InfoWorks ICM Viewer licence and a full licence is not currently required.
	Although the InfoWorks ICM data formats are proprietry, it is relatively easy to use the Open Data Export Centre within InfoWorks ICM to export the model geometry data to open GIS layer formats (both shapefile and MIF/MID format). The following steps will outline exporting to shapefiles but similar can be undertaken for MIF/MID.		Although the InfoWorks ICM data formats are proprietry, it is relatively easy to use the Open Data Export Centre within InfoWorks ICM to export the model geometry data to open GIS layer formats (both shapefile and MIF/MID format). The following steps will outline exporting to shapefiles but similar can be undertaken for MIF/MID.
	To open the Open Data Export Centre in InfoWorks ICM, open your network in the geoplan, select the relevant scenario, and go to '''Network->Export->Using Open ~~Date~~ Export Centre'''. You’ll be presented with the following dialog which allows you to export the InfoWorks network data to a variety of formats.		To open the Open Data Export Centre in InfoWorks ICM, open your network in the geoplan, select the relevant scenario, and go to '''Network->Export->Using Open Data Export Centre'''. You’ll be presented with the following dialog which allows you to export the InfoWorks network data to a variety of formats.

	[[File:ODEC.png\|400px]]		[[File:ODEC.png\|400px]]

Chris Huxley: /* Use of Ruby Scripts */

2023-03-22T01:44:43Z

Use of Ruby Scripts

← Older revision		Revision as of 11:44, 22 March 2023
Line 22:		Line 22:
	==Use of Ruby Scripts==		==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 all tables and data in an InfoWorks format.		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 <u>[https://gitlab.com/tuflow-user-group/tuflow/model-conversions/infoworks-icm TUFLOW Gitlab User Group]</u> which exports all tables and data in an InfoWorks format.

	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.		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.

Tuflowduncan: /* InfoWorks ICM Network Conversion */

2023-02-15T15:42:56Z

InfoWorks ICM Network Conversion

← Older revision		Revision as of 01:42, 16 February 2023
Line 7:		Line 7:

	The InfoWorks data formats are native and therefore do require access to InfoWorks in order to convert the data. Note, that the following steps can be undertaken with a InfoWorks ICM Viewer licence and a full licence is not currently required.		The InfoWorks data formats are native and therefore do require access to InfoWorks in order to convert the data. Note, that the following steps can be undertaken with a InfoWorks ICM Viewer licence and a full licence is not currently required.
	Although the InfoWorks ICM data formats are proprietry, it is relatively easy to use the Open Data Export Centre within InfoWorks ICM to export the model geometry data to open GIS layer formats (both shapefile and MIF/~~Mid~~ format). The following steps will outline exporting to shapefiles but similar can be undertaken for MIF/MID.		Although the InfoWorks ICM data formats are proprietry, it is relatively easy to use the Open Data Export Centre within InfoWorks ICM to export the model geometry data to open GIS layer formats (both shapefile and MIF/MID format). The following steps will outline exporting to shapefiles but similar can be undertaken for MIF/MID.
	To open the Open Data Export Centre in InfoWorks ICM, open your network in the geoplan, select the relevant scenario, and go to '''Network->Export->Using Open Date Export Centre'''. You’ll be presented with the following dialog which allows you to export the InfoWorks network data to a variety of formats.		To open the Open Data Export Centre in InfoWorks ICM, open your network in the geoplan, select the relevant scenario, and go to '''Network->Export->Using Open Date Export Centre'''. You’ll be presented with the following dialog which allows you to export the InfoWorks network data to a variety of formats.

Chris Huxley: /* Other Considerations */

2023-01-23T01:17:30Z

Other Considerations

← Older revision		Revision as of 11:17, 23 January 2023
Line 76:		Line 76:

	*Shapefile limitations mean that field names and values can only be 11 characters long. This can mean that some node ids and other information is truncated. This is reported in the error reporting.		*Shapefile limitations mean that field names and values can only be 11 characters long. This can mean that some node ids and other information is truncated. This is reported in the error reporting.
			<br>
			{{Tips Navigation
			\|uplink=[[Main_Page\| Back to Main Page]]
			}}

Tuflowduncan: /* Use of Ruby Scripts */

2021-12-07T16:17:33Z

Use of Ruby Scripts

← Older revision		Revision as of 02:17, 8 December 2021
Line 25:		Line 25:

	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.		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.

			[[File:Ruby.png\|400px]]

			The script will then begin running and prompt the user to select a config file. Navigate and select the relevant config file.

			[[File:Config.png\|400px]]

			The user will then be prompted where they would like to export the data too. Select an appropriate file directory. The ruby script will then cycle through the list of tables within the script and export the tables automatically. Once complete the script will return a log highlighting the location of the exported files. All network objects are exported regardless of system type. System type is exported as an additional field in the shape files to enable filtering within GIS as required.

			[[File:Ruby log message.png\|400px]]

			The exported shape files can then be opened in GIS for further inspection and once checked can be linked together using the various TUFLOW control files. A set of generic control files for this are in progress.

			'''InfoWorks ICM Network'''<br>
			[[File:ICM network.png\|400px]]

			'''TUFLOW Network'''<br>
			[[File:TUFLOW network.png\|400px]]

	=Exporting Real Time Control=		=Exporting Real Time Control=

Tuflowduncan: /* Quick Export of Geometry Data */

2021-12-07T16:17:09Z

Quick Export of Geometry Data

← Older revision		Revision as of 02:17, 8 December 2021
Line 17:		Line 17:

	To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', select the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters. Once the data is exported, it's possible to sue the QGIS TUFLOW Plugin 'Insert TUFLOW Attributes to Existing GIS Layer' and then map across the field values from InfoWorks to TUFLOW with conversion as required.		To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', select the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters. Once the data is exported, it's possible to sue the QGIS TUFLOW Plugin 'Insert TUFLOW Attributes to Existing GIS Layer' and then map across the field values from InfoWorks to TUFLOW with conversion as required.

			A Ruby script is also available which will export export all data via the Open Data Export Centre without the need for the user to export each table individually. The data can use a config file to undertake some of the mapping of field values and some conversion.

			==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 all tables and data in an InfoWorks format.

			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.

	=Exporting Real Time Control=		=Exporting Real Time Control=

Tuflowduncan: /* InfoWorks ICM Network Conversion */

2021-12-07T16:14:33Z

InfoWorks ICM Network Conversion

← Older revision		Revision as of 02:14, 8 December 2021
Line 16:		Line 16:
	==Quick Export of Geometry Data==		==Quick Export of Geometry Data==

	To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', ~~slect~~ the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters.		To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', select the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters. Once the data is exported, it's possible to sue the QGIS TUFLOW Plugin 'Insert TUFLOW Attributes to Existing GIS Layer' and then map across the field values from InfoWorks to TUFLOW with conversion as required.

	=Exporting Real Time Control=		=Exporting Real Time Control=

Tuflowduncan at 16:12, 7 December 2021

2021-12-07T16:12:57Z

← Older revision		Revision as of 02:12, 8 December 2021
Line 17:		Line 17:

	To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', slect the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters.		To get a full export of all the model files, with InfoWorks file formats, open the network and go to '''Network->Export->to Shape Files''', slect the save location and the InfoWorks tables that you're interested in. Once exported the shape files can be opened in GIS to view the network table geometry and parameters.

	==Export to TUFLOW Formats==

	Within the Open Data Export Centre, it is possible to provide the Export Field Names and to map to them from the internal fields within the InfoWorks tables. This allows you to export directly to a shapefile with a TUFLOW format. For example, in the below image, the Export fields are set up to replicate the TUFLOW 1d_nwk file format. The relevant InfoWorks fields are then mapped to these to convert the InfoWorks format to a TUFLOW shapefile format.

	[[File:ODEC Conduit TUFLOW.png\|400px]]

	Once the mappings have been set up, they can be saved as a Config file by using the ‘Save Config…’ option. Once a copy has been saved, the config file can be re-used to apply the same field mappings to subsequent exports. It should be noted that not all TUFLOW fields have an equivalent InfoWorks field and vice versa, therefore in some situations there will be some modeller input required to ensure the data is imported in the correct manner. Note in the 'Field type' column there are a number of different options specified. These are:-

	*'''Constant'''-Allows the user to specify a constant value, for example, specify a constant value of '1' for the 'Code' field when exporting 2D Zones. It is also used when exporting a null value.
	* '''Field'''-This is used to directly map an InfoWorks ICM field to a TUFLOW/Estry field. For example, copying the 'conduit_length' field to the 'Len_or_ANA' field for conduits.
	*'''SQL'''-This allows a simple structured query language (SQL) script to export a combination of fields. For example, the ID is set to US_node_ID + link_suffix.
	* '''Script'''-This allows the user to utilise a ruby script to filter out exported items or to convert fields. For example, for conduits, conduits with an InfoWorks shape type of 'CIRC' can be exported to TUFLOW link types 'C', shape types 'RECT' to 'R' and all others to 'I'.

	It is also possible to export all InfoWorks fields at the end of the shape file and then use GIS to post-process this for conversions and other simple translations. An example configuration file which contains mappings for nodes, pipes, 2D components and 1D structures can be obtained from [mailto:support@tuflow.com support@tuflow.com]. The config file provides a good starting point for the conversion and further mapping of fields between InfoWorks and TUFLOW. Note, that currently the config file is set up to export geometry tables only and will not export tables containing cross-sections, head-discharge curves and similar. TUFLOW are not responsible for the accuracy of the config file and subsequent translation of data.

	This approach can be used to export on a table by table approach although it is possible to save to the same config file. This allows one config file to set up all the mappings for each of the table exports. The downside of this approach is the time-consuming nature of exporting each table individually.

	==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].

	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.

	[[File:Ruby.png\|400px]]

	The script will then begin running and prompt the user to select a config file. Navigate and select the relevant config file.

	[[File:Config.png\|400px]]

	The user will then be prompted where they would like to export the data too. Select an appropriate file directory. The ruby script will then cycle through the list of tables within the script and export the tables automatically. Once complete the script will return a log highlighting the location of the exported files. All network objects are exported regardless of system type. System type is exported as an additional field in the shape files to enable filtering within GIS as required.

	[[File:Ruby log message.png\|400px]]

	The exported shape files can then be opened in GIS for further inspection and once checked can be linked together using the various TUFLOW control files. A set of generic control files for this are in progress.

	'''InfoWorks ICM Network'''<br>
	[[File:ICM network.png\|400px]]

	'''TUFLOW Network'''<br>
	[[File:TUFLOW network.png\|400px]]

	==Exporting a River Reach==

	'''In progress'''.

	The steps above will export the river reach links into a 1d_nwk_L shape file format. They won't contain the river section lines or the banklines. Due to the way that these data are stored in InfoWorks, it is easier to export the data from InfoWorks using '''Network->Export->...to Shp''' tool rather than the ODEC approach. Select the directory you would like to save to, select tables and select river reach and then choose to export selected tables only.

	[[File:Export to shape.PNG]]

	This will export the River Reach Section Lines, River Reach Sections (as a series of points for each section vertex), the River Reach Bank Lines (for Left and Right Banks), the River Reach Bank Vertices (Left/Right) and the river reach boundary in a shape file format. You can then open these within QGIS and use the TUFLOW Viewer plugin tool to Insert TUFLOW attributes to existing GIS layer.

	*Firstly, use the Insert TUFLOW attributes into existing GIS Layer to apply the 1d_xs_l layer into the River Reach Section Lines.

	[[File:Insert TUFLOW Attributes.PNG]]

	Toggle editing and set the 'Source' field equal to the 'key' column plus '.csv'. Set the 'Type' column to 'XZ' and the 'Flags' column to 'N' for all values. Toggle off editing and save the changes. The resulting shapefile table should look as follows.

	[[File:River Section lines.PNG]]

	*Use the Insert TUFLOW attributes tool to apply the 2d_bc_L layer attributes into the River Reach Bank Lines. This could be done for both the Left and Right banks although you may wish to combine into one layer. For both Left and Right layers, set the Type to 'HX' and save the new layer. These will act as the 1D-2D link locations.

	[[File:Bank lines.PNG]]

	*Use the Insert TUFLOW attributes tool to apply the 2d_bc_P layer attributes into the River Reach Bank (these are stored as points). Do this for both the Left and Right banks although you may wish to combine into one layer. For both Left and Right layers, set the Type to 'ZP' and set the 'f' field equal to the 'Z' field and save the new layer. This will act as a breakline and define the bank elevations.

	[[File:Bank points.PNG]]

	*Use the Insert TUFLOW attributes tool to apply the 2d_code layer attributes into the River Reach Boundary file. Set the code attribute to 0 to act as a de-activated area within the 2D domain. Save the changes.

	[[File:Reach Boundary.PNG]]

	For the river section vertices, select the River Reach River Sections layer which is a series of river section vertices, open the attribute data and copy all point attributes into an excel spreadsheet. At this stage there'll be a need of cleaning the data and converting the X,Y values to Chainage and exporting into individual csv files for each cross-section. This could be automated with a script. An example python script is available.

	'''In progress'''.

	=Exporting Real Time Control=		=Exporting Real Time Control=