...
- URBS parameter adapter from Deltares (this wiki), responsible for:
- Conversion of the Delft-FEWS PI Parameter XML file to the *.ini file that will be used by the URBS pre adapter. This parameters file can incorporate location attribute modifiers written by Delft-FEWS
- Documentation of this adapter can be found on this page.
- URBS pre and post adapter from Don Carroll, responsible for:
- Extraction of the start date, end date and time increment for the data series from the startDate, endDate and timeStep.
- Please note that the pre and post adapter will assume a GMT+10 time zone, even if you specify differently. For any questions regarding this behavior (which does not correspond to the documentation, see link below), please contact Don Carroll.
- Conversion of time series files for rainfall, gauging station and inflow data (i.e. the “.r”, “.g” or ‘.i” files) from Delf-FEWS PI XML to native URBS formatted files.
- Creation of the modelAdapter.bat file, to start the URBS model
- Conversion of the URBS output files to a single Delft-FEWS PI XML time series file
- Conversion of log messages from both the model run and the pre- and post adapter to Delft-FEWS PI XML log files
- For more info see URBS pre and post adapter
- Extraction of the start date, end date and time increment for the data series from the startDate, endDate and timeStep.
...
| Code Block | ||
|---|---|---|
| ||
<exportRunFileActivity>
<exportFile>paramAdapter_runinfo.xml</exportFile>
<properties>
<string key="urbsIniFile" value="%ROOT_DIR%\model\$SUBCATCHMENT$.ini"/>
<string key="rdfFile" value="%ROOT_DIR%\model\$SUBCATCHMENT$.rdf"/>
<string key="URBS_BIN" value="$MODULES_BIN$\urbs"/>
</properties>
</exportRunFileActivity> |
Properties URBS parameter adapter
For this adapter, some optional properties can be configured
parameterSeriesFile
When this property is configured, the adapter will read a pi xml file and will extract the first non missing value for each time series and will replace the values in the .ini file that matches the key of the parameter of that time series.
For example the value 48.0 will be taken from the next time series file and used to write "URBS_IL=48.0" to the urbs.ini file instead of the value taken from the PiParameters.xml file.
This is only done for the "Initial Dam Volumes and Levels", "Catchment and Channel Routing Parameters" and "Rainfall Runoff Parameters" sections in the .ini file.
Execute Activities
Before executing the URBS model, two adapters are called: the parameter adapter to create the model.ini file and the pre-adapter to convert the time series (see Figure above). As can be noted, each adapter creates its own diagnostics file to keep track of success and failure.
| Code Block | ||
|---|---|---|
| ||
<executeActivities>
<executeActivity>
<description>Run parameter adapter</description>
<command>
<className>nl.wldelft.urbs.ParameterAdapter</className>
<binDir>%ROOT_DIR%\..\..\..\delft-adapters</binDir>
</command>
<arguments>
<argument>%ROOT_DIR%\input\paramAdapter_runinfo.xml</argument>
</arguments>
<timeOut>400000</timeOut>
</executeActivity>
<executeActivity>
<description>Run PreAdapter</description>
<command>
<executable>%ROOT_DIR%\..\..\bin\preadapter.exe</executable>
</command>
<arguments>
<argument>%ROOT_DIR%\input\Input.xml</argument>
<argument>%ROOT_DIR%\model\$SUBCATCHMENT$.ini</argument>
<argument>%ROOT_DIR%\logs\urbsdiag_pre.xml</argument>
<argument>%ROOT_DIR%\model\$SUBCATCHMENT$.vec</argument>
<argument>%ROOT_DIR%\model\$SUBCATCHMENT$.rdf</argument>
</arguments>
<timeOut>1200000</timeOut>
<overrulingDiagnosticFile>%ROOT_DIR%\logs\urbsdiag_pre.xml</overrulingDiagnosticFile>
</executeActivity>
<executeActivity>
<description>Run modelAdapter (using cmd.exe /c to properly terminate)</description>
<command>
<executable>c:\$WINCOMMANDSHELL$</executable>
</command>
<arguments>
<argument>/c</argument>
<argument>%ROOT_DIR%\model\modelAdapter.bat</argument>
</arguments>
<timeOut>1200000</timeOut>
</executeActivity>
<executeActivity>
<description>Run PostAdapter</description>
<command>
<executable>%ROOT_DIR%\..\..\bin\postadapter.exe</executable>
</command>
<arguments>
<argument>%ROOT_DIR%\output\$SUBCATCHMENT$.csv</argument>
<argument>%ROOT_DIR%\logs\urbsout.log</argument>
<argument>%ROOT_DIR%\logs\urbserr.log</argument>
<argument>%ROOT_DIR%\output\Output.xml</argument>
<argument>%ROOT_DIR%\logs\urbsdiag_post.xml</argument>
</arguments>
<timeOut>1200000</timeOut>
<overrulingDiagnosticFile>%ROOT_DIR%\logs\urbsdiag_post.xml</overrulingDiagnosticFile>
</executeActivity>
</executeActivities> |
Import Activities
The Import Activities are not different from any other General Adapter Run. The time series from URBS are imported from the Output.xml file produced by the URBS post adapter.
Special Functions URBS parameter adapter
For the URBS parameter adapter, some optional functionality can be configured that are unique to this adapter. This optional functionality allows editing of a parameter value with a time series; this is implemented to enable copying of URBS loss values from a time series file to the URBS parameter ini file. The time series with values for the URBS parameter file need to be exported in a new PI Time Series XML file; i.e. params_series.xml.
The exported run file requires a reference to this exported PI XML file with a key = parameterSeriesFile. When this property is configured, the URBS parameter adapter will read a PI XML file and extract the first non missing value for each time series and replaces the values in the .ini file that matches the parameterId of that time series; in this example URBS_IL. For example the value 48.0 will be taken from the time series file below and used to write "URBS_IL=48.0" to the urbs.ini file instead of the value taken from the PiParameters.xml file. This function that replaces URBS parameter values with time series values can only be done for the "Initial Dam Volumes and Levels", "Catchment and Channel Routing Parameters" and "Rainfall Runoff Parameters" sections in the URBS .ini file.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<TimeSeries xmlns="http://www.wldelft.nl/fews/PI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseries.xsd" version="1.10">
<timeZone>10.0</timeZone>
<series>
<header>
<type>instantaneous</type>
<locationId>tweed_uki</locationId>
<parameterId>URBS_IL</parameterId>
<ensembleId>IFD</ensembleId>
<ensembleMemberIndex>0</ensembleMemberIndex> | ||||
| Code Block | ||||
| ||||
<TimeSeries xmlns="http://www.wldelft.nl/fews/PI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseries.xsd" version="1.10"> <timeZone>10.0</timeZone> <series> <header> <type>instantaneous</type> <locationId>tweed_uki</locationId> <parameterId>URBS_IL</parameterId> <ensembleId>IFD</ensembleId> <ensembleMemberIndex>0</ensembleMemberIndex> <timeStep unit="second" multiplier="86400"/> <startDate date="2018-05-21" time="10:00:00"/> <endDate date="2018-05-24" time="10:00:00"/> <missVal>-99.0</missVal> <stationName>tweed_uki</stationName> <lat>-28.46995606962717</lat> <lon>153.2671548515222</lon> <x>153.2671548515222</x> <y>-28.46995606962717</y> <z>0.0</z> <units>mm</units> </header> <event date="2018-05-21" time="10:00:00" value="-99.0" flag="8"/> <event date="2018-05-22" time="10:00:00" value="48" flag="0"/> <event date="2018-05-23" time="10:00:00" value="40" flag="0"/> <event date="2018-05-24" time="10:00:00" value="-99.0" flag="8"/> </series> </TimeSeries> |
locationParameterSeriesFile
When this property is configured, the adapter will read a pi xml file and will extract the first non missing value for each time series and will replace the values in the .ini file that matches the key of the location of that time series.
For example the value 48.0 will be taken from the next time series file and used to write "URBS_IL=48.0" to the urbs.ini file instead of the value taken from the PiParameters.xml file.
This is only done for the "Initial Dam Volumes and Levels" section in the .ini file.
vecFile
a vec file can be configured which will get the "URBS_VEC_TAGS" group from the Parameters.xml and will replace the corresponding tags is the specified vec file with the values of the parameter.
When "URBS_ASTERISKS" group is defined in Parameters.xml all %ASTERISK_<x>% tags will be replaced with an * where the <x> corresponds to one of the values in the string value of "URBS_ASTERISKS" parameter, separated by /
/TimeSeries>
|
vecFile
a vec file can be configured which will get the "URBS_VEC_TAGS" group from the Parameters.xml and will replace the corresponding tags is the specified vec file with the values of the parameter.
When "URBS_ASTERISKS" group is defined in Parameters.xml all %ASTERISK_<x>% tags will be replaced with an * where the <x> corresponds to one of the values in the string value of "URBS_ASTERISKS" parameter, separated by /
For this to work, the user also needs to define the “vecFile” key to the exportRunFileActivity.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<group id="URBS_VEC_TAGS" name="URBS Vec tags" readonly="false">
<model>Subcatchments</model>
<parameter id="VEC_B0" name="VEC_B0">
<description>URBS_VEC_B0</description>
<stringValue>27.5</stringValue>
</parameter>
<parameter id="VEC_BR" name="VEC_BR">
<description>URBS_VEC_BR</description>
<stringValue>0.875</stringValue>
</parameter> | ||||
| Code Block | ||||
| ||||
<group id="URBS_VEC_TAGS" name="URBS Vec tags" readonly="false"> <model>Subcatchments</model> <parameter id="VEC_B0BC" name="VEC_B0BC"> <description>URBS<description>VEC_VEC_B0<BC</description> <stringValue>27<stringValue>0.5<23</stringValue> </parameter> <parameter id="VEC_BRBM" name="VEC_BRBM"> <description>URBS<description>VEC_VEC_BR<BM</description> <stringValue>0.875<<stringValue>1</stringValue> </parameter> </parameter>/group> <group id="URBS_ASTERISKS" name="URBS_ASTERISKS"> <model>Subcatchments</model> <parameter id="VECURBS_BCASTERISKS" name="VECURBS_BCASTERISKS"> <description>VEC<description>URBS_BC<ASTERISKS</description> <stringValue>0.23<<stringValue>1/3</stringValue> </parameter> </group> |
| Code Block | ||||
|---|---|---|---|---|
| ||||
<exportRunFileActivity> <parameter id="VEC_BM" name="VEC_BM"> <exportFile>paramAdapter_runinfo.xml</exportFile> <description>VEC_BM</description><properties> <stringValue>1</stringValue> </parameter> </group> <group id="URBS_ASTERISKS" name="URBS_ASTERISKS"> <model>Subcatchments</model> <parameter id="URBS_ASTERISKS" name="URBS_ASTERISKS"<string key="urbsIniFile" value="%ROOT_DIR%\model\$SUBCATCHMENT$.ini"/> <string key="rdfFile" value="%ROOT_DIR%\model\$SUBCATCHMENT$.rdf"/> <description>URBS_ASTERISKS</description> <string <stringValue>1/3</stringValue> </parameter> </group> key="vecFile" value="%ROOT_DIR%\model\$SUBCATCHMENT$.vec"/> <string key="URBS_BIN" value="$MODULES_BIN$\urbs"/> </properties> </exportRunFileActivity> |
| Code Block | ||||
|---|---|---|---|---|
| ||||
River KNOCKLOFTY
MODEL: SPLIT
{Developed by Terry Malone on 08/10/2009}
USES: L, E*1, U*1, I*0.1
{The default parameters are for information only}
DEFAULT PARAMETERS: alpha = 0.2 m = 0.8 beta = 2.5 n = 1 x = 0
DEFAULT PARAMETERS: K24 = 0.993
CATCHMENT DATA FILE = knocklofty.dat
Factor = 1
INPUT. Newcastle_br
PRINT.Newcastle_br_G: B0=12.5 {12} Br=0.875 {0.825} BC= 0.25 BM = 1.0
STORE.
INPUT. nire
PRINT.Nire_G:B0=5.0 Br=0.875 BC= 0.2 BM = 1.0
GET.
ROUTE THRU #14 L = 2.63 Sc = 0.0005
ADD RAIN #14 L = 2.63 Sc = 0.0005
{PRINT.Ballydonagh: Br=0.9 BC= 0.2 BM = 1.0}
STORE.
RAIN #109 L = 5.84 Sc = 0.0273
GET.
ROUTE THRU #110 L = 1.22 Sc = 0.0019
ADD RAIN #110 L = 1.22 Sc = 0.0019
ROUTE THRU #15 L = 1.58 Sc = 0.0005
ADD RAIN #15 L = 1.58 Sc = 0.0005
PRINT.KNOCKLOFTY*
PRINT.KNOCKLOFTY_G : B0=%VEC_B0% {12} Br=%VEC_BR% {0.85} BC=%VEC_BC% {0.25} BM =%VEC_BM%
end of catchment data file.
4 PLUVIOGRAPHS:
LOCATION. suir014
1 SUBAREAS: 14
LOCATION. suir015
1 SUBAREAS: 15
LOCATION. suir109
1 SUBAREAS: 109
LOCATION. suir110
1 SUBAREAS: 110
END OF PLUVIOGRAPH DATA.
{3 rating station:}
{location. newcastle_br_G*1.1}
{location. nire_G*0.7}
{location. KNOCKLOFTY_G*1.1}
{end of rating stations.}
3 gauging station:
location. newcastle_br_G%ASTERISK_1%
location. nire_G%ASTERISK_2%
location. KNOCKLOFTY_G%ASTERISK_3%
end of gauging station.
|
...