Versions Compared

Old Version 1

changes.mady.by.user Bart Adriaanse

Saved on

compared with

New Version Current

changes.mady.by.user Bart Adriaanse

Saved on

Key

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

...

  • key - ribasimVersion : the ribasim version used; versions 6  and 7 supported
  • key - tmsUnit : the base unit to use by RIBASIM; 1 = m3/s, 2 = mm/day, 3 = mm/tms, 4 = ppt (when not specified, the default is m3/sthis is determined from the first input)
  • key - tmsHeader :  the full path of a custom TMS file header to use by the pre-adapter (optional)
  • key - simulationTimestep : the RIBASIM time step to use, supported are DAY, MONTH, HALFMONTH, DECADE, WEEK
  • key - stateExportDir : the directory where FEWS exports and imports the RIBASIM state file (when not specified, the folder containing the InputStateDescriptionFile is used)
  • key - stateFile : the filename of the statefile used by RIBASIM (when not specified it will have the same name as given in the InputStateDescriptionFile)
  • key - runsimpFile : the full path of the control file for RIBASIM (when not specified, runsimp.dat will be created in the working folder)
  • key - runsimpTemplate : the full path of the control file template (when not specified, no "runsimp" control file will be created)
  • key - orderByQualifier columnIndexByQualifier : when true, the input time series can be provided with a qualifier (integer) per location to set both the order and header of the columns in the generated TMS file.
  • key - locationsIndexed  skipMissingInputs : when true, the output HIS files will be converted to PI-XML using location ID (index) instead of location namesadapter will skip missing timeseries input files, when false an error will be logged for if input files specified in runinfo config are missing.

As an example General Adapter configuration is not available yet at this time, an example PI runInfo XML file from one of the adapter unit tests is given here:

...

As the RIBASIM model consists of several executable programs that need to be executed in a specific sequence, several executa activities nee3d to be configured, including the executation of the Pre- and/or Post Adapter. An example GeneralAdapter config to illustrate this was not yate available at the time of writing this page.

ImportActivities Section

`The The import activities as configured will be reflected in the RunInfo xml file eported by the General Adapter as input for the Post-Adapter, see the above example.

TMS file versions

Hydrological timeseries are input in RBASIM using the TMS file format, for which 2 versions have been implemented:

  • TMS 1.01 using RIBASIM time step information (used by RIBASIM 6 and earlier versions)
  • TMS 1.04 using Gregorian calendar (month, day) time information (used by TIBASIM 7 and later versions)

For RIBASIM 7 and later, an exception is for timeseries marked as non-equidistant, these will be converted to TMS 1.01 format, where all "regular" time series use the 1.04 format. Please note that you can have full control over the TMS format version used by using the tmsHeader option, providing your own header (first line of the file). More information is available in the RIBASIM documentation.



Example configuration

Example general adapter configuration file is to be attached 

...