Share
 
 

Events - CSV File Formats

Event data can be imported from and exported to InfoWorks CSV file format:

  • The use of field headers allows for flexibility in the ordering of fields and permits fields to be easily omitted if desired.
  • Units specification is optional. If the units are not specified then they are assumed to be the current user display units.
  • Subevent Properties and Profile Properties are specified in "Global" and "Local" rows of the file.
  • An optional date/time column alongside the time varying value columns may be included. InfoWorks ICM derives the timestep from the relative values in the date/time column and inserts subevents at any point where the timestep changes.
  • If the date/time column is not used, a fixed timestep and a start date must be specified. Multiple events can be imported from one CSV file; for each subevent include "Global" and "Local" rows before the sub-event values.

Click on the event type below to display detailed information describing the appropriate format for these files.

Rainfall Events

Below is an example of a Rainfall event that has been exported from InfoWorks ICM to CSV format when a user right-clicks on the event and chooses Exportto CSV from the popup menu:

Example 

!Version=2,type=RED,charset=UTF8
FILECONT, TITLE
0,   1
UserSettings,U_RD,U_EVAP,U_FLOW,U_VALUES,U_DATETIME
UserSettingsValues,mm,mm/day,m3/s,mm/hr,dd-mm-yyyy hh:mm
G_START,G_TS,G_NPROFILES,G_ARD,G_EVAP,G_UCWI,G_API30,G_SMS,G_SMD,G_WI,G_CINI,G_BF0, G_RP, G_DUR, G_RPT
16/01/2009 05:00,120,1,         0,    1,     0.000,         0,         0,     0.000,    2,         0,         0
L_ARF,L_ARD,L_EVAP,L_UCWI,L_API30,L_SMS,L_SMD,L_WI,L_CINI,L_BF0
1.00,0.2,0,     0.000,0,0,     0.000,    0,0,0
L_PTITLE,L_PDESC,L_GAUGE_DATA
1                                       ,                                                                                ,
L_ACF,L_SCF
0.000,     0.000
P_DATETIME,1
16/01/2009 05:00,0.000000
16/01/2009 05:02,0.000000
16/01/2009 05:04,0.000000
16/01/2009 05:06,0.000000
16/01/2009 05:08,0.000000
...

File Header Row

Description

Version

Always set to:

!Version=2,type=RED,charset=UTF8

FILECONT

TITLE

FILECONT is a mandatory field which determines the type of event data contained in the file. For a Rainfall even the value in this field should be 0, 1, 8 or 9.

TITLE contains the name of the event item.

UserSettings

UserSettingsValues

Units and date-time format are specified in these fields. Units supported by InfoWorks ICM may be specified.

Where units are not specified,InfoWorks ICM assumes values in the CSV file are in the current display units.

Field Header

Field value

U_ARD

Antecedent Rainfall Depth units

U_EVAP

Evaporation units

U_FLOW Flow values

U_VALUES

Rainfall depth / intensity units

U_DATETIME

The value of U_DATETIME may be one of three options:

  • dd-mm-yyyy
  • mm-dd-yyyy
  • yyyy-mm-dd

Dates in the CSV file will be interpreted using this date/time format

Sub-Event Properties

The fields describing sub-event (global) properties are as below.

See the Sub-Event Properties Dialog topic for more details on Sub-Event Property fields.

The G_NPROFILES field is mandatory. If this field is incorrect, data will not be imported as expected.

At least one of G_TS (the timestep value) and P_DATETIME (the date-time column) must be provided. If both are present the G_TS value is used in conjunction with the G_START value to determine hydrograph timesteps and start time.

Field Header

Sub-Event Property

G_START

Start date

G_TS

Hydrograph Time Step in the format <n>[<u>], where <n> is an integer greater than zero and <u> is an optional unit specifier (representing seconds, minutes, hours and days respectively), e.g. 10m = 10 minutes.

If <u> is not specified, a unit of seconds is assumed.

G_NPROFILES

Mandatory field

Number of profiles in the sub-event

G_ARD Antecedent rainfall depth
G_EVAP Evaporation
G_UCWI Antecedent wetness of the catchment for use with the Wallingford runoff model.
G_API30 API30 for use with the New PR (New UK) runoff model.
G_SMS The Soil Moisture Store representing the initial wetness of the catchment for use with the Horton runoff model.
G_SMD The soil (initial) moisture deficit is the fraction difference between the soil porosity and actual moisture content, expressed as a percentage. For use with the Green-Ampt runoff model.
G_WI Wetness Index for use with the SCS runoff model.
G_CINI Initial soil moisture content for use with the ReFH runoff model.
G_BF0

Initial baseflow for use with the ReFH runoff model.

G_RP

Return period in years, for use in Risk Analysis Runs.

G_DUR

Storm duration in minutes, for use in Risk Analysis Runs.

G_RPT

Return period type for use in Risk Analysis Runs:

  • AMAX - annual maximum
  • POT - peaks-over-threshold

Profile Properties

The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line).

See the Profile Properties Dialog topic for more information on Profile Property fields.

CSV Header

Profile Property

L_ARF

Calibration / areal reduction

L_ARD

Local antecedent depth

L_EVAP

Local Evaporation

L_UCWI

Local UCWI for use with the Wallingford runoff model.

L_API30

Local API30 for use with the New PR (New UK) runoff model.

L_SMS

Local Soil Moisture Store for use with the Horton runoff model.

L_SMD

Local Soil Moisture Deficit for use with the Green-Ampt runoff model.

L_WI

Local wetness index for use with the SCS runoff model.

L_CINI

Local initial soil moisture content for use with the ReFH runoff model.

L_BF0

Local initial baseflow for use with the ReFH runoff model.

Local Profile Information

The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line).

See the Profile Properties Dialog topic for more information on Profile Property fields.

CSV Header

Profile Property

L_PTITLE

Profile title

L_PDESC

Profile description

L_GAUGE_DATA

Contains boundary data if a rainfall area is applied to the profile.
Local additional data

The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line).

See the Profile Properties Dialog topic for more information on Profile Property fields.

CSV Header

Profile Property

L_ACF

L_SCF

Snow Catch Factor

PDATETIME

Profile index

The P_DATETIME (date-time) column is optional, but if present must be on the left hand side of the event values.

At least one of G_TS (the timestep value) and P_DATETIME must be provided. If G_TS value is not provided the P_DATETIME column will be used to deduce values for the subevent start time and timesteps.

Subevents will be automatically created where changes in timestep intervals occur in the P_DATETIME column.

The numbers following P_DATETIME in the header row number the profiles starting from 0.

Inflow / Level / Regulator / Infiltration Events

For an example of a Level Event CSV format file click below:

Example 

FILECONT, TITLE
3,   1
UserSettings,U_VALUES,U_DATETIME
UserSettingsValues,m AD,dd-mm-yyyy hh:mm
G_START,G_TS,G_NPROFILES,G_DATATYPE
28/09/2009 12:00,60,1,    0
L_NODEID,L_PIPELEVEL,L_PTITLE
123, 10.000,titledescription
P_DATETIME,1
28/09/2009 12:00,1.000000
28/09/2009 12:01,2.000000
28/09/2009 12:02,3.000000
28/09/2009 12:03,4.000000

The table below describes the format of the CSV file including examples of each section of the file.

File Header Row

Description

FILECONT

TITLE

FILECONT is a mandatory field which determines the type of event data contained in the file.

FILECONT value

Event Type

2

Inflow

3

Level

4 Regulator

Blank

Ground Infiltration

TITLE contains the name of the event item.

UserSettings

UserSettingsValues

Units and date-time format are specified in these fields. Units supported by InfoWorks ICM may be specified.

Where units are not specified, InfoWorks ICM assumes values in the CSV file are in the current display units.

Field Header

Field value

U_VALUES

Flow / Height above datum / Regulator variable units

U_DATETIME

The value of U_DATETIME may be one of three options:

  • dd-mm-yyyy
  • mm-dd-yyyy
  • yyyy-mm-dd

Dates in the CSV file will be interpreted using this date/time format

Sub-Event Properties

The fields describing sub-event (global) properties are as below.

See the Sub-Event Properties Dialog topic for more details on Sub-Event Property fields.

The G_NPROFILES field is mandatory. If this field is incorrect, data will not be imported as expected.

At least one of G_TS (the timestep value) and P_DATETIME (the date-time column) must be provided. If both are present the G_TS value is used in conjunction with the G_START value to determine hydrograph timesteps and start time.

All events

Field Header

Sub-Event Property

G_START

Start date

G_TS

Hydrograph Time Step in the format <n>[<u>], where <n> is an integer greater than zero and <u> is an optional unit specifier (representing seconds, minutes, hours and days respectively), e.g. 10m = 10 minutes.

If <u> is not specified, a unit of seconds is assumed.

G_NPROFILES

Mandatory field.

Number of profiles in the sub-event

Inflow / Level / Regulator

Field Header

Sub-Event Property

G_DATATYPE

Data type flag

Ground Infiltration

Field Header

Sub-Event Property

G_UDDISS

Initial soil saturation

G_UDDIGL

Initial groundwater level

G_GLT

Groundwater level type

Profile Properties

The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line).

See the Profile Properties Dialog topic for more information on Profile Property fields.

Level

Field Header

Profile Property

L_NODEID

Node reference

L_PIPELEVEL

Pipe level or datum

L_PTITLE

Descriptive title

Inflow

Field Header

Profile Property

L_NODEID

Node Reference

L_PTITLE

Descriptive Title

Regulator

Field Header

Profile Property

L_OBJECTID

ID of regulator or ID of table in RTC

L_MVARIABLE

Measured variable

L_PTYPE

Direct or Indirect
L_BEHAVIOUR Linear / Extend / Use RTC

L_PTITLE

Descriptive Title

Ground Infiltration

Field Header

Profile Property

L_SCID

Subcatchment reference

L_ISS

Initial Soil Saturation

L_IGL

Initial groundwater level

L_PTITLE

Descriptive title

PDATETIME

Profile index

The P_DATETIME (date-time) column is optional, but if present must be on the left hand side of the event values.

At least one of G_TS (the timestep value) and P_DATETIME must be provided. If G_TS value is not provided the P_DATETIME column will be used to deduce values for the subevent start time and timesteps.

Subevents will be automatically created where changes in timestep intervals occur in the P_DATETIME column.

The numbers following P_DATETIME in the header row number the profiles starting from 0.

Pollutographs

For an example of a Pollutograph CSV format file click below:

Example 

FILECONT, TITLE
BOD,1
UserSettings,U_VALUES,U_DATETIME
UserSettingsValues,mg/l,dd-mm-yyyy hh:mm
G_START,G_TS,G_NPROFILES
00/00/0000 00:00:00,60,1
L_ID,L_SFNAME1,L_POTENCYFACTOR1,L_SFNAME2,L_POTENCYFACTOR2,L_SFNAME3,L_POTENCYFACTOR3,L_SFNAME4,L_POTENCYFACTOR4,L_SFNAME5,L_POTENCYFACTOR5,L_SFNAME6,L_POTENCYFACTOR6,L_SFNAME7,L_POTENCYFACTOR7,L_SFNAME8,L_POTENCYFACTOR8,L_SFNAME9,L_POTENCYFACTOR9
,,0,,0,,0,,0,,0,,0,,0,,0,,0
P_DATETIME,1
00/00/0000 00:00:00,10.00000
00/00/0000 00:01:00,9.000000
00/00/0000 00:02:00,8.000000
00/00/0000 00:03:00,7.000000

The table below describes the format of the CSV file including examples of each section of the file.

File Header Row

Description

FILECONT

TITLE

FILECONT is a mandatory field which determines the type of dterminant data contained in the file.

The value is the abbreviated code displayed on the tabs in the pollutograph, e.g. BOD, COD DO, PH etc.

TITLE contains the name of the event item.

UserSettings

UserSettingsValues

Units and date-time format are specified in these fields. Units supported by InfoWorks ICM may be specified.

Where units are not specified, InfoWorks ICM assumes values in the CSV file are in the current display units.

Field Header

Field value

U_VALUES

Units applicable to determinant type

U_DATETIME

The value of U_DATETIME may be one of three options:

  • dd-mm-yyyy
  • mm-dd-yyyy
  • yyyy-mm-dd

Dates in the CSV file will be interpreted using this date/time format

Sub-Event Properties

The fields describing sub-event (global) properties are as below.

See the Sub-Event Properties Dialog topic for more details on Sub-Event Property fields.

The G_NPROFILES field is mandatory. If this field is incorrect, data will not be imported as expected.

At least one of G_TS (the timestep value) and P_DATETIME (the date-time column) must be provided. If both are present the G_TS value is used in conjunction with the G_START value to determine hydrograph timesteps and start time.

Field Header

Sub-Event Property

G_START

Start date

G_TS

Pollutograph Time Step in the format <n>[<u>], where <n> is an integer greater than zero and <u> is an optional unit specifier (representing seconds, minutes, hours and days respectively), e.g. 10m = 10 minutes.

If <u> is not specified, a unit of seconds is assumed.

G_NPROFILES

Mandatory field.

Number of profiles in the sub-event

Profile Properties

The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line).

See the Profile Properties Dialog topic for more information on Profile Property fields.

Sediment input types

Field Header

Profile Property

L_ID

Object reference

L_POLTYPE

The value of L_POLTYPE may be one of the following options:

  • Suspended - profile corresponds to suspended sediment
  • Bed load - profile corresponds to bed load

If unspecified, a value of Suspended will be assumed.

Dissolved determinant types

Field Header

Profile Property

L_ID

Object reference

L_SFNAME1 to L_SFNAME9

Sediment fraction name

L_POTENCYFACTOR1 to L_POTENCYFACTOR9

Potency factors of sediment fractions

Attached determinant types

Field Header

Profile Property

L_ID

Object reference

L_SFNAME

Sediment fraction name

PDATETIME

Profile index

The P_DATETIME (date-time) column is optional, but if present must be on the left hand side of the event values.

At least one of G_TS (the timestep value) and P_DATETIME must be provided. If G_TS value is not provided the P_DATETIME column will be used to deduce values for the subevent start time and timesteps.

Subevents will be automatically created where changes in timestep intervals occur in the P_DATETIME column.

The numbers following P_DATETIME in the header row number the profiles starting from 0.

Trade / Waste Water Events

For an example of a Waste Water / Trade Flow CSV format file click below:

Example 

TITLE
Example waste profile
Units_Concentration,Units_Average_Flow
mg/l,l/day
PROFILE_NUMBER,PROFILE_DESCRIPTION,FLOW
1,Langley - separate,160
SEDIMENT,AVERAGE_CONCENTRATION
SF1,0
SF2,0
POLLUTANT,DISSOLVED,SF1,SF2
BOD,0,0,0
COD,0,0,0
TKN,0,0,0
NH4,0,0,0
TPH,0,0,0
PL1,0,0,0
PL2,0,0,0
PL3,0,0,0
PL4,0,0,0
CALIBRATION_WEEKDAY
TIME,FLOW,POLLUTANT
00:00,0.8,0
01:00,0.42,0
02:00,0.18,0
...
22:00,1.09,0
23:00,1,0
CALIBRATION_WEEKEND
TIME,FLOW,POLLUTANT
00:00,0.8,0
01:00,0.42,0
02:00,0.18,0
...
22:00,1.09,0
23:00,1,0
CALIBRATION_MONTHLY
MONTH,FLOW,POLLUTANT
JANUARY,1,0
FEBRUARY,1,0
...
NOVEMBER,1,0
DECEMBER,1,0
DESIGN_PROFILES
TIME,FLOW,POLLUTANT
00:00,1,0
01:00,1,0
02:00,1,0
...
22:00,1,0
23:00,1,0
CALIBRATION_MONDAY
TIME,FLOW,POLLUTANT
00:00,0.9,0
01:00,0.5,0
02:00,0.2,0
...
22:00,0.55,0
23:00, 0.5,0

The table below describes the format of the CSV file including examples of each section of the file.

  • Rows must be in the order shown in the example above.
  • Non-mandatory columns may be re-ordered or omitted.
  • To include multiple profiles in one file, repeat rows from the PROFILE_NUMBER section onwards.

File Section

Description

TITLE 

TITLE
Example waste profile

Optional field containing the name of the event item.

Units_Concentration

Units_Average_Flow 

Units_Concentration,Units_Average_Flow
mg/l,l/day

Units supported by InfoWorks ICM may be specified.

Units_Average_Flow is applicable to Waste Water Events only.

Where units are not specified, InfoWorks ICM assumes values in the CSV file are in the current display units.

PROFILE_NUMBER

PROFILE_DESCRIPTION

FLOW 

PROFILE_NUMBER,PROFILE_DESCRIPTION,FLOW
1,Langley - separate,160

The PROFILE_NUMBER field is mandatory and must be in the left most column of the row. Profile numbers must be between 1 and 999 and must be unique to the file.

PROFILE_DESCRIPTION contains a descriptive name for the profile.

FLOW is interpreted as :

  • Per Capita Flow for Waste Water profiles
  • Flow Scaling Factor for Trade Waste profiles

SEDIMENT, AVERAGE_CONCENTRATION 

SEDIMENT,AVERAGE_CONCENTRATION
SF1,0
SF2,0

The SEDIMENT field is mandatory and must be in the left most column of the row.

The AVERAGE_CONCENTRATION column contains the average concentration for the two available sediment fractions.

POLLUTANT, DISSOLVED, SF1, SF2 

POLLUTANT,DISSOLVED,SF1,SF2
BOD,0,0,0
COD,0,0,0
TKN,0,0,0
NH4,0,0,0
TPH,0,0,0
PL1,0,0,0
PL2,0,0,0
PL3,0,0,0
PL4,0,0,0

The POLLUTANT field is mandatory and must be in the left most column of the row.

The DISSOLVED, SF1 and SF2 columns allows you to set base pollutant concentrations for the parameters in the list below

CALIBRATION_WEEKDAY / CALIBRATION_WEEKEND / DESIGN_PROFILES

TIME, FLOW, POLLUTANT 

CALIBRATION_WEEKDAY
TIME,FLOW,POLLUTANT,SF1,SF2,BOD,COD,...
00:00,0.8,0
01:00,0.42,0
02:00,0.18,0
...

Use these sections to set up Weekday, Weekend and Design profiles.

The CALIBRATION_WEEKDAY / CALIBRATION_WEEKEND / DESIGN_PROFILES field is required if the section is included in the file for import.

The TIME column is mandatory if the section is included in the file for import and must be the left most column of the row.

Separate sets of multiplier profiles can be defined for flows and pollutants.

CALIBRATION_MONTHLY

MONTH, FLOW, POLLUTANT 

CALIBRATION_MONTHLY
MONTH,FLOW,POLLUTANT,SF1,SF2,BOD,COD,...
JANUARY,1,0
FEBRUARY,1,0
MARCH,1,0
...

Use this section to set up Monthly profiles.

The CALIBRATION_MONTHLY field is required if this section is included in the file for import and must be the left most column of the row.

The MONTH column is mandatory if this section is included in the file for import.

Separate sets of multiplier profiles can be defined for flows and pollutants.

CALIBRATION_<DAY>

TIME, FLOW POLLUTANT 

CALIBRATION_MONDAY
TIME,FLOW,POLLUTANT,SF1,SF2,BOD,COD,...
00:00,0.9,0
01:00,0.5,0
02:00,0.2,0
...

Use these sections to set up profiles for individual days.

The CALIBRATION_<DAY> field is required if the section is included in the file for import, where <DAY> is Monday, Tuesday, Wednesday etc.

The TIME column is mandatory if the section is included in the file for import and must be the left most column of the row.

Separate sets of multiplier profiles can be defined for flows and pollutants.

Parent topic: Events

Related Information

Was this information helpful?