Loading [Contrib]/a11y/accessibility-menu.js
Skip to content

GENERIC Adapter

This adapter supports registration of any type of model based on either prewritten configuration file or parsing of Flood Watch folder structure.

Concept

A model can be for a variety of different purposes, likewise model could be developed using different modelling tools like MIKE 11, MIKE 21, MIKE SHE etc... Therefore, to provide users with an option to register any type of model with MIKE Workbench this adapter has been created.

It doesn't provide user with full flexibility of editing different options via MIKE Workbench but still it enables users to register their models by writing a configuration file. The configuration file should adhere to an xml schema which is mentioned later in this document.

It also provides users with an option to register their FLOOD WATCH models without having to write the configuration file. But for this to work user need to follow a strict predefined FLOOD WATCH folder structure. Folder structure required is also mentioned later in this document.

Prerequisites

The configuration and execution of models into MIKE Workbench using this adapter will require

  • Configuration file describing model setup. E.g. The model setup files, other output files, model object types, model objects and their input, output and spatial output time series etc.

  • Time series are assumed to be single item df0 time series.

  • The spatial time series are assumed to be single item dfs2.

  • Hotstart.xml file containing hotstart start and end date times in corresponding hotstart input and output folders. These files also need to follow a specified schema mentioned later in this document, and are required if hotstart is used

  • If user is registering a FlOOD WATCH model and a predefined folder structure is followed, then also user can register the model in MIKE WORKBENCH via this adapter. User can optionally specify hotstart start and end date time in a hotstart.cfg file which is described later in this document.

If not specified via the file, user has to specify them via the UI.

Configuration

This section describes the xml schema of the configuration file to be created for registering the model via this adapter. Also a sample configuration file is provided. In the configuration file a user can specify launch commands. Launch command can be either of type 'file' or 'script'. As shown below.

<LaunchCmd CmdType="file">HSPF Run.bat</LaunchCmd>

Or

<LaunchCmd CmdType="script">/ScriptName</LaunchCmd>

User can also specify multiple launch commands in the configuration file. They will be executed in the same order in which they are listed in the configuration file.

Input timeseries

The Generic adapter supports two formats of input and output time series - dfs0 and csv. A dfs0-file may contain multiple items. The csv-format assumes only one item per file. The csv-file looks like this:

Or like this when viewed in Excel:

I.e. it is a semi-colon separated file with two headers and two columns. The first line may contain an item description in the form <Variable>[unit]:<value type>. If the variable, unit and value type translate into the MIKE Zero EUM system for dfs0-files, they will be used for defining the data series characteristics, otherwise the type will be undefined.

The second line contains "Time" in the first column and the item name in the second column.

From line 3, the columns contain date and time (preferably in the format yyyy-MM-dd HH:mm:ss) and a value with decimal point.

Configuration file

The configuration file is a XML-file listing the model setup files, other output files, model object types and model objects with it input, output, spatial output time series, hotstart folders. Below is the schema of the configuration file.

<?xml version="1.0" encoding="UTF-8"?>
<!-- MIKE Workbench Generic Adapter interface -->
<schema xmlns:mc="http://www.dhigroup.com/mc" xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.dhigroup.com/mc" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
  <element name="AdapterConfig" type="mc:AdapterConfigComplexType"/>

  <complexType name="AdapterConfigComplexType">
    <sequence>
      <element name="LaunchCmd" type="string" minOccurs="1" maxOccurs="unbounded">
        <annotation>
          <documentation>relative path to a model setup file</documentation>
        </annotation>
    <attribute name="CmdType" type="string" use="required">
        <annotation>
          <documentation>type of command (file | script) </documentation>
        </annotation>
    </attribute>
</element>
      <element name="StartOfSimulation" type="string" minOccurs="0" maxOccurs="1">
        <annotation>
          <documentation>Start of simulation, date format : dd/MM/yyyy HH:mm:ss</documentation>
        </annotation>
      </element>
<element name="EndOfSimulation" type="string" minOccurs="0" maxOccurs="1">
        <annotation>
          <documentation>End of simulation, date format : dd/MM/yyyy HH:mm:ss</documentation>
        </annotation>
      </element>
<element name="TimeOfForecast" type="string" minOccurs="0" maxOccurs="1">
        <annotation>
          <documentation>Time of forecast, date format : dd/MM/yyyy HH:mm:ss</documentation>
        </annotation>
      </element>
      </element>
      <element name="ModelSetupFile" type="string" minOccurs="0" maxOccurs="unbounded">
        <annotation>
          <documentation>relative path to a model setup file</documentation>
        </annotation>
      </element>
      <element name="HotstartInputFolder" type="string" minOccurs="0" maxOccurs="1">
        <annotation>
          <documentation>optional name of the folder with hotstart input files</documentation>
        </annotation>
      </element>
      <element name="HotstartOutputFolder" type="string" minOccurs="0" maxOccurs="1">
        <annotation>
          <documentation>optional name of the folder with hotstart output files</documentation>
        </annotation>
      </element>
      <element name="ModelObjectType" type="mc:ModelObjectTypeComplexType" minOccurs="1" maxOccurs="unbounded">
        <annotation>
          <documentation>group of model objects of same type</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
  <complexType name="ModelObjectTypeComplexType">
    <annotation>
      <documentation>type to describe a groups of model objects</documentation>
    </annotation>
      <sequence>
    <element name="Symbology" type="string" minOccurs="0" maxOccurs="1">
        <annotation>
          <documentation>optional text string giving the symbology definition for the layer. It must match the type of shapes in the shapefile</documentation>
        </annotation>
      </element>
      <element name="ModelObject" type="mc:ModelObjectComplexType" minOccurs="1" maxOccurs="unbounded">
        <annotation>
          <documentation>the model object</documentation>
        </annotation>
      </element>
    </sequence>
    <attribute name="Id" type="string" use="required">
      <annotation>
        <documentation>unique Id of the model object type</documentation>
      </annotation>
    </attribute>
    <attribute name="ShapeFilePath" type="string">
      <annotation>
        <documentation>relative path to an optional shapefile with geometry of the  moodel objects</documentation>
      </annotation>
    </attribute>
    <attribute name="ShapeFileIdAttribute" type="string">
      <annotation>
        <documentation>if shapefile is specified this defines the field within to match with the model object id</documentation>
      </annotation>
    </attribute>
  </complexType>
  <complexType name="ModelObjectComplexType">
    <annotation>
      <documentation>type to describe a model object</documentation>
    </annotation>
    <sequence>
      <element name="InputTimeseriesFile" type="mc:TimeseriesFileComplexType" minOccurs="0" maxOccurs="unbounded">
        <annotation>
          <documentation>relative path to an input time series file</documentation>
        </annotation>
      </element>
      <element name="OutputTimeseriesFile" type="mc:TimeseriesFileComplexType" minOccurs="0" maxOccurs="unbounded">
        <annotation>
          <documentation>relative path to an output time series file</documentation>
        </annotation>
      </element>
      <element name="SpatialOutputTimeseriesFile" type="mc:SpatialTimeseriesFileComplexType" minOccurs="0" maxOccurs="unbounded">
        <annotation>
          <documentation>relative path to an output time series file</documentation>
        </annotation>
      </element>
    </sequence>
    <attribute name="Id" type="string" use="required">
      <annotation>
        <documentation>Id of the model object</documentation>
      </annotation>
    </attribute>
    <attribute name="Name" type="string" use="required">
      <annotation>
        <documentation>a unique name of the model object</documentation>
      </annotation>
    </attribute>
  </complexType>
  <complexType name="TimeseriesFileComplexType">
    <annotation>
      <documentation>type to describe a time series file</documentation>
    </annotation>
    <attribute name="FilePath" type="string" use="required">
      <annotation>
        <documentation>relative path to an time series file</documentation>
      </annotation>
    </attribute>
    <attribute name="FileType" type="string">
      <annotation>
        <documentation>the type of file. Only dfs0 is supported(default) </documentation>
      </annotation>
    </attribute>
  </complexType>
  <complexType name="SpatialTimeseriesFileComplexType">
    <annotation>
      <documentation>type to describe a time series file</documentation>
    </annotation>
    <attribute name="FilePath" type="string" use="required">
      <annotation>
        <documentation>relative path to a spatial time series file</documentation>
      </annotation>
    </attribute>
    <attribute name="FileType" type="string">
      <annotation>
        <documentation>the type of file. only supported is dfs2 (default)</documentation>
      </annotation>
    </attribute>
  </complexType>
</schema>

Below is a sample configuration file.

<?xml version="1.0" encoding="UTF-8"?>
<AdapterConfig>
    <LaunchCmd CmdType="file">HSPF Run.bat</LaunchCmd>
    <ModelSetupFile>"HSPF Run.bat"</ModelSetupFile>
    <ModelSetupFile>"HSPF Run.py"</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\Dynamic.cfg</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\error.fil</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\HSPFMSG.WDM</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\HSPFWar.OUT</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\HSPFWarragamba.UCI</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\static.cfg</ModelSetupFile>
    <ModelSetupFile>MODEL_FILES\HSPFWarOUT.plt</ModelSetupFile>
    <HotstartInputFolder>HotstartInput</HotstartInputFolder>
    <HotstartOutputFolder>HotstartOutput</HotstartOutputFolder>
    <OtherOutputFile>HSPFDebug.log</OtherOutputFile>
    <OtherOutputFile>Adapter.log</OtherOutputFile>
    <StartOfSimulation>07/06/2014 06:00:00</StartOfSimulation>
    <EndOfSimulation>18/06/2014 06:00:00</EndOfSimulation>
    <TimeOfForecast>11/06/2014 06:00:00</TimeOfForecast>
    <ModelObjectType Id="Boundary Conditions" ShapeFile="HSPF.shp" ShapeFileIdAttribute="ModelObj">
        <Symbology>
            <FeatureLayerDefinition>
                <LayerStyleDefinition Color="Color [Blue]" OuterLineColor="Color [Blue]" OuterLineThickness="1" OuterLineType="Solid" LineThickness="1.2" LineType="Solid" RoundCap="True" />
            </FeatureLayerDefinition>
        </Symbology>
        <ModelObject Id="HSPFIN1" Name="oe-668045-WARRAGAMBA MET STATION" >
            <InputTimeseriesFile FilePath="Input\FILE1.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN2" Name="oe-668045-WARRAGAMBA MET STATION 2" >
            <InputTimeseriesFile FilePath="Input\FILE2.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN3" Name="or-563073-LOWTHER(DUDDAWARRA)" >
            <InputTimeseriesFile FilePath="Input\FILE3.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN4" Name="or-570341-GOULBURN (GUNDOWRINGA)" >
            <InputTimeseriesFile FilePath="Input\FILE4.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN5" Name="or-570350-GOULBURN (WATER TREATMENT WORKS)" >
            <InputTimeseriesFile FilePath="Input\FILE5.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN6" Name="or-570340-GOULBURN (SPRINGFIELD)" >
            <InputTimeseriesFile FilePath="Input\FILE6.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN7" Name="or-568084-BUMBULLA" >
            <InputTimeseriesFile FilePath="Input\FILE7.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN8" Name="or-570349-TARALGA (SOMERSET)" >
            <InputTimeseriesFile FilePath="Input\FILE8.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN9" Name="or-568165-MOSS VALE (BERRIMA JUNCTION)" >
            <InputTimeseriesFile FilePath="Input\FILE9.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN10" Name="or-570335-BIG HILL (GLEN DUSK)" >
            <InputTimeseriesFile FilePath="Input\FILE10.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN11" Name="or-568099-MITTAGONG (LEICESTER PARK)" >
            <InputTimeseriesFile FilePath="Input\FILE11.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN12" Name="or-568038-WOLLONDILLY (JOORILAND)" >
            <InputTimeseriesFile FilePath="Input\FILE12.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN13" Name="or-568051-OAKDALE (THE BRIDGE)" >
            <InputTimeseriesFile FilePath="Input\FILE13.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN14" Name="or-568038-WOLLONDILLY (JOORILAND) 14" >
            <InputTimeseriesFile FilePath="Input\FILE14.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN15" Name="or-563048-LIDSDALE STATE FOREST" >
            <InputTimeseriesFile FilePath="Input\FILE15.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN16" Name="or24-563049-COX RIVER (KELPIE POINT) 24 RAIN" >
            <InputTimeseriesFile FilePath="Input\FILE16.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN17" Name="or-563056-YERRANDERIE (KIARAMBA SPRINGS)" >
            <InputTimeseriesFile FilePath="Input\FILE17.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN18" Name="or-563059-KATOOMBA (CASCADE CK DAM No.1)" >
            <InputTimeseriesFile FilePath="Input\FILE18.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFIN19" Name="or-568045-WARRAGAMBA MET. STATION" >
            <InputTimeseriesFile FilePath="Input\FILE19.dfs0"/>
        </ModelObject>
    </ModelObjectType>
    <ModelObjectType Id="Calculation Points" ShapeFile="" ShapeFileIdAttribute="">
        <Symbology></Symbology>
        <ModelObject Id="HSPFOUT1" Name="Coxs@KPt" >
            <OutputTimeseriesFile FilePath="Output\FILE1.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT2" Name="Kowmung@CF" >
            <OutputTimeseriesFile FilePath="Output\FILE2.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT3" Name="Wollondilly" >
            <OutputTimeseriesFile FilePath="Output\FILE3.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT4" Name="Nattai@CW" >
            <OutputTimeseriesFile FilePath="Output\FILE4.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT5" Name="Little_R@FR" >
            <OutputTimeseriesFile FilePath="Output\FILE5.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT6" Name="Kedumba@KX" >
            <OutputTimeseriesFile FilePath="Output\FILE6.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT7" Name="Werriberrier" >
            <OutputTimeseriesFile FilePath="Output\FILE7.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT8" Name="Residaul" >
            <OutputTimeseriesFile FilePath="Output\FILE8.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT9" Name="Warragmaba_Total" >
            <OutputTimeseriesFile FilePath="Output\FILE9.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT10" Name="GoldenValley" >
            <OutputTimeseriesFile FilePath="Output\FILE10.dfs0"/>
        </ModelObject>
        <ModelObject Id="HSPFOUT11" Name="Murrays_Flat" >
            <OutputTimeseriesFile FilePath="Output\FILE11.dfs0"/>
        </ModelObject>
    </ModelObjectType>
</AdapterConfig>

Below is the hotstart.xml schema for specifying hotstart start and end date times.

<?xml version="1.0" encoding="UTF-8"?>
<!-- MIKE Workbench Generic Adapter interface -->
<schema xmlns:mc="http://www.dhigroup.com/mc" xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.dhigroup.com/mc" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
  <element name="Hotstart" type="mc:HotstartComplexType"/>
  <complexType name="HotstartComplexType">
      <attribute name="StartDate" type="dateTime" use="required">
        <annotation>
          <documentation>the start date of the hotstart coverage interval, date format : dd/MM/yyyy HH:mm:ss </documentation>
        </annotation>
      </attribute>
      <attribute name="EndDate" type="dateTime" use="required">        
        <annotation>
          <documentation>the end date of the hotstart coverage interval, date format : dd/MM/yyyy HH:mm:ss </documentation>
        </annotation>
      </attribute>
    </complexType>
</schema>

Sample hotstart.xml is mentioned below.

<?xml version="1.0" encoding="UTF-8"?>
<Hotstart StartDate="30/04/2005 00:00:00" EndDate="18/06/2014 06:00:00"></Hotstart>

How to organize model setup files for FLOOD WATCH

Below is the screenshot showing predefined folder structure for FLOOD WATCH.

Figure 1 Sample of FLOOD WATCH model folder structure.

As shown in the above screenshot FLOOD WATCH model being registered should adhere to above shown folder structure.

  1. HOTSTART_INPUT: This folder contains the hotstart input files and the hotstart.xml(optional)
  2. HOTSTART_OUTPUT: This folder contains the hotstart output files. No need to have hotstart.xml in this folder.
  3. INPUT_DATA: This folder will contain all the input time series of the model.
  4. MODEL_FILES: This folder contains the other model files like the dynamic.cfg etc...
  5. OUTPUT_DATA: This folder contains the output time series.
  6. Configuraiton.xml: This is the main file which will be used by generic adapter to register the model.
  7. Configuration.cfg: This file is generated by generic adapter so no need to have this file initially.

Model registration

The following illustrates the registration process.

  1. From Scenario Manager in MIKE Workbench the user selects "Register model"

  2. The user selects the Generic model adapter by selecting GENERIC option.

  3. The user provides the required (and optional) input to the Generic Adapter

    • Model setup name - the name of the model setup to be registered.
    • Configuration file - Path of the configuration file to be used by generic adapter for registering the model in MIKE Workbench.
    • Coordinate system (optional) - Specify the coordinate system to be used by the adapter.
      If unspecified then the coordinate system will be taken up from the first model object type shape file specified in the configuration xml.
    • Generate configuration (optional) - User can press this button if they are trying to register a FLOOD WATCH model which follows specified folder structure as shown earlier in this document.
    • Clicking next will start the parsing of the model setup configuration file.
    • Keep following through the model registration wizard.
    • Eventually the model setup can be seen and used in Scenario Manager

Generate configuration option

If user selects Generate configuration button on the Generic adapter dialog, then below dialog will be prompted to the user.

  • Root folder - This is the folder that contains the predefined folder structure of FLOOD WATCH model.
  • Launch cmd - This can be either a script path in MIKE Workbench or it can be a path to an executable or batch file.
  • Hotstart start and end date times (optional if specified in hotstart.xml file) - These can be specified here in the UI or via the hotstart.xml file in the hotstart_input folder. The file schema is defined above in this document.

When user presses OK to this dialog, then a configuration file is created based on folder parsing in the selected root folder and the path of the newly generated configuration file is put in to the configuration file path in the previous dialog, as shown below.

Then user can specify the model name and click next to continue registering the model in MIKE Workbench.