Versions Compared

Old Version 9

changes.mady.by.user Simone De Kleermaeker

Saved on

compared with

New Version Current

changes.mady.by.user Simone De Kleermaeker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
  • 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
    Split out files, e
      • .
    g.
    • DisplayConfigFiles
      • GridDisplay.xml
    • RegionConfigFiles 
      • Filters.xml
      • LocationSets.xml
      • Topology.xml
      • WorkflowDescriptors.xml
    • SystemConfigFiles
      • DisplayGroups.xml
  •  WorkflowConfigFiles\ WorkflowConfigFiles:
    • CamelCase, underscores between components
    • Examples: Import_Gfs.xml
    • Subfolders postscript _WF (e.g. Import_WF)

...

Config file set per model 

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
  • RegionConfigFiles\
    • Filter_<Model>.xml
    • LocationSets_<Model>.xml
    • ModuleInstanceDescriptors_<Model>.xml
    • WorkflowDescriptors_<Model>.xml
  • SystemConfigFiles\
    • DisplayGroup_<Model>.xml
  • WorkflowConfigFiles\
    •  <Model>_WF\
      • Run_<Model>_Template.xml

Default Config files

See Distribute via Deltares' repos:

...