= OverSim Usage =

== First steps with OverSim: ==

 * change into directory {{{OverSim-20090320/simulations}}}

 * start !OverSim by typing
{{{
../src/OverSim
}}}

 * choose a simulation scenario (e.g. ''Chord'')

 * Select ''Options->Simulation Options->Animation'' and disable ''Animate method calls'' to speedup simulations

 * press the ''Run'' button in OMNeT++'s main window

 * ... watch & enjoy ...

 * press the ''Stop'' button to pause simulation

 * end !OverSim by closing OMNeT++'s main window[[BR]]
 (press ''Yes'' to invoke {{{finish()}}}-method call in all OMNeT++ modules)

 * If you want to simulate large networks like the predefined simulation scenario ''!ChordLarge'' invoke !OverSim without GUI:
{{{
../src/OverSim -uCmdenv -cChordLarge
}}}

 * The simulation results get stored in the ''simulations/results'' directory. Use the OMNeT++ scavetool or the Eclipse IDE for postprocessing.

== Editing parameters: ==

 * edit {{{simulations/omnetpp.ini}}} to change or define new simulation scenarios[[BR]]
 (default parameters are stored in {{{simulations/default.ini}}}, parameters are described on the
 [/chrome/site/doc/index.html NEDdoc-pages])

== Tips for using the Eclipse IDE ==

 * Start the IDE with ''omnetpp''

 * To start simulations from Eclipse, select ''!OverSim'' in the project explorer,[[BR]]
   click on ''Run simulations'' and select simulations/omnetpp.ini

 * To view simulation results, use the project explorer and double click[[BR]]
   on a .sca file in the ''simulations/results'' directory

 * Set the !OverSim coding style in ''Preferences'' by importing[[BR]]
   the style from ''doc/EclipseOverSimCodeStyle.xml''