Changes between Initial Version and Version 1 of FEPSimulatorInstallation


Ignore:
Timestamp:
10/11/2017 04:24:55 PM (9 years ago)
Author:
jtorres
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FEPSimulatorInstallation

    v1 v1  
     1= FEP Simulator Installation Instructions = 
     2 
     3The purpose of this document is to walk a developer through setting up / installing the FEPSimulator in the TMC Simulation room. \\ 
     4The 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. \\ 
     5See FEP Simulator documentation for more details (not written yet). 
     6 
     7== Step 1: SSH into the linux VM == 
     8In a terminal, run: \\  
     9{{{ 
     10    $ ssh <username>@192.168.251.46 
     11}}}  
     12\\ to ssh into the linux VM. 
     13 
     14== Step 2: Check out the FEPSimulator repository == 
     15To check out the FEPSimulator repository, use an svn checkout. 
     16 
     17In your terminal, run:  \\ 
     18{{{ 
     19    $ cd && svn co svn+ssh://<username>@git.tokomak.net/svn/tmcsimulator/branches/FEPSimulator 
     20}}} 
     21 
     22This will checkout the FEPSimulator into your home user directory. 
     23 
     24== Step 3: Build the FEPSimulator project == 
     25In your terminal, run: 
     26{{{ 
     27    $ cd FEPSimulator/ && make 
     28}}} 
     29 
     30== Step 4: run the ./runFEPSim bash script == 
     31To start the FEPSimulator, you will need to run the ./runFEPSim bash script, located in the FEPSimulator/ repository. \\ 
     32 
     33In your terminal, run: \\ 
     34{{{ 
     35    $ ./runFEPSim 
     36}}} 
     37 
     38== Thats it! == 
     39 
     40 
     41== Note to Developers == 
     42If you are working on the FEPSimulator code, it is dependent on the tinyxml static library to parse the message sent from the ATMSDriver. \\ 
     43The library files are included in the repo @ FEPSimulator/tinyxml \\ 
     44The project is configured to link the linux static library file, a file named "tinyxml.a". (Because in production it runs on linux VM) \\ 
     45Also included in the tinyxml/ folder is a static library file for osx operating systems, a file named "libosxtinyxml.a" \\ 
     46If 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. \\ 
     47To 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. \\