init

help.md

@@ -0,0 +1,148 @@
+
+
+  
+****SWMU arguments (when entering the command runswmu -h):****
+  
+**mandatory arguments:**  
+ -- UNITS                 unit amount  
+  --mode MODE           mode run | sim | simfast
+  
+**optional arguments for "run" mode:**  
+*--latitude LATITUDE*   
+latitude (default 47.687622035085916)  
+  
+*--longitude LONGITUDE*  
+longitude (default 17.744894027593666)  
+
+*--domain DOMAIN*       
+current domain (default HU00)  
+
+*--near_by_domain NEAR_BY_DOMAIN*  
+near by domain (default HU00)  
+
+  *--x01 GENERATE_X01*    
+  generate x01 (default True)  
+  
+  *--x01-pause X01_PAUSE*  
+x01 pause in seconds (default 5sec)  
+
+  *--units-wo-x1a UNITS_WO_X1A*  
+amount of units that will not generate x1a (default 0)  
+
+  *--x1a-pause X1A_PAUSE*  
+x1a pause in seconds (default 10sec)  
+
+  *--x1a-mask X1A_MASK*   
+  x1a mask-type of log:
+ - 01 - without Regain signal flag;
+ - 17 - with Regain signal flag (default);
+  
+  *--x1a-type X1A_TYPE*   
+  x1a type of log (number of positions): 
+  - 0 - (default); 
+  - 1 - 17pos; 
+  - 2 - 33pos;
+  
+  *--x1d GENERATE_X1D*    
+  generate x1d (default True)  
+  
+  *--x1d-pause X1D_PAUSE*  
+x1d pause in seconds (default 60sec)  
+
+  *--x1d-weight_axles X1D_WEIGHT_AXLES*  
+x1d weight + number of axles:
+- 'auto' - generate 2-10 (default); 
+- '42' - set weight 4, axle 2; 
+- '76' - set weight 7, axle 6;  
+- '22' - set weight 2, axle 2;  
+- ..
+  
+**optional arguments for "sim" and "simfast" mode:**  
+  --log IMPORT_DIR
+  path to simulated log (obligatory with "sim" mode)  
+  
+  --simulate_pause SIMULATE_PAUSE
+  used for mode "simfast" to set delay between each message in seconds (default 2)  
+  
+**shared arguments:**  
+  *-h, --help*            
+  show this help message and exit
+  
+*--server-host SERVER_HOST*  
+server host (default localhost)  
+
+*--server-port SERVER_PORT*  
+server port (default 31001)  
+
+*--start-id32 START_ID32*  
+start id32 (default 3567779840)
+
+*--start-port START_PORT*  
+start port (default 1024)  
+
+*--bt-spontaneous-timeout BT_SPONTANEOUS_TIMEOUT*  
+BT spontaneous timeout in seconds (default 20)  
+
+*--sigma SIGMA*        
+sigma in seconds (default 0.2)  
+
+*--sta SEND_STA* 
+send sta (default True)  
+
+*--sta-pause STA_PAUSE*  
+STA pause in seconds (default 30sec)
+
+****SWMU examples:****
+  
+Example for 5 Software Mobile Units and server host `localhost`:  
+```bash
+$ runswmu 5 --mode run  
+```
+```bash
+$ runswmu 5 --mode sim --log ./test_log.log  
+```
+```bash
+$ runswmu 5 --mode simfast --log ./test_log.log --simulate_pause 0.25  
+  ```
+**Other examples**:  
+```bash
+$ runswmu 1 --mode run --server-host localhost --start-id32 3567779841  
+```
+```bash
+$ runswmu 1 --mode sim --server-host localhost --start-id32 3567779841 --log ./test_log.log  
+```
+```bash
+$ runswmu 1 --mode run --server-host 10.48.172.135 --start-id32 3567779841 --bt-spontaneous-timeout 5  --simulate_pause 0.25  
+```
+```bash
+$ LOG_LEVEL="INFO" runswmu 5 --mode sim --server-host localhost --start-id32 3567779871 --bt-spontaneous-timeout 5  --simulate_pause 0.25 --log ./test_log.log
+```  
+```bash
+$ LOG_LEVEL="INFO" runswmu 2500 --mode run --server-host 10.48.172.135 --bt-spontaneous-timeout 20 --sigma 3 --sta True --sta-pause 60 --x01-pause 11 --x1d-pause 250 --x1a-pause 18 --x1a-type 1 --domain DE00 --near_by_domain CZ00 --start-id32 3567779841
+```  
+```bash
+$ runswmu 1 --mode run --server-host 10.48.172.135 --start-id32 3567779841 --bt-spontaneous-timeout 5  --simulate_pause 0.25  
+```
+```bash
+$ runswmu 50 --mode simfast --server-host localhost --start-id32 3567779841 --log ./test_log.log --simulate_pause 0.25  
+```
+  
+**how to create pod (k8s):**  
+```bash
+$ kubectl [-n namespace] run [name_of_pod] --rm -i --tty --image [name_of_image] -- /bin/bash  
+```
+```bash
+$ kubectl -n uhura-azure-wagexp run swmu --namespace=uhura-azure-wagexp --image=python --requests=cpu=100m,memory=512Mi --limits=cpu=200m,memory=2048Mi --rm -i --tty -- /bin/bash  
+```
+
+```bash
+$ kubectl -n uhura-azure-wagexp run swmu --rm -i --tty --image python -- /bin/bash  
+  ```
+  
+**how to add mulog_file to k8s pod**:  
+```bash
+$ kubectl [-n namespace] cp [path to mulog file] [pod_name]:/  
+```
+```bash
+$ kubectl -n uhura-azure-wagexp cp /home/directory/test_log.log swmu:/  
+```