Merge pull request #210 from olakiril/master

iuml files

Author: olakiril

README.md

@@ -97,6 +97,7 @@ or can specify a task_idx to run directly. After it completes, the process ends.
 sudo python3 run.py 1 
 ```
 
+
 This process can be automated by either a bash script that runs on startup or through control from a salt server. 
 
 ## INSTALLATION INSTRUCTIONS (for Raspberry pi)
@@ -124,7 +125,7 @@ Install salt for remote control, you need to have a salt-master server! - Option
 ```bash
 sudo apt install salt-minion
 echo 'master: <<YOUR_SALT-MASTER_IP>>' | sudo tee -a /etc/salt/minion
-echo 'id: HOSTNAME' | sudo tee -a /etc/salt/minion
+echo 'id: <<HOSTNAME>>' | sudo tee -a /etc/salt/minion
 sudo service salt-minion restart
 ```
 

utils/plantuml diagrams renamed to utils/modules.iuml

@@ -1,4 +1,4 @@
-```puml
+@startuml
 skinparam rectangleRoundCorner 10
 rectangle Experiment #lightgreen
 rectangle Stimulus #lightgreen
@@ -18,19 +18,7 @@ Logger <.right.> Interface
 note right of Experiment : <size:10>Main state experiment</size>
 note right of Behavior : <size:10>Handles the animal behavior</size> \n <size:10>in the experiment</size>
 note left of Stimulus : <size:10>Handles the stimuli</size> \n <size:10>used in the experiment</size>
-note right of Logger : <size:10>Handles all database</size> \n <size:10>interactions</size>
+note left of Logger : <size:10>Handles all database</size> \n <size:10>interactions</size>
 note left of Interface : <size:10>Handles all communication</size> \n <size:10>with hardware</size>
-```
-
-```puml
-(Entry) --> (PreTrial)
-(PreTrial) --> (Trial)
-(Trial) --> (Abort)
-(Trial) --> (Reward)
-(Trial) --> (Punish)
-(Trial) --> (Trial)
-(Abort) --> (InterTrial)
-(Reward) --> (InterTrial)
-(Punish) --> (InterTrial)
-(InterTrial)-->(Exit)
-```
+note left of database : <size:10>lab_experiments</size> \n<size:10>lab_behavior</size> \n<size:10>lab_stimuli</size>
+@enduml

utils/states.iuml

@@ -0,0 +1,12 @@
+@startuml
+(Entry) --> (PreTrial)
+(PreTrial) --> (Trial)
+(Trial) --> (Abort)
+(Trial) --> (Reward)
+(Trial) --> (Punish)
+(Trial) --> (Trial)
+(Abort) --> (InterTrial)
+(Reward) --> (InterTrial)
+(Punish) --> (InterTrial)
+(InterTrial)-->(Exit)
+@enduml