= FEP Simulator Installation Instructions =

The purpose of this document is to walk a developer through setting up / installing the FEPSimulator in the TMC Simulation room. \\
The FEPSimulator runs persistently on the linux VM and awaits messages (over a socket) from the ATMSDriver, and makes rpc calls to the ATMS Server using the message data. \\
See FEP Simulator documentation for more details (not written yet).

== Step 1: SSH into the linux VM ==
In a terminal, run: \\ 
{{{
    $ ssh <username>@192.168.251.46
}}} 
\\ to ssh into the linux VM.

== Step 2: Check out the FEPSimulator repository ==
To check out the FEPSimulator repository, use an svn checkout.

In your terminal, run:  \\
{{{
    $ cd && svn co svn+ssh://<username>@git.tokomak.net/svn/tmcsimulator/branches/FEPSimulator
}}}

This will checkout the FEPSimulator into your home user directory.

== Step 3: Build the FEPSimulator project ==
In your terminal, run:
{{{
    $ cd FEPSimulator/ && make
}}}

== Step 4: run the ./runFEPSim bash script ==
To start the FEPSimulator, you will need to run the ./runFEPSim bash script, located in the FEPSimulator/ repository. \\

In your terminal, run: \\
{{{
    $ ./runFEPSim
}}}

== Thats it! ==


== Note to Developers ==
If you are working on the FEPSimulator code, it is dependent on the tinyxml static library to parse the message sent from the ATMSDriver. \\
The library files are included in the repo @ FEPSimulator/tinyxml \\
The project is configured to link the linux static library file, a file named "tinyxml.a". (Because in production it runs on linux VM) \\
Also included in the tinyxml/ folder is a static library file for osx operating systems, a file named "libosxtinyxml.a" \\
If you are on another operating system, create a new Netbeans Static C++ library application, add the tinyxml files located in FEPSimulator/tinyxml/ and run to create the static library for your operating system. \\
To link the correct library file for your os, in Netbeans, right click your project > Properties > Linker > Libraries > Add Library File... > Select the appropriate static library file. \\