Versions Compared

Key

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

...

Parameter

Description

Type

JflowExecutable

Full filepath of the JFlow executable, as installed on the host machine.

String

JflowDB

Name of the JFlow database, including file extension.            

The full filepath is not required if the module folder structure is maintained.

String

Device

Number of the GPU device, as machines may have multiple GPU cards.  Default is 0.

Integer

NumberFlowIDs

Number of flow boundaries.

Integer

FlowNames

Names of flow boundaries, separated by commas.

The name should match (1) the inflow ID in the JFlow model; and, (2) the external location ID of the xml timeseries exported from FEWS.  Any ID mapping takes place within FEWS.

String

NumberRainIDs

Number of rainfall inputs.

Integer

RainNames

Names of the rainfall inputs, separated by commas.

The name should match (1) the inflow ID in the JFlow model; and, (2) the external location ID of the xml timeseries exported from FEWS.  Any ID mapping takes place within FEWS.

String

OutputParameters

Output parameter types, separated by commas.  Commonly used options are: depth, hazard_index, velocity, water_level.

String

LocationID

LocationID that will be associated with the model results.

The value stated here should match the external ID in the FEWS ID mapping file.

String

 

Example .ini file:

...

Code Block
title.ini file
[General]

...


ModelName=Jflow_test_model

...


JflowExecutable=C:\Program Files\JFLOW\JFLOW.exe

...


JflowDB=jflow_test.accdb

...


Device=0

...


[End]

...


[Flow inputs]

...


NumberFlowIDs=3

...


FlowNames=Flow_1, Flow_2, Flow_3

...


[End]

...


[Rain inputs]

...


NumberRainIDs=0

...


RainNames=0

...


[End]

...


[Required outputs]

...


OutputParameters=depth

...


LocationID=Jflow_test_map

...


[End]

2.4         Notes on configuration

2.4.1       Module config file examples

The following sections contain examples of a module configuration file required to run JFlow through the JFlow adapter.  Notes for users are also given.

...