In order to configure an isis model in fews you must configure the adaptor with an .ini file. This file is generated in by ISIS (file > export to EA FFS).
Introduction
The ISIS adapter for FEWS will be driven by an INI file created by ISIS. The purpose of the file is to identify the locations and unit types of the inputs, outputs and controls of the ISIS model in a form that the adapter can read without knowledge of the ISIS DAT file format.
The file format was originally developed with the following in mind:
- To minimise coding and maximise the sharing of code between the adapter and FloodWorks, the parameters are the same as those in the equivalent FloodWorks parameter file.
- The generic approach means there are several elements that will always take the same value in the ISIS adapter but which would have different values in, say, a PDM adapter.
1 Sections
The INI file is in 14 sections as follows:
- General
- InputDimensions
- Inputs
- ControlDimensions
- Controls
- OutputDimensions
- Outputs
- StatesDimensions
- RealParameterDimensions
- RealParameters
- IntegerParameterDimensions
- IntegerParameters
- CharacterParameterDimensions
- CharacterParameters
The sections can be in any order.
2 Parameters
The full parameter list is below, followed by endnotes explaining some of the particular ISIS values. The following definitions will be useful:
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="db71d8c1-d921-42aa-9be2-b06b8eb6ced8"><ac:plain-text-body><![CDATA[
...
[General]
...
]]></ac:plain-text-body></ac:structured-macro>
...
AlgorithmID
...
Algorithm ID
...
IWRS2
...
ModelID
...
Model ID
...
The ID of this particular ISIS model – the name specified for the export (e.g. MyModel)
...
IsisVersion (optional)
...
Version number of ISIS to run
...
Blank (default) or m.n, where m=major version; n=minor version.
...
ISISExeType (optional)
...
Flag to denote whether to run the Windows or console (Non-windows) version of the exe
...
Blank (default – Windows) or "NotWin" (console).
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4780a003-9a2b-4fdd-8467-8e438c48dce4"><ac:plain-text-body><![CDATA[
...
[InputDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of input series
...
Number of flow or stage input series + 2 * Number of wind input series
...
Count0d
...
Number of scalar sets of input series
...
0
...
Count1d
...
Number of 1-d arrays of input series
...
2
...
Count2d
...
Number of 2-d arrays of input series
...
0
...
Size1d
...
Dimensions of 1d series
...
Number of flow or stage input series, 2 * Number of wind input series
...
Size2d
...
Dimensions of 2d series
...
Omit
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="123db1d5-02a2-432f-a104-a8fc9ed51c8a"><ac:plain-text-body><![CDATA[
...
[Inputs]
...
]]></ac:plain-text-body></ac:structured-macro>
...
IDs
...
Location IDs for the input data streams
...
ISIS node label for each flow or stage input,
Identifier for each wind component input stream[1
...
http://publicwiki.deltares.nl/#_edn1] (each separated by a comma and a space)
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="60b42816-8dd2-481a-a72f-d1cdcd6991f2"><ac:plain-text-body><![CDATA[
...
[ControlDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of control series
...
Number of simple controls +
5 * Number of breaches
...
Count0d
...
Number of scalar sets of control series
...
0
...
Count1d
...
Number of 1-d arrays of control series
...
2
...
Count2d
...
Number of 2-d arrays of control series
...
0
...
Size1d
...
Dimensions of 1d series
...
Number of simple controls,
5 * Number of breaches
...
Size2d
...
Dimensions of 2d series
...
Omit
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="58ebfb5f-2582-4ab5-96b7-ca9dc76ef277"><ac:plain-text-body><![CDATA[
...
[Controls]
...
]]></ac:plain-text-body></ac:structured-macro>
...
IDs
...
Location IDs for the control data streams
...
Upstream ISIS node label for each simple control,
Identifier for each breach component stream[2
...
http://publicwiki.deltares.nl/#_edn2] (each separated by a comma and a space)
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="677fd771-d73e-4852-a802-a7248de6f961"><ac:plain-text-body><![CDATA[
...
[OutputDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of output series
...
Total number of output series
...
Count0d
...
Number of scalar sets of output series
...
0
...
Count1d
...
Number of 1-d arrays of output series
...
1
...
Count2d
...
Number of 2-d arrays of output series
...
0
...
Size1d
...
Dimensions of 1d series
...
Number of output series
...
Size2d
...
Dimensions of 2d series
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b7cff2b2-d4ad-4e3c-9dbe-99a1603e904f"><ac:plain-text-body><![CDATA[
...
[Outputs]
...
]]></ac:plain-text-body></ac:structured-macro>
...
IDs
...
Location IDs for the output data streams
...
ISIS node label for each output (each separated by a comma and a space)
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f67a2779-54b1-4597-a5a2-4879986ce8e2"><ac:plain-text-body><![CDATA[
...
[StatesDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of states
...
0
...
Count0d
...
Number of scalar states
...
0
...
Count1d
...
Number of 1-d arrays of states
...
0
...
Count2d
...
Number of 2-d arrays of states
...
0
...
Size1d
...
Dimensions of 1d states
...
Omit
...
Size2d
...
Dimensions of 2d states
...
Omit
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5687b6bd-0ff5-430e-b773-3f65ee3d2a4a"><ac:plain-text-body><![CDATA[
...
[RealParameterDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of real parameters
...
3
...
Count0d
...
Number of scalar real parameters
...
3
...
Count1d
...
Number of 1-d arrays of real parameters
...
0
...
Count2d
...
Number of 2-d arrays of real parameters
...
0
...
Size1d
...
Dimensions of 1d real parameter arrays
...
Omit
...
Size2d
...
Dimensions of 2d real parameter arrays
...
Omit
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1929f6ac-f21d-4cfc-83f2-62a4580a321b"><ac:plain-text-body><![CDATA[
...
[RealParameters]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Values
...
Real parameters
...
Blank,
Timeout per 1h of simulated time (s),
Save interval (s)
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f729ada1-b046-450c-b4d1-8c379aa91b71"><ac:plain-text-body><![CDATA[
...
[IntegerParameterDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of integer parameters
...
2 +
Number of flow or stage input series +
Number of simple controls +
Number of output series +
2 * Number of breaches
...
Count0d
...
Number of scalar integer parameters
...
2
...
Count1d
...
Number of 1-d arrays of integer parameters
...
3
...
Count2d
...
Number of 2-d arrays of integer parameters
...
1
...
Size1d
...
Dimensions of 1d integer parameter arrays
...
Number of flow or stage input series,
Number of simple controls,
Number of output series
...
Size2d
...
Dimensions of 2d integer parameter arrays
...
2 ,
Number of breaches
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="39a54e51-015c-44fd-93b7-7b2664e7bdb0"><ac:plain-text-body><![CDATA[
...
[IntegerParameters]
...
]]></ac:plain-text-body></ac:structured-macro>
The latest documentation of the adapter is maintained by CH2M HILL and can be found here.
Example
An example of the ISIS ini file can be found here.
| Info |
|---|
Note that this file is generated in by ISIS (file > export to EA FFS) - see ISIS documentation for further details. |
...
Values
...
Integer parameters
...
Ini file Version number (currently 5),
ISIS label length (8 or 12),
Unit type for each flow or stage input series[3
...
http://publicwiki.deltares.nl/#_edn3],
Unit type for each simple control series[4
...
http://publicwiki.deltares.nl/#_edn4],
Unit type for each output series[5
...
http://publicwiki.deltares.nl/#_edn5],
Unit type and component count for each breach[6
...
http://publicwiki.deltares.nl/#_edn6]
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a1f3aa1e-c3fe-4316-a820-de71076a4041"><ac:plain-text-body><![CDATA[
...
[CharacterParameterDimensions]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Total
...
Total number of character parameters
...
1 +
Number of flow or stage input series +
Number of simple controls +
Number of output series +
Number of wind input series +
2 * Number of breaches
...
Count0d
...
Number of scalar character parameters
...
1
...
Count1d
...
Number of 1-d arrays of character parameters
...
4
...
Count2d
...
Number of 2-d arrays of character parameters
...
1
...
Size1d
...
Dimensions of 1d character parameter arrays
...
Number of input series,
Number of simple controls,
Number of output series,
Number of wind input series
...
Size2d
...
Dimensions of 2d character parameter arrays
...
2 ,
Number of breaches
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b87ad9e0-7e8b-460c-9a43-79b32c45230a"><ac:plain-text-body><![CDATA[
...
[CharacterParameters]
...
]]></ac:plain-text-body></ac:structured-macro>
...
Values
...
String parameters
...
Blank,
ISIS node label for each flow or stage input,
Upstream ISIS node label for each simple control,
ISIS node label for each output,
ISIS node label for each wind input,
Upstream and downstream ISIS node label for each breach[7
...
http://publicwiki.deltares.nl/#_edn7]
[1|http://publicwiki.deltares.nl/#_ednref1] Each wind has two component series which are
- speed
- direction
Each component requires a data stream in the forecasting system, and those data stream identifiers must be listed here in the above order. The convention for naming them is as follows, where Node_Label is the wind unit's upstream node label:
- Node_Label_WIND_SPEED
- Node_Label_WIND_DIRECTION
[2|http://publicwiki.deltares.nl/#_ednref2] Each breach has five component control series which are, in numerical order:
- offset
- width
- crest elevation
- crest depth
- side slope
Each component requires a data stream in the forecasting system, and those data stream identifiers must be listed here in the above order. The convention for naming them is as follows, where Node_Label is the breach's upstream node label:
- Node_Label_BREACH_OFFSET
- Node_Label_BREACH_WIDTH
- Node_Label_BREACH_CREST
- Node_Label_BREACH_DEPTH
- _Node_Label__BREACH_SLOPE
[3|http://publicwiki.deltares.nl/#_ednref3] Unit types for input series are as follows:
Flow-time boundary: | 1 |
Stage-time boundary: | 2 |
These must be in the same order as the node labels in the Inputs section (so there will be a set of 1s followed by a set of 2s).
[4|http://publicwiki.deltares.nl/#_ednref4] Unit types for simple control series are as follows:
Vertical sluice: | 21 |
Radial sluice: | 22 |
Abstraction: | 35 |
Gated weir: | 38 |
Pump: | 46 |
Blockage: | 52 |
Flow gauge | 56 |
Stage gauge | 57 |
These must be in the same order as the node labels in the Controls section.
[5|http://publicwiki.deltares.nl/#_ednref5] Unit types for output series are as follows:
Flow: | 1 |
Stage: | 2 |
These must be in the same order as the node labels in the Outputs section (so there will be a set of 1s followed by a set of 2s).
[6|http://publicwiki.deltares.nl/#_ednref6] Breaches have unit type 51 and 5 components each, so here there will be a pair of integers 51,5 for each breach. This allows for possible other breach-like things with more than one time series per unit in future.
[7|http://publicwiki.deltares.nl/#_ednref7] Each character parameter must be separated by a comma and a space. There must be no quotes around the parameters.
Example
...