...
The model is introduced in the 2021.01 BoM Delft-FEWS version and . The model adapter will be part of the Delft-FEWS code base of Delft-FEWS versions 2023.01 and onwards with in-memory options.
General Adapter configuration
The General Adapter defines forms the interface between the FEWS system and the Reservoir model.
The data is provided in a standardized XML interface format, the FEWS Published Interface. For more details about general structure of the General Adapter please check 05 General Adapter Module.
IDmapping
The location/parameters used in Delft-FEWS can be transformed to model variableId locations/parameters by ID-mapping. The configuration files for ID-mapping can be of a general form, as long as the reservoir model have been set up with identical variables for the inputs/outputs. The model will look for the required variables (as configured in the IRM model file) in the parameter field of the PI timeseriesin the General Adapter configuration.
Directory structure
The data directories and configuration files that are required for operating the FEWS Reservoir Model Adapter have been are shown below.
| No Format |
|---|
FEWS_SA
+---Config
| +---ColdStateFiles
| | | namoi_keepit_KeepReservoir_Historical_IRM Default.zip........coldState file
| +---IdMapFiles
| | IdExportIRMReservoir.xml
| | IdImportIRMReservoir.xml.........................................custom mappings for the IRM variables and locations
| |
| +---ModuleConfigFiles
| | | Reservoir_1h_Forecast_IRM.xml....................................main configuration file of the adapter
| |
| +---ModuleDataSetFiles
| | | Reservoir_Exe.zip................................................zipped IRM bin files, transported to Modules\reservoir directory
| | |
| | | namoi_IRM_Reservoir_Forecast.zip.................................zipped IRM model files for a specific reservoir, transported to Modules\Reservoir directory
|
+---Modules
| +---delft-adapters........................................................directory which contains all IRM adapter java files
| | |
| +---reservoir
| | +---Keep_IRM
| | | diag.xml......................................................output FEWS-PI diagnostics file, imported by Delft-FEWS
| | | export.xml....................................................output FEWS-PI time series files, imported by Delft-FEWS
| | | exportState.xml...............................................FEWS-PI state output time series file, imported by Delft-FEWS
| | | import.xml....................................................input FEWS-PI time series files, exported by Delft-FEWS
| | | importState.xml...............................................FEWS-PI state input time series file, exported by Delft-FEWS
| | | Keep_IntegratedReservoirModel.xml..................................IRM model file
| | | run_info.xml..................................................a file generated by FEWS containing paths, run options
| | | statePI.xml...................................................PI State file (definition)
| | | |
...
General Adapter configuration
The General Adapter defines forms the interface between the Delft-FEWS system and the Reservoir model.
The data is provided in a standardized XML interface format, the FEWS Published Interface. For more details about general structure of the General Adapter please check 05 General Adapter Module.
general
Configuring a pi-version 1.8 is required for the diagnostics of the model.
IDmapping
The location/parameters used in Delft-FEWS can be transformed to model variableId locations/parameters by ID-mapping. The configuration files for ID-mapping can be of a general form, as long as the reservoir model have been set up with identical variables for the inputs/outputs. The model will look for the required variables (as configured in the IRM model file) in the parameter field of the PI timeseries.
IdMapping is IdMapping is useful, but ofcourse dependent on how the variables have been defined in the model. The The Reservoir Model code will try to parse the configured model variables (like IIn, QOut, etc) from the parameterId of the PI timeseries, the locationId is not used. This means that the parameterId's of all the input timeseries need to be unique (and identical to the model variables). When writing the output timeseries, the locationId used in the import PI xml files will be used as the locationId in the output PI xml files.
exportStateActivity
...
The Reservoir model can work with a stateConfigFile, exported from Delft-FEWS. This file should follow the conventions and list the read/write locations. When defined, the model will write an output state timeseries file for the complete run period, for all model export variables.
exportTimeSeriesActivity
The reservoir model requires at a minimum the following timeseries:
- level or state value (at model start time)
- inflow timeseries (complete run period)
- outflow timeseries (optional)
exportRunFileActivity
A
exportTimeSeriesActivity
<exportTimeSeriesActivity>
Export data (inflows and outflows)</description>
<exportFile>import.xml</exportFile>
<exportTimeSeriesActivity>
<description>Export state data (levels and volumes)</description>
<exportFile>importState.xml</exportFile>
<exportDataSetActivity>
<moduleInstanceId>$CATCHMENT$_IRM_Reservoir_Forecast</moduleInstanceId>
</exportDataSetActivity>
exportRunFileActivity
The run_info file is required input for the Reservoir model, so an exportRunFileActivity needs to be configured in the General Adapter. The Reservoir Model expects a model property in the run_info file, that specifies the name of the actual Reservoir model to be run.
| Code Block | ||
|---|---|---|
| ||
...
<exportFile>run_info.xml</exportFile> |
...
<properties> |
...
<string key="model" value="$RESERVOIR$_IntegratedReservoirModel.xml"/> |
...
</properties> |
...
</exportRunFileActivity> |
A typical run_info.xml file will contain the following information:
executeActivity
The executeActivity runs the model. The model runs of the Delft-FEWS JRE, so the ReservoirModelAdapter binaries can be specified within the binDir element. The class itself is called nl.deltares.fews.reservoirmodel.ReservoirModelAdapter. It is required to provide the path of the run_info file as an argument to the model.
| Code Block | ||
|---|---|---|
| ||
<executeActivity> <description>Run Reservoir module</description> |
...
<command> <className>nl.deltares.fews.reservoirmodel.ReservoirModelAdapter</className> |
...
<binDir>$REGION_HOME$/Modules/ |
...
delft-adapters/fews-reservoirmodel-adapter-bin</binDir> </command> <arguments> <argument>%ROOT_DIR%/run_info.xml</argument> |
...
</arguments> |
...
...
...
<timeOut>100000</timeOut>
<ignoreDiagnostics>true</ignoreDiagnostics>
</executeActivity> |
importActivity
The model results (typically consisting of level, storage, inflow and outflow timeseries) can be imported using the importActivities. The importFile name configured will be written to the run_info file and consequently be created by the Reservoir model. Note that specific idImport configuration is required.
importActivities
<importTimeSeriesActivity>
<description>Import IRM reservoir management results</description>
<importFile>export.xml</importFile>
Model
The model definition for the reservoir is can be configured in file that follows the Integrated Reservoir Model schema. The model options are described below. An example Integrated Reservoir Model file is attached.The model can be considered "timestep ending", similar the the timestep definition of Delft-FEWS.
Schema
general
reservoir
general
...
inflow and outflow values at the starting time are not required at the first timestep. When they are not found, a value of 0 is used.
Reservoir Model specifics
- The model can be considered "timestep ending", similar the the timestep definition of Delft-FEWS.
- No calculations/processing is performed at the first timestep (t=0, startDateTime as set in the run_info.xml file)
Ensembles
The Reservoir Model can be run in parallel from Delft-FEWS. The runInLoop element of the workflow should be set to false. The general section of the General Adapter configuration should contain the %TEMP_DIR% property as the model rootDir. And lastly, to enable the parallel running of ensemble members the runInLoopParallelProcessorCount entry must be set in the global properties file. Here you either specify the number of cores to use or specify 100 to use all available cores.
In the workflow
| Code Block | ||
|---|---|---|
| ||
<activity>
<runIndependent>true</runIndependent>
<workflowId>Reservoir_Forecast</workflowId>
<ensemble>
<ensembleId>ENSEMBLE</ensembleId>
<runInLoop>false</runInLoop>
</ensemble>
</activity> |
The general section of the General Adapter configuration
| Code Block | ||||
|---|---|---|---|---|
| ||||
<general>
<rootDir>%TEMP_DIR%</rootDir>
<workDir>%ROOT_DIR%/work</workDir>
...
</general> |
In the global properties
Config Example |
|
|---|
See the following page for more details.Model is able to run in parallel, where a "static"
In-Memory execution
(From Delft-FEWS version 2023.01 onwards), it will be porssible to run the Reservoir Model adapter "in-memory" from Delft-FEWS, using the inMemoryFileTransfer element of the general section set to True. In that case, all exported and imported files are transferred in memory between Delft-FEWS and the executed Reservoir Model.