source: vis_dev/vis-2.1/share/help/simulateCmd.txt @ 11

Last change on this file since 11 was 11, checked in by cecile, 13 years ago

Add vis
File size: 5.2 KB
Line 
1
2  simulate - simulate the flattened network
3     _________________________________________________________________
4
5   simulate  [ -I <0/1> ] [ -O <0/1> ] [ -P <0/1> ] [ -S <0/1> ] [ -h ] [
6   -i  <vectors_file> ] [ -n <vectors_number> ] [ -o <output_file> ] [ -p
7   <0|1> ] [ -v ]
8
9   Simulates  a  network with a set of input vectors. Before calling this
10   command,  the  user  should  create  a  partition  (using  the command
11   build_partition_mdds).  The  simulation vectors can be provided by the
12   user (using -i vectors_file), or generated randomly.
13
14   Command options:
15
16   -I <0/1>
17          This  option controls the printing the primary input variables.
18          0  implies printing is disabled, enabled otherwise. The default
19          value  is  1. The output file generated with this flag set to 0
20          may not be used as input file for simulation (if there are some
21          primary inputs to the system).
22
23   -O <0/1>
24          This option controls the printing the primary output variables.
25          0  implies printing is disabled, enabled otherwise. The default
26          value is 1.
27
28   -P <0/1>
29          This option controls the printing the pseudo input variables. 0
30          implies  printing  is  disabled, enabled otherwise. The default
31          value  is  1. The output file generated with this flag set to 0
32          may not be used as input file for simulation (if there are some
33          pseudo-inputs to the system).
34
35   -S <0/1>
36          This  option  controls  the  printing  the  state  variables. 0
37          implies  printing  is  disabled, enabled otherwise. The default
38          value is 1.
39
40   -h
41          Print a help message that details all options.
42
43   -i <vectors_file>
44          Give  the  simulation  vector  file name. If this option is not
45          used, vectors are generated randomly.
46
47   -n <N>
48          Simulate  N vectors. This option should be used if vectors_file
49          is  not specified. If a vectors_file is given, and if there are
50          more  than  N vectors in the file, only the first N vectors are
51          simulated.
52
53   -o <output_file>
54          Give  the  name of a file where the simulation result should be
55          written.  If  this option is not used, the simulation result is
56          directed to standard output.
57
58   -p <0|1|2>
59          This  option  is  available  only with random vector generation
60          mode,    and    affects    how    values    for   pseudo-inputs
61          (non-deterministic  constants)  are generated. 0: pseudo-inputs
62          are  treated by user. 1: pseudo-inputs are treated randomly. 2:
63          pseudo-inputs are treated by choosing the first possibility.
64
65   -v
66          Enable verbose mode. Prints CPU time usage.
67
68   The vectors_file has two main parts:
69
70   Declarations:
71
72        Inputs list:
73                Gives an ordering of the primary and pseudo inputs. Every
74                input must be reported in this field.
75
76        Latches list:
77                Gives  an  ordering  of  the latches. Every latch must be
78                reported in this field.
79
80        Outputs list:
81                Gives  an  ordering  of  the  outputs.  This  list may be
82                incomplete.  Simulation  is  performed  only  on  outputs
83                present in this list.
84
85        Initial state:
86                Value  of  an  initial  state.  This  value is given with
87                respect to the latch ordering.
88
89   Simulation Vectors:
90          One vector per line according to the given order of inputs.
91
92   Final State:
93          Prints  the  value of state variables after the last simulation
94          vector is applied.
95
96   An example of a simulation vectors file is:
97   # ----> Declarations
98       .inputs X1 X2
99       .latches L1 L2
100       .outputs O
101       .initial green 0
102       .start_vectors
103       # ----> Vectors
104       0 1
105       1 0
106       1 1
107
108   Note    the   keywords:   .inputs,   .latches,   .outputs,   .initial,
109   .start_vectors. A line started by a '#' is a comment line.
110
111   The   simulation  result  is  printed  either  in  a  file  (using  -o
112   output_file)  or  to  standard  output.  It  has  the  same  format as
113   vectors_file  with  additional fields for latches and outputs. Here is
114   the result of simulation on last vectors_file example:
115   .inputs X1 X2
116       .latches L1 L2
117       .outputs O
118       .initial green 0
119       .start_vectors
120       #input; current_state; output
121       0 1 ; green 0 ; 0
122       1 0 ; blue 0 ; 1
123       1 1 ; red 1 ; 1
124       #Final State : green 1
125
126   Note  that  each input line has been extended by its simulation result
127   with  current  states and outputs listed in order. The output_file can
128   be  read  by  simulate as vectors_file (latches and outputs values are
129   ignored).  When  starting  simulation  a good trick is to run simulate
130   with  random  vectors  generation mode; the resulting can be used as a
131   template  to write a vectors_file. For example, executing "simulate -n
132   1 -o foo.output" will generate a representative file.
133     _________________________________________________________________
134
135   Last updated on 20050519 10h16
Note: See TracBrowser for help on using the repository browser.