You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

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:

  1. General
  2. InputDimensions
  3. Inputs
  4. ControlDimensions
  5. Controls
  6. OutputDimensions
  7. Outputs
  8. StatesDimensions
  9. RealParameterDimensions
  10. RealParameters
  11. IntegerParameterDimensions
  12. IntegerParameters
  13. CharacterParameterDimensions
  14. 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:

  • Flow input series: QTBDY marked as being used as an input to the operational model
  • Stage input series: HTBDY marked as being used as an input to the operational model
  • Wind input series: component of a WIND unit marked as being used as an input to the operational model
  • Simple control: GAUGE, VERTICAL SLUICE, RADIAL SLUICE, ABSTRACTION, GATED WEIR, PUMP, or BLOCKAGE marked as being used as an input to the operational model
  • Flow output series: node marked as providing flow output to the operational model
  • Stage output series: node marked as providing stage output to the operational model
    Name
    Generic meaning
    ISISvalue

    <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="93ad05cc-7e7e-4146-b998-567c209649b0"><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="2170cf03-25e2-4047-b311-69f3cc417da5"><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="abe089da-071a-4f89-8e5e-80d9f7ad7dd4"><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="5907516c-f670-40ca-bc44-8cfabfafc21e"><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="a052f1b5-d9a7-4da3-aad2-323bc3ae1f33"><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="dd05554c-d43b-4d72-a32a-f6fdf2ef6c93"><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="cc37a3fb-03e2-4808-a7b9-ef8cf7292e82"><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="25b401b5-778e-4280-9abd-0945b913da9e"><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="34440f2f-f294-4e3d-876d-bf4e7731542d"><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="f7ce71ac-a973-47d3-9dcd-7e1196857c95"><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="c173e1bc-5e7d-42bd-a344-90d7db9977d1"><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="5629f3ed-0b1c-4436-83e3-46d2aa678356"><ac:plain-text-body><![CDATA[

    [IntegerParameters]

    ]]></ac:plain-text-body></ac:structured-macro>

    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="9df27e22-0432-4389-ab6c-e23713781ce5"><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="7650c6fc-4d37-4ed3-9d06-18eb853e1888"><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

Attached.

The ISIS .ini file

  • No labels

Disclaimer