...
General questions to ask are:a)
- What input data is required?
- What, if any, of this input data must be provided by FEWS?
This includes time series data, gridded data, restart files, and additional parameters required by the module.
- What, if any, of this input data must be provided by FEWS?
...
- What is the desired output?
- What, if any, of this data must be viewable/used by FEWS?
This includes time series data, gridded data, and restart files.
- What, if any, of this data must be viewable/used by FEWS?
...
- Over what period should the model run?
- As a hindcast, as a forecast, from a warm state and from a cold state?
This is specified in the relativeViewPeriod.
- As a hindcast, as a forecast, from a warm state and from a cold state?
...
- How does the model software work and what model definition files are required as input?
...
- How is the model grid defined?
Examples of the generalAdapter for several module adapters can be found here: Module adapters
2. Add the
...
generalAdapter to the moduleInstanceDescriptors.xml file
Note: as of FEWS version 2014.01 specification of the moduleID is not <moduleId> is no longer required.
More information about moduleInstanceDescriptors can be found here: ModuleInstanceDescriptors
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
%REGION_HOME%/Modules/"ModuleInstanceID" / bin / adapter_bin / module_directory Note: The module directory should havebe thedefined samein name as the correspondingwith 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 / input bathymetry files, observation points files, etc. not passed by FEWS - static input files not passed by FEWS, such as bathymetry, observation points, etc. / model definition template file / diagnostic- filemodel ofdefinition thetemplate modulefile |
4. 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.
5. Create a cold state file if necessary
...
6. Define the module grid in the grids.xml file
More information about grid definitions can be found here: Grids
7. Define the module locations using the locationSets.xml and locations.xml files
...
8. Create a workflow to run the module
More information about workflows can be found here: Configuring WorkFlows
9. Add the workflow to the workflowDescriptors.xml file
More information about workflowDescriptors can be found here: WorkflowDescriptors
10. 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.
...
- 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.