Table of Contents |
---|
...
Configuration guidelines and naming conventions
- CamelCase,
- no exceptions
- Not even if the brand name uses all caps, e.g. GFS
- Split out config files where possible, e.g.
- DisplayConfigFiles
- GridDisplay.xml
- RegionConfigFiles
- Filters.xml
- LocationSets.xml
- Topology.xml
- WorkflowDescriptors.xml
- SystemConfigFiles
- DisplayGroups.xml
- DisplayConfigFiles
- The code is the doc
- add comments at the top of a config file to (succinctly) describe what the file does
- Don't use the <description> element if your just copying the content of the <name> element
- MapLayerFiles\MapLayerFiles
- Use attributes and templates
- Use the attributeId from Delft-FEWS as the column header
- CamelCase
- attributeIds need to be unique, so think ahead
- ModuleConfigFiles\
- CamelCase, no underscores between components
- <Action><Topic>Template.xml
- Example: ImportGfs.xml
- Subfolders postscript _MC (e.g. Import_MC)
- RegionConfigFiles\
- List things alphabetically when there is no impact on the GUI, e.g.
- ModuleInstanceDescriptors.xml
- WorkflowDescriptors.xml
- List things alphabetically when there is no impact on the GUI, e.g.
- Split out files, e.g.
- DisplayConfigFiles
- GridDisplay.xml
- RegionConfigFiles
- Filters.xml
- LocationSets.xml
- Topology.xml
- WorkflowDescriptors.xml
- SystemConfigFiles
- DisplayGroups.xml
- DisplayConfigFiles
- WorkflowConfigFiles\ WorkflowConfigFiles:
- CamelCase, underscores between components
- Examples: Import_Gfs.xml
- Subfolders postscript _WF (e.g. Import_WF)
...
Distribute via wiki of the ModelAdapter (wiki:
...
Make sure the set is complete (making use of the Default Config Files, such as Parameters.xml):
- DisplayConfigFiles\
- GridDisplay_<Model>.xml
- MapLayerFiles\
- <Model>Locations.csv
- ModuleConfigFiles\
- <Model>_MC\
- Preprocessing: Prep<Model>Template.xml
- GeneralAdapter: Run<Model>Template.xml
- Postprocessing: Post<Model>Template.xml
- <Model>_MC\
- RegionConfigFiles\
- Filter_<Model>.xml
- LocationSets_<Model>.xml
- ModuleInstanceDescriptors_<Model>.xml
- WorkflowDescriptors_<Model>.xml
- SystemConfigFiles\
- DisplayGroup_<Model>.xml
- WorkflowConfigFiles\
- <Model>_WF\
- Run_<Model>_Template.xml
- <Model>_WF\
Default Config files
See Distribute via Deltares' repos:
And in future also:
- https://repos.deltares.nl/repos/FEWS_Accelerator/Templates/
- https://repos.deltares.nl/repos/FEWS-Courses/Config_Basic_2023.02/FEWS_application/
DisplayConfigFiles\
- ManualForecastDisplay (wiki: 13 Manual Forecast Display)
- GridDisplay.xml (wiki: 01 Grid Display)
- SystemMonitorDisplay (wiki: 06 System Monitor Display)
- WebBrowserDisplay (wiki: 24 Web Browser Display)
...
- Locations.csv
- LocationsAttribute.csv
- Models.csv
- Grids.csv
- Background\
- ...
ModuleConfigFiles\
- Archive_MC\
- ?
- Export_MC\
- ?
- Import_MC\
- Import<AustralianProducts>.xml
- ImportGfs.xml
- ProcessGfs.xml
- ImportObserved.xml
- ProcessObserved.xml
- Maintenance_MC\
- UpdateModelBinaries.xml
- Amalgamate_daily.xml
- Amalgamate etc
...
- ImportUnitConversions (wiki: 02 Unit Conversions)
WorkflowFiles\
- Archive_WF\
- ?
- Export_WF\
- ?
- Import_WF\
- Import_Gfs.xml
- Import_Observed.xml
...