Changes between Version 19 and Version 20 of Configuration

Timestamp:

02/20/14 14:17:48 (11 years ago)

Author:

jorisborgdorff

Comment:

--

Configuration

@@ -29 +29 @@
 If the conduit entrance and exit have the same name, the second argument of {{{tie}}} is optional.
 
-=== Native code ===
+=== Non-Java instances ===
 
-For native executables that uses the MUSCLE API, the following parameters may be set: {{{"submodelName:command"}}} to set the path to the executable; and {{{"submodelName:args"}}} to give additional command-line parameters to the executable. Suppose my executable is somewhere in my home {{{bin}}} directory, this could be
+For non-Java instances that use the MUSCLE API, the Ruby classes `NativeInstance` (any executable binary), `PythonInstance` (Python script), `MPIInstance` (executable binary using MPI), and `MatlabInstance` (Matlab script) may be used. The first argument is the instance name, the second is the executable or script. After that, a number of optional arguments may be provided:
+||= Parameter =||= Meaning =||= Example =||= Recognized by class =||
+|| `args` || Arguments to the script or executable || `'param1 param2'` || All ||
+|| `java_class` || Custom Java subclass of NativeKernel || `'uni.dep.MyKernel'` || All ||
+|| `mpiexec` || Command to run MPI || `mpiexec`|| `MPIInstance` ||
+|| `mpiexec_args` || Arguments to MPI executor || `-np 4`|| `MPIInstance` ||
+|| `matlab`|| `Command to run Matlab` || `/opt/bin/matlab` || `MatlabInstance` ||
+|| `matab_args` || `Arguments to Matlab` || `-matlab_arg1 -matlab_arg2` || `MatlabInstance ||
+|| `python` || `Command to run Python` || `/opt/bin/python` || `PythonInstance` ||
+
+The optional arguments are specified by stating the parameter, a colon, and the parameter value. For a normal executable, for example:
 {{{
-subA["command"] = ENV['HOME'] + "/bin/subA"
-subA["args"] = "paramA paramB"
+w = NativeInstance.new('w', '/path/to/w')
+}}}
+to provide arguments and a Java class, state
+{{{
+w = NativeInstance.new('w', '/path/to/w', args: 'param1 param2', java_class: 'uni.dep.MyNativeKernel')
 }}}
 
-For MPI code, two additional parameters should be set: {{{"mpiexec_command"}}} with the name or the path the the mpiexec/mpirun executable; and {{{"mpiexec_args"}}} which are the arguments, like "-np 2", etc.
+Equivalently, to specify a MPI executable to run with four cores under the `mpiexec` command, use:
+{{{
+w = MPIInstance.new('w', '/path/to/w', mpiexec_args: '-np 4')
+}}}
 
-
+For Python:
+{{{
+w = PythonInstance('w', 'myscript.py')
+}}}
 === Filters ===