...
More information can be found here: ModuleInstanceDescriptors
3. Create an IdMapFile for the generalAdapterRun
In the IdMapFile all parameters and locations must be mapped between the internal FEWS name and external module name. If both FEWS and the module use the same parameter and location names (case sensitive) then the EnableOneToOneMapping function can be used instead.
4. Define the file structure of the module in FEWS
External modules in FEWS are structured in the following way:
...
| 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
|
...
5. Create a moduleDataSet file
Copy the module directory to a zipped directory named the same as the moduleInstanceId. Place the zipped directory in the %REGION_HOME%/config/moduleDataSets directory.
...
6. Add the moduleDataSet file to the moduleInstanceDescriptors.xml file
Note: as of FEWS version 2014.01 specification of the <moduleId> is no longer required.
More information can be found here: ModuleInstanceDescriptors\
...
7. Create a cold state file if necessary
Copy this file to the %REGION_HOME%/conifg/ColdStates directory
...
8. Define the module grid in the grids.xml file
More information can be found here: Grids
...
9. Define the module locations using the locationSets.xml and locations.xml files
More information about locations and locationSets can be found here: Regional Configuration
...
10. Create a workflow to run the module
More information can be found here: Configuring WorkFlows
...
11. Add the workflow to the workflowDescriptors.xml file
More information can be found here: WorkflowDescriptors
...
12. Refresh your configuration and run the module workflow using the Manual Forecast function in the FEWS Explorer
Hit F5 in FEWS to refresh the configuration.
...
13. Troubleshooting tips
It is possible that a module will run correctly on the first try. First step is to make sure the model runs ok outside of the configuration.
...
- When you have selected the appropriate workflow in the Manual Forecast tab
- Press ctr+r to select specific module instances within a workflow.
- Press ctr+d to activiate debug mode for specific module instances within a workflow. FEWS will then display additional de-bugging information in the log window.
- General Adapter
- Run only certain activities (i.e. only data export) by commenting out unwanted activities in the generalAdapter.
You make a comment by putting the text between <!-- and - ->, or in XMLSpy press ctrl-k when you have selected the text. - Reduce the relativeViewPeriod within the generalAdapter to shorten run times for de-bugging purposes.
- Run only certain activities (i.e. only data export) by commenting out unwanted activities in the generalAdapter.
- The F12 menu contains many tools that may be helpful in examining data, data conversion, and data export.
Open this menu by pressing F12 when you have the focon the Logs window or the Map tab.- Database Viewer (F12 menu, Option J): to view all data imported by FEWS from the module.