| Wiki Markup |
|---|
| scrollbar |
| Table of Contents |
|---|
Quick-start Guide for Adding an External Module in FEWS
This quick-start guide serves as an example processes for setting up an external module to run in FEWS. It includes the main tasks required to successfully implement any external module, but is in no way fully comprehensive for all modules. As every module is unique, more specific aspects may be required. There are wiki pages for Delft-FEWS Model adapters by Deltares supported by Deltares and there is an overview of Models linked to Delft-Fews.
These steps do not necessarily need to be performed in the order presented.
...
Examples of the generalAdapter for several module adapters can be found here: Delft-FEWS Model adapters by Deltares
2. Add the generalAdapter to the moduleInstanceDescriptors.xml file
...
External modules in FEWS are structured in the following way:
| Code Block | |||||
|---|---|---|---|---|---|
| |||||
%REGION_HOME%/Modules/ bin
/ adapter_bin
/ module_directory Note: The module directory should be defined in with a moduleInstanceId
|
The module_directory/ may be configured in a variety of ways depending on the module structure. Here is an example:
| Code Block | |||||
|---|---|---|---|---|---|
| |||||
module_directory / input Data from FEWS as input to the module
/ output Data from the module as export to FEWS
/ states States to be passed between FEWS and the module
/ diagnostics Directory in which diagnostic files from the FEWS pre-and post adapters are written
/ workDir Directory in which module is run, including
- static input files not passed by FEWS, such as bathymetry, observation points, etc.
- model definition template file
|
...