!!Usage examples

!Get help

# SimTree help

%% Get list of commands

# SimTree help --simulation-parameter

%% Get help on the option --simulation-parameter

# SimTree add --help

%% Get help on the command add

# SimTree null --help

%% Get a list of all options

!Prepare the StudyRoot to be used by SimTree

# SimTree prepare

%% Prepare the study-root, max be called any time even in already prepared study-root

!Saving and loading SimTree configurations

# SimTree null --simulation-binary TandemFeedback --local-process-slots 4

%% Save name of simulation binary and number of local slots in default config

# SimTree null --save-config eval1 --result-path "q1 FinalResults:TandemModel:Meter2:TransferTime"

%% Save a query path in the configuration named eval1

# SimTree query --load-config eval1

%% Load the options saved in the configuration eval1 and perform query command

!List the current content of the results tree

# SimTree list

%% List the contents of the results tree

# SimTree list-visual

%% List the contents of the results tree in a graphical window

# SimTree list --simulation-parameter MsgLen 100

%% List part of results tree where MsgLen == 100

# SimTree list --simulation-parameter MsgLen 100 --simulation-parameter ServiceTime 1.0

%% List part of results tree where MdgLen == 100 and ServiceTime == 1.0

# SimTree list --simulation-parameter-path 100:1.0

%% The same as the previous example using a path of simulation parameters

!Add/Remove simulation parameters to the results tree

# SimTree add --simulation-parameter MsgLen int 100 200

%% Add simulation parameter MsgLen of type int with two values

# SimTree add --simulation-parameter ServiceTime float 1.0 2.0

%% Add a second parameter ServiceTime with two values for all values of MsgLen

# SimTree remove

%% Will do nothing, no simulation parameter values selected

# SimTree remove --simulation-parameter MsgLen 100 --simulation-parameter ServiceTime 2.0

%% Remove selected parameters, remove results first

# SimTree add --simulation-parameter-path 100 --simulation-parameter ServiceTime 4.0

%% Add value for ServiceTime for MsgLen 100, given by simulation parameter path

# SimTree remove --force-all-values

%% Remove all simulation parameters with all values, remove results first

!Run the simulation program to generate simulation results

# SimTree simulate --local-process-slots 4

%% Run simulation locally with 4 instances in parallel

# SimTree simulate --local-process-slots 4 --batches 10

%% Run simulation locally with 4 instances in parallel

# SimTree simulate --remote-process-slots cnode08 2 --remote-process-slots cnode09 2 --batches 10

%% Run simulation remotely on two different hosts with 2 instances on each host

# SimTree simulate --local-process-slots 4 --batches 1:5 2:5

%% Run 4 parallel simulation runs with 5 batches each

!Collect simulation results in final results

# SimTree collect

%% Collect results for all simulation parameter values

!Remove simulation results from the results tree

# SimTree clean

%% Will do nothing, no simulation parameter values selected

# SimTree clean --simulation-parameter MsgLen --simulation-parameter SericeTime 1.0

%% Remove results for the given simulation parameter values

# SimTree clean --force-all-values

%% Remove all results

!Dump result files

# SimTree dump

%% Dump the contents of all FinalResults

# SimTree dump-visual --sp MsgLen 1 --sp ServiceTime 1.0

%% Dump the contents of the FinalResults for MsgLen == 1 and ServiceTime == 1.0 in a grahical window

!Query results in the results tree

# SimTree query --result-path q1 "TandemModel:Meter2:TransferTime:cintcov"

%% Query FinalResults from all simulation parameter value sets for one statictic value

# SimTree query --result-path q1 "TandemModel"

%% Query FinalResults from all all statistic values inside the TandemModel

# SimTree query --simulation-parameter-path 100:1.0 --result-path q1 "TandemModel"

%% Query FinalResults for one simulation parameter value set

# SimTree query --result-path q1 "TandemModel:Meter2:TransferTime:cintcov" --batches 1:5

%% Query Result from batch 1,2,3,4,5 from seed 1

# SimTree query --result-path q1 "TandemModel:Meter2:TransferTime:cintcov" --batches 1:[1,3]

%% Query Result from batch 1 and 3 from seed 1

# SimTree query --result-path q1 "TandemModel:Meter2:TransferTime:cintcov" --batches [1,2]:[1,3]

%% Query Result from batch 1 and 3 from seed 1 and 2

# SimTree query --result-path q1 "TandemModel:Meter2:TransferTime:cintcov" --batches [1,2]:[1-3]

%% Query Result from batch 1 to 3 from seed 1 and 2

!Evaluate results in the results tree

# SimTree eval --column-definition 0 simulation-parameter ServiceTime --column-definition 1 result-path TandemModel:Meter2:TransferTime:mean

%% Print results for the simulation parameter ServiceTime with the given result path

# SimTree eval --cd 0 sp ServiceTime --cd 1 sp MsgLen --cd 2 rp TandemModel:Meter2:TransferTimeDist:pdf:.*:ubound

%% Print result for two simulation parameters with the given result path
