Changes between Version 3 and Version 4 of FEPSimulatorInstallation

Timestamp:

02/11/2019 01:32:16 PM (7 years ago)

Author:

jdalbey

Comment:

Add section for running locally.

FEPSimulatorInstallation

@@ -1 +1 @@
 = 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).
+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: \\ 
+In a terminal, run: \\
+
 {{{
     $ ssh <username>@192.168.251.46
-}}} 
+}}}
 \\ to ssh into the linux VM.
 
@@ -16 +14 @@
 
 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 and run the FEPSimulator project ==
 In your terminal, run:
+
 {{{
     $ cd FEPSimulator/ && ./buildLinuxVM && ./runFEPSim
 }}}
+Observe the status message "Running FEP Simulator ..."
 
-== Thats it! ==
-
+As the simulation runs, highway network info will be made available to the FEP Sim and diagnostic messages will stream across the console.
 
 == Note to Developers ==
  * The FEPSim project was configured as a NetBeans project
  * Be sure to install the C++ plugin to !NetBeans in order to open the FEPSimulator Project.
+
+----
+= Running FEP Sim on your workstation (or laptop) =
+1. Check out the TMC project from the SVN repository.
+
+2. Open a terminal window in `branch/FEPSimulator`.
+
+3. In your terminal, run:
+
+{{{
+./runFEPSim
+}}}
+
+Observe the status message "Running FEP Simulator ..."