Defining Wrappers for Executable Modules

Setting-Up Wrappers

For Tosca modules, the syntax is:

    driver.Modules[ ToscaModules.<module_name> ].Wrapper = [ <comma separated list of string arguments> ]
  

For the solver the syntax is:

    driver.Solver.Wrapper = [ <comma-separated list of string arguments> ]
  

Example of overriding the ToscaOpt-call:

    DRIVER
      driver.Modules[ ToscaModules.tosca_opt ].Wrapper = [ r'E:\scratch\myScript.bat', '-arg1', 'value1', '-arg2', value2' ]
    END_
  

The Python driver executes the given command-line by appending the command-line of the corresponding module. Here is how the call for the last example would look like:

    (INFO ) [tosca_driver] E:\scratch\myScript.bat -arg1 value1 -arg2 value2 C:\N3V418\win_b64\code\bin\SMATsoToscaOpt --distribution --loglevel INFO
  

Both command-lines are concatenated with only a space as a separator.

Techniques and Best Practices

It is recommended for Windows path specifications to always use the Python raw string format with no escape characters:

    r'E:\windows_path'
  

If a command-line argument list is about to be used more than once it is advisable to put the arguments into a separate variable and reuse it for the assignments:

    DRIVER
      toolCmdLine = [ r'E:\scratch\scripts\myScript.bat', '-arg1', 'value1', '-arg2', 'value2' ]
      driver.Modules[ ToscaModules.tosca_prep ].Wrapper = toolCmdLine
      driver.Modules[ ToscaModules.tosca_opt  ].Wrapper = toolCmdLine
    END_
  

Assigning the same tool to all the modules can be done using the Tosca module-enumerable rather than listing each module separately:

    DRIVER
      toolCmdLine = [ r'E:\scratch\scripts\myScript.bat', '-arg1', 'value1', '-arg2', 'value2' ]
      for module in ToscaModules.all():
        driver.Modules[ module ].Wrapper = toolCmdLine
    END_