For now, see: FEWS-Conform/documentation/conventions.md at main · Deltares/FEWS-Conform

All other content on this page will be migrated there soon.

Configuration guidelines and naming conventions

Default Config files

Distribute via Deltares' repos:

And in future also:

DisplayConfigFiles\

IconFiles\

  • location Icons

IdMapFiles\

(wiki: 01 ID Mapping)

  • IdMapFromGfs.xml
  • IdMapFromObserved.xml

MapLayerFiles\

(wiki: 22 Locations and attributes defined in CSV files, Shape-DBF files or external tables)

  • 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

ModuleDataSetFiles\

PiServiceConfigFiles\

RegionConfigFiles\

RootConfigFiles\

  • sa_global.properties
  • sa_clientConfig.xml

SystemConfigFiles\

UnitConversionFiles\

WorkflowFiles\

  • Archive_WF\
    • ?
  • Export_WF\
    • ?
  • Import_WF\
    • Import_Gfs.xml
    • Import_Observed.xml

Installation / Folder structure

  • Install the Delft-FEWS binaries in a folder separate from your (Stand Alone) application. This makes it easier to upgrade to a new version, or switch between software versions when testing.
    • <>\FEWS_202x.0x\
      • Delft-FEWS binaries (inside \bin folder)
    • <>\FEWS_Applications\<ApplicationName>_SA\
      • Delft-FEWS application, aka "RegionHome"
      • You can later create your OC in this same FEWS_Applications folder
  • run \FEWS_202x.0x\bin\windows\createShortcuts.exe
    • This application is used to create shortcuts, which link the software ("bin\") to the “RegionHome”.
      • Select "Path to Stand Alone or Operator Client *clientConfig.xml"
      • Click "Browse..." and navigate to “RegionHome”, select the "sa_clientConfig.xml" file there
      • Check "Create Shortcuts At" > "RegionHome“ to create a shortcut in the RegionHome folder
      • Click “Create Shortcuts” and close the application
    • The shortcut “Region Home”\FEWS_<ApplicationName>_SA.lnk can be used to start the application (using the binaries in FEWS 202x.0x\)
    • Optional:
      • Open the properties of this shortcut (right click > Properties), and change the following:
        • Target: <>\FEWS_202x.0x\bin\windows\Delft-FEWS.exe -Dregion.home=.
        • Start in: <empty>
      • Rename the shortcut to Delft-FEWS_202x.0x.lnk
      • Copy this shortcut to <>\FEWS_202x.0x\ so you can reuse it with other SA applications
        This shortcut is now only pointing to the Delft-FEWS binaries, and is no longer specific to the RegionHome.
        As a result, you can only use it from the RegionHome

  • When a new version of Delft-FEWS becomes available, just add a shortcut pointing to this new version. 
    => You no longer need multiple copies of the application to be able to switch between Delft-FEWS versions!




  • No labels

Disclaimer