= !OverSim Installation Instructions for Mac OS X=

These instructions show you how to install !OverSim on Mac OS X 10.6 (Snow Leopard) to 10.8 (Mountain Lion):

0. Installing X11 (Mountain Lion only)
--------------------------------------
OS X 10.8 (Mountain Lion) does not bundle required X11 anymore, so some extra work is needed here. If you are using Snow Leopard or Lion, you can skip to step 1 (Installing OmNET++)
* Download and install: http://xquartz.macosforge.org/landing/
* Open a terminal and enter: cd /usr/include; sudo ln -s /opt/X11/include/X11

1. Installing OmNET++
==================
* Install OmNET++ by the official OmNET++ instructions for OS X.
* Note: If you use Mountain Lion, just follow the Lion instruction. You should be fine since you installed X11 in Step 0.

2. Installing GMP
=================
After completing step 1 you have the required command line tools like g++.  Additionally, the gmp library is required for building Oversim. There are several package managers which let you install it, you can choose either: Fink, MacPorts, Homebrew should all be fine. Personally, I use Homebrew, it's lightweight and awesome. If you are unsure, just follow the instructions.

* Open a terminal and copy / paste the following line into it
** ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
** Enter your admin password if needed 
* If this did not work, visit http://mxcl.github.com/homebrew/ for up-to-date Homebrew install instructions
* Enter 'brew install gmp'


1. Requirements for OMNeT++ and !OverSim:
    * For Linux:
      * [http://tcl.sourceforge.net/ Tcl/Tk with BLT] and [http://gmplib.org/ libgmp]
      * On Ubuntu you can install these packages with:
{{{
  sudo apt-get install tk-dev blt-dev libgmp-dev
}}}
    * For Mac OS X 10.5
      * [http://developer.apple.com/TOOLS/xcode/ Xcode 3.x] and [http://www.finkproject.org/ Fink (includes libgmp)]
      * After installation of Fink open a terminal and install libgmp with:
{{{
  sudo apt-get install libgmp3-dev
}}}
    * For Windows: Everything you need is already included in the OMNeT++ 4.2.2 package.

2. Download OMNeT++ 4.2.2 ([http://www.omnetpp.org/omnetpp/doc_download/2245-omnet-422-source--ide-tgz Linux/Mac] or [http://www.omnetpp.org/omnetpp/doc_download/2246-omnet-422-win32-source--ide--mingw-zip Windows] version) from http://www.omnetpp.org/ after reading the [http://www.omnetpp.org/home/license License]

3a. (!Linux/Mac only): Create a new directory (in the following we assume you want to install OMNeT++ and !OverSim to ~/sim/) and extract OMNeT++:
{{{
  mkdir ~/sim
  cd ~/sim
  tar xzvf ~/Downloads/omnetpp-4.2.2-src.tgz
}}}

3b. (Windows only): Extract the OMNeT++ archive to a new directory (e.g. C:\sim\omnetpp-4.2.2) and double click on {{{mingwenv.cmd}}}

4. (!Linux/Mac only): Add the following lines to your .bashrc or .profile:
{{{
  export PATH=~/sim/omnetpp-4.2.2/bin:$PATH
}}}

5. Compile OMNeT++ (no need to change the directoy on Windows):
{{{
  cd ~/sim/omnetpp-4.2.2
  ./configure
  make
}}}

6. Download the INET framework [http://omnetpp.org/download/contrib/models/inet-20111118-src.tgz inet-20111118-src.tgz] and extract in next to your OMNeT++ installation:
{{{
  cd ~/sim
  tar xzvf ~/Downloads/inet-20111118-src.tgz
}}}

8. Compile the INET framework:
{{{
  cd ~/sim/inet
  make makefiles
  make
}}}

9. Download the latest !OverSim snapshot [http://www.oversim.org/chrome/site/OverSim-20121206.tgz OverSim-20121206.tgz] and extract in next to your OMNeT++ installation:
{{{
  cd ~/sim
  tar xzvf ~/Downloads/OverSim-20121206.tgz
}}}

10. Compile !OverSim (for ReaSE support read the following [wiki:OverSimReaSE instructions]):
{{{
  cd ~/sim/OverSim
  make makefiles
  make
}}}

Congratulations - now you should have a working !OverSim installation!  For instructions how to use !OverSim look at OverSimUsage.

== How to use Eclipse to compile !OverSim ==
 
You can also use the included ''Eclipse IDE'' to compile !OverSim:
  * Start Eclipse with ''omnetpp''
  * Create a new workspace by choosing a new workspace directory on Eclipse startup
  * ''File''->''Import''->''General''->''Existing Projects into Workspace''->''Next''->select the ''inet'' directory->''Finish''
  * Repeat the same steps for the !OverSim project
  * The build process should start automatically - if not, hit ''Ctrl->B''

== How to build !OverSim for a simulation machine or embedded device without X11 ==

  * You don't have to install !Tcl/Tk, if you only need ''Cmdenv''. Add the following option to ''omnetpp-4.2.2/configure.user'':
{{{
  NO_TCL=true
}}}
  * Use "make MODE=release" to compile INET and !OverSim for optimized binaries without debug information.