Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
software:coral:coralmaster [2017-06-01 13:00]
lars
software:coral:coralmaster [2018-05-16 07:08] (current)
lars Update for Coral 0.9.0
Line 1: Line 1:
 ====== coralmaster ====== ====== coralmaster ======
 <​code>​ <​code>​
-Execution master (Coral 0.8.0)+Execution master (Coral 0.9.0)
  
 This program will connect to the network and obtain information about This program will connect to the network and obtain information about
Line 10: Line 10:
  
 Commands: Commands:
-  info     Shows detailed information about one slave type +  info     Shows detailed information about one slave type. 
-  list     Lists available slave types +  list     Lists available slave types. 
-  ls-vars ​ Lists information about a slave type's variables +  ls-vars ​ Lists information about a slave type's variables. 
-  run    Runs a simulation+  run      Runs a simulation.
  
-Run <​command> ​without any additional arguments ​for more specific ​help.+Run "​coralmaster ​<​command> ​--help" ​for command-specific ​information.
 </​code>​ </​code>​
  
Line 26: Line 26:
  
 Arguments: Arguments:
-  slave-type ​         A slave type name+  slave-type ​         A slave type name.
  
 Options: Options:
Line 66: Line 66:
                                     one or more of the following characters:                                     one or more of the following characters:
                                     c=calculated parameter, i=input, l=local,                                     c=calculated parameter, i=input, l=local,
-                                    o=output, p=parameter+                                    o=output, p=parameter.
   --interface arg (=127.0.0.1) ​     The IP address or (OS-specific) name of the   --interface arg (=127.0.0.1) ​     The IP address or (OS-specific) name of the
                                     network interface to use for network                                     network interface to use for network
Line 77: Line 77:
   -t [ --type ] arg (=birs) ​        The data type(s) to include. ​ May contain   -t [ --type ] arg (=birs) ​        The data type(s) to include. ​ May contain
                                     one or more of the following characters:                                     one or more of the following characters:
-                                    b=boolean, i=integer, r=real, s=string+                                    b=boolean, i=integer, r=real, s=string.
   -v [ --variability ] arg (=cdftu) The variabilities to include. ​ May contain   -v [ --variability ] arg (=cdftu) The variabilities to include. ​ May contain
                                     one or more of the following characters:                                     one or more of the following characters:
                                     c=constant, d=discrete, f=fixed, t=tunable,                                     c=constant, d=discrete, f=fixed, t=tunable,
-                                    u=continuous+                                    u=continuous.
   --help ​                           Display a help message and exit.   --help ​                           Display a help message and exit.
 </​code>​ </​code>​
Line 93: Line 93:
  
 Arguments: Arguments:
-  exec-config ​        ​Configuration file which describes the simulation +  exec-config ​        ​Configuration file which describes the execution 
-                      settings (start time, step size, etc.)+                      settings (start time, step size, etc.).
   sys-config ​         Configuration file which describes the system to   sys-config ​         Configuration file which describes the system to
-                      simulate (slaves, connections,​ etc.)+                      simulate (slaves, connections,​ etc.).
  
  
Line 105: Line 105:
                                ​network interface to use for network                                ​network interface to use for network
                                ​communications,​ or "​*"​ for all/any.                                ​communications,​ or "​*"​ for all/any.
-  -n [ --name ] arg            The execution name (if left unspecified,​ a +  -n [ --name ] arg            The execution name.  If left unspecified,​ a name 
-                               timestamp ​will be used)+                               will be created based on the current date and 
 +                               time.
   --port arg (=10272) ​         The UDP port used to listen for slave providers.   --port arg (=10272) ​         The UDP port used to listen for slave providers.
   -r [ --realtime ] arg (=0)   ​Real-time multiplier, i.e., how fast the   -r [ --realtime ] arg (=0)   ​Real-time multiplier, i.e., how fast the
Line 113: Line 114:
                                ​should run in real time, while e.g. 2 means                                ​should run in real time, while e.g. 2 means
                                twice as fast.  The default is 0, which is a                                twice as fast.  The default is 0, which is a
-                               ​special value that means "as fast as possible"​ +                               ​special value that means "as fast as possible"​. 
-  -w [ --warnings ]            Enable warnings while parsing execution +  -w [ --warnings ]            Enable warnings while parsing ​configuration 
-                               ​configuration ​file+                               ​files. 
 +  --help-exec-config ​          ​Display a help message about the format of 
 +                               execution ​configuration files and exit. 
 +  --help-sys-config ​           Display a help message about the format of 
 +                               system ​configuration ​files and exit.
   --help ​                      ​Display a help message and exit.   --help ​                      ​Display a help message and exit.
 </​code>​ </​code>​
  • software/coral/coralmaster.txt
  • Last modified: 2018-05-16 07:08
  • by lars