- Ajouté 2 HOWTO (pour test et run) à la racine du projet

Etienne Pallier
1 parent 6dc593da
Showing 3 changed files with 64 additions and 7 deletions Show diff stats
HOWTO_RUN.txt
HOWTO_TEST.txt
README.md
@@ -0,0 +1,42 @@
+
+
+*******************************
+ Here is how you can RUN pyros 
+*******************************
+
+-------------------------------------------
+(A) Command-line running (no web interface):
+-------------------------------------------
+
+(1) Running pyros interactively:
+$  [python] ./pyros.py shell
+
+(2) Launching an agent:
+$  [python] ./pyros.py start <agent-name>
+=> Ex: to start the env-monitoring agent:
+$  [python] ./pyros.py start monitoring
+=> Ex: to start agentA:
+$ [python] ./pyros.py start agentA
+
+(3) Launching many agents:
+$ [python] ./pyros.py start <agent1-name>,<agent2-name>,.
+=> Ex: start agentA and agentB
+$ [python] ./pyros.py start agentA,agentB
+=> You could also start ALL agents at once:
+$ [python] ./pyros.py start all
+
+
+-------------------------------------------
+(B) Running with the website
+-------------------------------------------
+
+(1) Start only the webserver (for pyros website)
+$ [python] ./pyros.py start webserver
+Then, connect to http://localhost:8000
+You can also connect to the admin interface: http://localhost:8000/admin
+(Login as 'pyros' with the password 'DjangoPyros')
+
+(2) Now, you can start some (or all) agents to have the website come to life !
+See section (A) just above
+
+ 
 \ No newline at end of file
@@ -0,0 +1,19 @@
+
+*************************************************************************************
+ Here is how you can TEST that pyros is working well (ensure that nothing is broken)
+*************************************************************************************
+
+(A) Running the unit tests suite:
+- (1) Some unit tests only:
+./pyros.py test
+- (2) All unit tests:
+./pyros.py testall
+
+(B) Test with agents:
+- (1) Test with agentA and agentB sending commands to each other:
+./pyros.py -t start agentA,agentB
+- (2) Test with agentTelescopeRequester sending commands to agentDevice:
+./pyros.py -t start agentTelescopeRequester,agentDevice
+
+(C) Interactive testing:
+./pyros.py shell
@@ -67,18 +67,14 @@ This software has been tested and validated with the following configurations :
 --------------------------------------------------------------------------------------------
 ## LAST VERSION
-Date: 17/06/2019
+Date: 18/06/2019
 Author: E. Pallier (epallier@irap.omp.eu)
-VERSION: 0.30.9
+VERSION: 0.30.10
 Comment : 
-- Restructuration du projet - phase 5b : /src/devices_controller/ => réorganisation interne 2/2 :
-		- create folder devices_controller/devices_controller_concrete/
-		- migrer le dossier devices_controller/server/ => devices_controller/devices_controller_concrete/server/
-		- rename server/ => device_simulator_common/
-- Deplacement de tous les devices concrets dans leurs dossiers respectifs (Gemini, AK, ...)
+- Ajouté 2 HOWTO (pour test et run) à la racine du projet
 	RAPPELS SUR L'UTILISATION :