Index: doc/bmi2runner.rst =================================================================== diff -u -rbf9f777e9931a17ea97547f2c9820318f3dfedd1 -rfa7b6e5a5c7688790fc4765a09b30d3108e2df4a --- doc/bmi2runner.rst (.../bmi2runner.rst) (revision bf9f777e9931a17ea97547f2c9820318f3dfedd1) +++ doc/bmi2runner.rst (.../bmi2runner.rst) (revision fa7b6e5a5c7688790fc4765a09b30d3108e2df4a) @@ -8,20 +8,20 @@ is used to control the exchange of data between the models. The config file contains a list of models configured as the name of the wflow module and the ini file that is used -by the model. Furthermore, in the exchanges section the data flows from model to model are configures. +by the model. Furthermore, in the exchanges section the data flows from model to model are configured. :: [models] - # moduel name = path to config of module relative to the dir of this ini file + # module name = path to config of module relative to the dir of this ini file wflow_sbm=wflow_sbm/wflow_sbm_comb.ini wflow_routing=wflow_routing/wflow_routing_comb.ini [exchanges] # From_model/var -> To_model/var wflow_sbm@InwaterMM=wflow_routing@IW -To setup a combined model the you shoudl first configure and setup the individual models. They can be setup in separate -case directories or they can be setup in one case directory. Each model should have it's onw config/ini files. +To setup a combined model the you should first configure and setup the individual models. They can be setup in separate +case directories or they can be merged in one case directory. Each model should have it's own config/ini file. + the models are executed in the order they are listed in the models section + the variables are get/set in the order they appear in the exchanges section @@ -30,15 +30,38 @@ Example ------- -In the examples directory the file bmirunner.ini is present. You can use this to run a combiend wflow_sbm/wflow_routing +In the examples directory the file bmirunner.ini is present. You can use this to run a combined wflow_sbm/wflow_routing model. Start this up using the following command (in the examples dir): :: bmi2runner.py -c bmirunner.ini +A second example runs wflow_sbm next wflow_routing followed by the wflow_floodmap module: +:: + + bmi2runner.py -c bmirunner-floodmap.ini + +The contents of the ini file (bmirunner-floodmap.ini) is given below: + +:: + + [models] + wflow_sbm=wflow_rhine_sbm/wflow_sbm.ini + wflow_routing=wflow_routing/wflow_routing_BMI.ini + wflow_floodmap=wflow_routing/wflow_floodmap_BMI.ini + + [exchanges] + # From_model.var -> To_model.var + wflow_sbm@InwaterMM=wflow_routing@IW + wflow_routing@WaterLevel=wflow_floodmap@H + +In this case the floodmap module uses the same directory as the routing module (but a different config file). + + + bmi2runner script -----------------