Merge pull request #2 from zajer/v1.0.0

V1.0.0

Author: zajer

.gitignore

@@ -9,6 +9,9 @@
 *.cmxa
 *.opam
 
+# Ignoring the results produced by scripts in the example directory
+exmp_*
+
 # ocamlbuild working directory
 _build/
 

README.md

@@ -1 +1,11 @@
-# trs-ssp-bridge
+# SSP-Bridge
+
+A library with facade executables to convert an output from Tracking_bigraph.
+
+It can normalize a TTS system and transform it into a state space accpeted by SSP library. Tools provided by this package are also capable of dynamically generating simple programs for generating behavior policies using SSP library.
+
+## Usage
+
+Having exported results from `Tracking_bigraph` library, use either all of the executables from the ``bin`` folder except the `all_in_one.exe` (as it was shown in ``/examples/ex1`` folder) or just the `all_in_one.exe` (as in ``/examples/ex2``).
+
+The first method allows for easier debugging if anything goes wrong (by saving all partial results and knowing exactly at which step an error has happened). The second method is faster (it does keep all of the partial results in memory and does certain operations only once since it can keep results until the very end) but more error-prone.

bin/all_in_one.ml

@@ -0,0 +1,44 @@
+open Ssp_bridge
+let help () = 
+  print_endline 
+  "
+  This program transforms an output of Tracking_bigraph library into a program generating behavior policy as a walk in the state space constructed from that output.
+  
+  If you see this message it means that you did not provide necessary number of arguments.
+  Arguments required for this program are:
+  Arg1 - the name of a file containing discovered states (generated by Trackign_bigraph library).
+  Arg2 - the name of a file with transitions (generated by Trackign_bigraph library).
+  Arg3 - a csv file containing patterns to be found among states (created manually).
+  Arg4 - the number of agents in the modelled system.
+  Arg5 - the name of a file with reaction rules associated with time they require (created manually).
+  Arg6 - the name of a file with control types of agents (created manually).
+  Arg7 - the name of the file with states with detected patterns (output of this program).
+  Arg8 - the name of the file with transition functions (output of this program).
+  Arg9 - the name of the source code file (output of this program).
+  Arg10 - (optional) the name of a file with template of the source code, if not provided the default file is \"ssp_template.txt\".
+  "
+let () =
+  if Array.length Sys.argv >= 10 then
+    let states_file = Sys.argv.(1)
+    and trans_file = Sys.argv.(2)
+    and patterns_file = Sys.argv.(3)
+    and noa = Sys.argv.(4) |> int_of_string
+    and trans2timeshift_file = Sys.argv.(5)
+    and ctrls_file = Sys.argv.(6)
+    and out_dest_states_file = Sys.argv.(7)
+    and out_ssp_input_file = Sys.argv.(8)
+    and out_ssp_source_code_file = Sys.argv.(9)
+    and template_file = if Array.length Sys.argv = 11 then Sys.argv.(10) else "ssp_template.txt" in
+    Facade.all_in_one 
+      ~in_states_file:states_file
+      ~in_patterns_file:patterns_file
+      ~in_trans_file:trans_file
+      ~in_react_times_file:trans2timeshift_file
+      ~in_ctrls_file:ctrls_file
+      ~number_of_agents:noa
+      ~in_template_file:template_file
+      ~out_dest_states_file
+      ~out_ssp_input_file 
+      ~out_ssp_source_code_file 
+  else
+    help ()

bin/dune

@@ -1,6 +1,6 @@
 
 (executables
-  (names transform_multi_files transform_single_file find_dest_states ) 
-  (libraries trs_bridge )
+  (names normalize_tts transform_normed_tts gen_ssp_source find_dest_states all_in_one) 
+  (libraries ssp_bridge )
   (modes native )
 ) 

bin/find_dest_states.ml

@@ -1,4 +1,4 @@
-open Trs_bridge
+open Ssp_bridge
 
 let help () = 
   print_endline 

bin/gen_ssp_source.ml

@@ -0,0 +1,21 @@
+let help () = 
+  print_endline 
+  "
+  This program generates a source code for generating a walk from an initial state to a desired state.
+  
+  If you see this message it means that you did not provide necessary number of arguments.
+  Arguments required for this program are:
+  Arg1 - the name of a file containing discovered states (generated by Trackign_bigraph library).
+  Arg2 - a number of agents in the system.
+  Arg3 - the name of the source code file (output of this program).
+  Arg4 - (optional) the name of a file with template of the source code.
+  "
+  let () = 
+    if Array.length Sys.argv >= 4 then
+    let states_file = Sys.argv.(1)
+    and noa = Sys.argv.(2) |> int_of_string
+    and output_file = Sys.argv.(3) 
+    and template_file = if Array.length Sys.argv = 5 then Sys.argv.(4) else "ssp_template.txt" in
+        Ssp_bridge.Facade.gen_ssp_source ~states_file ~template_file ~source_file:output_file noa
+    else
+        help ()

bin/main.ml

@@ -0,0 +1,21 @@
+let help () = 
+  print_endline 
+  "
+  This program normalizes an output of Tracking_bigraph library.
+  Normalization unifies the output state of a transition with it's correspinding state in discovered states.
+  They are not only isomorphic to each other, they are identical.
+  
+  If you see this message it means that you did not provide necessary number of arguments.
+  Arguments required for this program are:
+  Arg1 - the name of a file containing discovered states (generated by Trackign_bigraph library).
+  Arg2 - the name of a file with transitions (generated by Trackign_bigraph library).
+  Arg3 - the name of the normalized transitions file (output of this program).
+  "
+  let () = 
+    if Array.length Sys.argv = 4 then
+    let states_file = Sys.argv.(1)
+    and trans_file = Sys.argv.(2)
+    and output_file = Sys.argv.(3) in
+        Ssp_bridge.Facade.normalize_tts ~states_file ~trans_file ~norm_trans_file:output_file
+    else
+        help ()

bin/main2.ml

@@ -0,0 +1,25 @@
+open Ssp_bridge
+
+let help () = 
+  print_endline 
+  "
+  This program transforms a normalized result of Tracking_bigraph library into an input for SSP library.
+  
+  If you see this message it means that you did not provide necessary number of arguments.
+  Arguments required for this program are:
+  Arg1 - the name of a file containing discovered states (generated by Trackign_bigraph library).
+  Arg2 - the name of a file with normalized transitions (generated by this library).
+  Arg3 - the name of a file with reaction rules associated with time they require (created manually).
+  Arg4 - the name of a file with control types of agents (created manually).
+  Arg5 - the name of the file with transition functions (output of this program).
+  "
+let () = 
+  if Array.length Sys.argv = 6 then
+  let states_file = Sys.argv.(1)
+  and norm_trans_file = Sys.argv.(2)
+  and trans2timeshift_file = Sys.argv.(3)
+  and ctrls_file = Sys.argv.(4)
+  and output = Sys.argv.(5) in
+        Facade.transform_tts ~states_file ~norm_trans_file ~react_times_file:trans2timeshift_file ~ctrls_file ~ss_file:output
+  else
+    help ()