Browse Source

updated readme

Simon Van Mierlo 7 years ago
parent
commit
bde869774b
1 changed files with 14 additions and 6 deletions
  1. 14 6
      README.md

+ 14 - 6
README.md

@@ -1,8 +1,11 @@
 Usage
-* Server:
+* Installation (NetLogo):
+    * install the custom NetLogo reflection extension found in `debugging_environment/NetLogo/Reflection-Extension`
+* Run Server:
     * inside debugging_environment: `node debugging_server.js`
-* Client:
-    * inside debugging_environment: `python simulation_client.py`
+* Run Client:
+    * (for DSDEVS debugger) inside debugging_environment: `python simulation_client.py`
+    * (for NetLogo debugger) inside debugging_environment: `python simulation_client_netlogo.py`
 * Interface:
     * go to [localhost:9595] (http://localhost:9595) for the debugging interface
         * Operations (Toolbar):
@@ -42,17 +45,22 @@ Usage
                 * Hovering over an instance will display its current state.
                 * Hovering over a port of an instance shows its name and connections.
             * The simulation time is displayed, as well as the phase (in case multiple transitions are executed on the same simulated time instance).
-    * go to [localhost:9696] (http://localhost:9696) for the visualization
+    * go to [localhost:9696] (http://localhost:9696) for the (DSDEVS) visualization (for NetLogo, running the simulation client will start the NetLogo visualization)
         * Left-clicking a particle sends a realtime interrupt to the simulation (which selects that particle).
         * Pressing the delete button sends a realtime interrupt to the simulation (deleting all selected particles).
         * Right-clicking a particle will display the state of that particle in the debugging interface.
 
 Models and Source Files
-* User Model: `particle_interaction.py`
+* User Model:
+    * `particle_interaction.py` (for DSDEVS)
+    * `debugging_environment/NetLogo/BouncingBalls.nlogo` (for NetLOgo)
 * User Visualization:
     * Statechart model: `javascript_models/particle_interaction_vis_js_instrumented.xml`
     * Webpage: `visualization_server.html`
-* Simulator:
+* Simulator (DSDEVS):
     * Statechart model: `debugging_environment/pypdevs/sccd.xml`
     * Simulation client: `debugging_environment/simulation_client.py`
+* Simulator (NetLogo):
+    * Statechart model: `debugging_environment/NetLogo/simulator.xml`
+    * Simulation client: `debugging_environment/simulation_client_netlogo.py`
 * Communication Layer: `debugging_server.js`